diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 31 |
1 files changed, 31 insertions, 0 deletions
@@ -2,6 +2,37 @@ Generic task queue server with scripts for downloading with different tools. +## Usage + +First start the queue daemon process. It will save its state to JSON files in +its working directory. As its first argument supply the global configuration +file. + +``` +cargo run -- config.yaml +``` + +The configuration file contains two keys read be the daemon `bind_port` and +`bind_addr`. All other options are passed as-is to the workers. + +Then you can start workers linked to the queue server. Most workers take the URI +to the worker websocket endpoint of the queue server as their first argument. + +``` +deno run -A scripts/<name>.ts ws://127.0.0.1:44794/worker_ws +``` + +Each workers usage and configuration is documented in the markdown file next to +the script. These are also linked below. + +## Worker Scripts + +- [enqueuer](./scripts/enqueue.md) +- [yt-dlp media downloader](./scripts/ytdlp_download.md) +- [yt-dlp playlist flattener](./scripts/ytdlp_flatten.md) +- [yt-dlp channel info generator](./scripts/ytdlp_channel_info.md) +- [complete tasks based on existing files](./scripts/complete_from_files.md) + ## License AGPL-3.0-only; See [COPYING](./COPYING). |