10 feat download queue (#59)
* testing message queue * better mq syncronisation * major code refactoring, concern separation. * bugfix * code refactoring * queuesize configurable via flags * code refactoring * comments * code refactoring, updated readme
This commit is contained in:
36
README.md
36
README.md
@@ -68,6 +68,7 @@ The currently avaible settings are:
|
||||
- Override the output filename
|
||||
- Override the output path
|
||||
- Pass custom yt-dlp arguments safely
|
||||
- Download queue (limit concurrent downloads)
|
||||
|
||||

|
||||

|
||||
@@ -84,8 +85,9 @@ Future releases will have:
|
||||
- ~~Multi download~~ *done*
|
||||
- ~~Exctract audio~~ *done*
|
||||
- ~~Format selection~~ *done*
|
||||
- Download archive
|
||||
- ~~Download archive~~ *done*
|
||||
- ~~ARM Build~~ *done available through ghcr.io*
|
||||
- Playlist support
|
||||
|
||||
## Troubleshooting
|
||||
- **It says that it isn't connected/ip in the header is not defined.**
|
||||
@@ -118,6 +120,18 @@ docker run -d \
|
||||
--secret your_rpc_secret
|
||||
```
|
||||
|
||||
If you wish for limiting the download queue size...
|
||||
|
||||
e.g. limiting max 2 concurrent download.
|
||||
```sh
|
||||
docker run -d \
|
||||
-p 3033:3033 \
|
||||
-e JWT_SECRET randomsecret
|
||||
-v /path/to/downloads:/downloads \
|
||||
marcobaobao/yt-dlp-webui \
|
||||
--qs 2
|
||||
```
|
||||
|
||||
## [Prebuilt binaries](https://github.com/marcopeocchi/yt-dlp-web-ui/releases) installation
|
||||
|
||||
```sh
|
||||
@@ -134,6 +148,25 @@ yt-dlp-webui --out /home/user/downloads --driver /opt/soemdir/yt-dlp
|
||||
yt-dlp-webui --conf /home/user/.config/yt-dlp-webui.conf
|
||||
```
|
||||
|
||||
### Arguments
|
||||
```sh
|
||||
Usage yt-dlp-webui:
|
||||
-auth
|
||||
Enable RPC authentication
|
||||
-conf string
|
||||
Config file path
|
||||
-driver string
|
||||
yt-dlp executable path (default "yt-dlp")
|
||||
-out string
|
||||
Where files will be saved (default ".")
|
||||
-port int
|
||||
Port where server will listen at (default 3033)
|
||||
-qs int
|
||||
Download queue size (default 8)
|
||||
-secret string
|
||||
Secret required for auth
|
||||
```
|
||||
|
||||
### Config file
|
||||
By running `yt-dlp-webui` in standalone mode you have the ability to also specify a config file.
|
||||
The config file **will overwrite what have been passed as cli argument**.
|
||||
@@ -149,6 +182,7 @@ downloaderPath: /usr/local/bin/yt-dlp
|
||||
# Optional settings
|
||||
require_auth: true
|
||||
rpc_secret: my_random_secret
|
||||
queue_size: 4
|
||||
```
|
||||
|
||||
### Systemd integration
|
||||
|
||||
Reference in New Issue
Block a user