marco/yt-dlp-webui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Yun
2022-05-08 20:53:33 +02:00
committed by GitHub
parent 5aa6db73be
commit ff97f9fdfe
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -1,9 +1,20 @@
# yt-dlp Web UI # yt-dlp Web UI
A not so terrible web ui for yt-dlp. A not so terrible web ui for yt-dlp.
Created for the only purpose of *consuming* videos from my server/nas. Created for the only purpose of *fetching* videos from my server/nas.
Intended to be used with docker but standalone is fine too. 😎👍
Developed to be as lightweight as possible (because my server is basically an intel atom sbc).
The bottleneck remains yt-dlp startup time (until yt-dlp will provide a rpc interface).
I will eventually make this better as soon as I can. Not in the immediate. I will eventually make this better as soon as I can. Not in the immediate.
**Format selection is in progress**
---
Changelog: Changelog:
``` ```
05/03/22: Korean translation by kimpig 05/03/22: Korean translation by kimpig
@@ -51,24 +62,25 @@ Future releases will have:
## Troubleshooting ## Troubleshooting
- **It says that it isn't connected/ip in the footer is not defined.** - **It says that it isn't connected/ip in the footer is not defined.**
- You must set the server ip address in the settings section (gear icon). - You must set the server ip address in the settings section (gear icon).
- **The download doens't start.** - **The download doesn't start.**
- As before server address is not specified or simply yt-dlp process takes a lot of time to fire up. (Forking yt-dlp isn't fast especially if you have a lower-end/low-power NAS/server/desktop where the server is running) - As before server address is not specified or simply yt-dlp process takes a lot of time to fire up. (Forking yt-dlp isn't fast especially if you have a lower-end/low-power NAS/server/desktop where the server is running)
- **Background jobs are not retrieved.** - **Background jobs are not retrieved.**
- As before forking yt-dlp isn't fast so resuming _n_ background jobs takes _n_*_time to exec yt-dlp_ Just have patience. - As before forking yt-dlp isn't fast so resuming _n_ background jobs takes _n_*_time to exec yt-dlp_ Just have patience.
## Docker installation ## Docker installation
``` ```shell
docker pull marcobaobao/yt-dlp-webui:latest docker pull marcobaobao/yt-dlp-webui:latest
# or alternatively docker pull ghcr.io/marcobaobao/yt-dlp-web-ui:master
docker run -d -p 3022:3022 -v <your dir>:/usr/src/yt-dlp-webui/downloads marcobaobao/yt-dlp-webui docker run -d -p 3022:3022 -v <your dir>:/usr/src/yt-dlp-webui/downloads marcobaobao/yt-dlp-webui
``` ```
or or
``` ```shell
docker build -t yt-dlp-webui . docker build -t yt-dlp-webui .
docker run -d -p 3022:3022 -v <your dir>:/usr/src/yt-dlp-webui/downloads yt-dlp-webui docker run -d -p 3022:3022 -v <your dir>:/usr/src/yt-dlp-webui/downloads yt-dlp-webui
``` ```
## Manual installation ## Manual installation
``` ```shell
# the dependencies are: python3, ffmpeg, nodejs, psmisc. # the dependencies are: python3, ffmpeg, nodejs, psmisc.
npm i npm i
@@ -91,8 +103,8 @@ node dist/main.js
- Originally it was 1.8GB circa, now it has been slimmed to ~340MB compressed. This is due to the fact that it encapsule a basic Alpine linux image + FFmpeg + Node.js + Python3 + yt-dlp. - Originally it was 1.8GB circa, now it has been slimmed to ~340MB compressed. This is due to the fact that it encapsule a basic Alpine linux image + FFmpeg + Node.js + Python3 + yt-dlp.
- **Am I forced to run it on port 3022?** - **Am I forced to run it on port 3022?**
- Well, yes (until now). - Well, yes (until now).
- **Why is it so slow to start a download** - **Why is it so slow to start a download?**
- I genuinely don't know. I know that yt-dlp is slow starting up even on my M1 Mac, so.... - I genuinely don't know. I know that standalone yt-dlp is slow to start up even on my M1 Mac, so....
## Todo list ## Todo list
- ~~retrieve background tasks~~ - ~~retrieve background tasks~~