base on A terrible web ui and RPC server for yt-dlp. Designed to be self-hosted. > [!NOTE] > A poll is up to decide the future of yt-dlp-web-ui frontend! If you're interested you can take part. > https://github.com/marcopiovanello/yt-dlp-web-ui/discussions/223 # yt-dlp Web UI A not so terrible web ui for yt-dlp. High performance extendeable web ui and RPC server for yt-dlp with low impact on resources. Created for the only purpose of *fetching* videos from my server/nas and monitor upcoming livestreams. **Docker images are available on [Docker Hub](https://hub.docker.com/r/marcobaobao/yt-dlp-webui) or [ghcr.io](https://github.com/marcopiovanello/yt-dlp-web-ui/pkgs/container/yt-dlp-web-ui)**. ```sh docker pull marcobaobao/yt-dlp-webui ``` ```sh # latest dev docker pull ghcr.io/marcopiovanello/yt-dlp-web-ui:latest ``` ## Donate to yt-dlp-webui development [PayPal](https://paypal.me/marcofw) *Keeps the project alive!* 😃 ## Community stuff Feel free to join :) [Discord](https://discord.gg/GZAX5FfGzE) ## Some screeshots    ## Video showcase [app.webm](https://github.com/marcopiovanello/yt-dlp-web-ui/assets/35533749/91545bc4-233d-4dde-8504-27422cb26964) ## Settings The currently avaible settings are: - Server address - Switch theme - Extract audio - Switch language - Optional format selection - Override the output filename - Override the output path - Pass custom yt-dlp arguments safely - Download queue (limit concurrent downloads) ## Format selection This feature is disabled by default as this intended to be used to retrieve the best quality automatically. To enable it just go to the settings page and enable the **Enable video/audio formats selection** flag! ## [Docker](https://github.com/marcopiovanello/yt-dlp-web-ui/pkgs/container/yt-dlp-web-ui) run ```sh docker pull marcobaobao/yt-dlp-webui docker run -d -p 3033:3033 -v <your dir>:/downloads marcobaobao/yt-dlp-webui ``` Or with docker but building the container manually. ```sh docker build -t yt-dlp-webui . docker run -d -p 3033:3033 -v <your dir>:/downloads yt-dlp-webui docker run -d -p 3033:3033 \ -v <your dir>:/downloads \ -v <your dir>:/config \ # optional yt-dlp-webui ``` If you opt to add RPC authentication... ```sh docker run -d \ -p 3033:3033 \ -e JWT_SECRET randomsecret -v /path/to/downloads:/downloads \ -v /path/for/config:/config \ # optional marcobaobao/yt-dlp-webui \ --auth \ --user your_username \ --pass your_pass ``` 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 ``` ### Docker Compose ```yaml services: yt-dlp-webui: image: marcobaobao/yt-dlp-webui ports: - 3033:3033 volumes: - <your dir>:/downloads # replace <your dir> with a directory on your host system healthcheck: test: curl -f http://localhost:3033 || exit 1 restart: unless-stopped ``` ### ⚡ One-Click Deploy | Cloud Provider | Deploy Button | |----------------|---------------| | AWS | <a href="https://deploystack.io/deploy/marcopiovanello-yt-dlp-web-ui?provider=aws&language=cfn"><img src="https://raw.githubusercontent.com/deploystackio/deploy-templates/refs/heads/main/.assets/img/aws.svg" height="38"></a> | | DigitalOcean | <a href="https://deploystack.io/deploy/marcopiovanello-yt-dlp-web-ui?provider=do&language=dop"><img src="https://raw.githubusercontent.com/deploystackio/deploy-templates/refs/heads/main/.assets/img/do.svg" height="38"></a> | | Render | <a href="https://deploystack.io/deploy/marcopiovanello-yt-dlp-web-ui?provider=rnd&language=rnd"><img src="https://raw.githubusercontent.com/deploystackio/deploy-templates/refs/heads/main/.assets/img/rnd.svg" height="38"></a> | _{Generated by <a href="https://deploystack.io/c/marcopiovanello-yt-dlp-web-ui" target="_blank">DeployStack.io</a>} ## [Prebuilt binaries](https://github.com/marcopiovanello/yt-dlp-web-ui/releases) installation ```sh # download the latest release from the releases page mv yt-dlp-webui_linux-[your_system_arch] /usr/local/bin/yt-dlp-webui # /home/user/downloads as an example and yt-dlp in $PATH yt-dlp-webui --out /home/user/downloads # specifying yt-dlp path yt-dlp-webui --out /home/user/downloads --driver /opt/soemdir/yt-dlp # specifying using a config file 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 (default "./config.yml") -db string local database path (default "local.db") -driver string yt-dlp executable path (default "yt-dlp") -fl enable file based logging -host string Host where server will listen at (default "0.0.0.0") -lf string set log file location (default "yt-dlp-webui.log") -out string Where files will be saved (default ".") -pass string Password required for auth -port int Port where server will listen at (default 3033) -qs int Queue size (concurrent downloads) (default 2) -session string session file path (default ".") -user string Username required for auth -web string frontend web resources path ``` ### 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**. With Docker, inside the mounted `/conf` volume inside there must be a file named `config.yml`. ```yaml # Simple configuration file for yt-dlp webui --- # Host where server will listen at (default: "0.0.0.0") #host: 0.0.0.0 # Port where server will listen at (default: 3033) port: 8989 # Directory where downloaded files will be stored (default: ".") downloadPath: /home/ren/archive # [optional] Enable RPC authentication (requires username and password) require_auth: true username: my_username password: my_random_secret # [optional] The download queue size (default: logical cpu cores) queue_size: 4 # min. 2 # [optional] Full path to the yt-dlp (default: "yt-dlp") #downloaderPath: /usr/local/bin/yt-dlp # [optional] Enable file based logging with rotation (default: false) #enable_file_logging: false # [optional] Directory where the log file will be stored (default: ".") #log_path: . # [optional] Directory where the session database file will be stored (default: ".") #session_file_path: . # [optional] Path where the sqlite database will be created/opened (default: "./local.db") #local_database_path # [optional] Path where a custom frontend will be loaded (instead of the embedded one) #frontend_path: ./web/solid-frontend ``` ### Systemd integration By defining a service file in `/etc/systemd/system/yt-dlp-webui.service` yt-dlp webui can be launched as in background. ``` [Unit] Description=yt-dlp-webui service file After=network.target [Service] User=some_user ExecStart=/usr/local/bin/yt-dlp-webui --out /mnt/share/downloads --port 8100 [Install] WantedBy=multi-user.target ``` ```shell systemctl enable yt-dlp-webui systemctl start yt-dlp-webui ``` It could be that yt-dlp-webui works correctly when started manually from the console, but with systemd, it does not see the yt-dlp executable, or has issues writing to the database file. One way to fix these issues could be as follows: ```shell cd mkdir yt-dlp-webui-workingdir # optionally move the already existing database file there: mv local.db yt-dlp-webui-workingdir nano yt-dlp-webui-workingdir/my.conf ``` The config file format is described above; make sure to include the `downloaderPath` setting (the path can possibly be found by running `which yt-dlp`). For example, one could have: ``` downloadPath: /stuff/media downloaderPath: /home/your_user/.local/bin/yt-dlp log_path: /home/your_user/yt-dlp-webui-workingdir session_file_path: /home/your_user/yt-dlp-webui-workingdir ``` Adjust the Service section in the `/etc/systemd/system/yt-dlp-webui.service` file as follows: ``` [Service] User=your_user Group=your_user WorkingDirectory=/home/your_user/yt-dlp-webui-workingdir ExecStart=/usr/local/bin/yt-dlp-webui --conf /home/your_user/yt-dlp-webui-workingdir/my.conf ``` ## Manual installation ```sh # the dependencies are: yt-dlp, ffmpeg, nodejs, go, make. make all ``` ## Open-API Navigate to `/openapi` to see the related swagger. ## Extendable You dont'like the Material feel? Want to build your own frontend? We got you covered 🤠 `yt-dlp-webui` now exposes a nice **JSON-RPC 1.0** interface through Websockets and HTTP-POST It is **planned** to also expose a **gRPC** server. For more information open an issue on GitHub and I will provide more info ASAP. ## Custom frontend To load a custom frontend you need to specify its path either in the config file ([see config file](#config-file)) or via flags. The frontend needs to follow this structure: ``` path/to/my/frontend ├── assets │ ├── js-chunk-1.js (example) │ ├── js-chunk-2.js (example) │ ├── style.css (example) └── index.html ``` `assets` is where the resources will be loaded. `index.html` is the entrypoint. ## Nix This repo adds support for Nix(OS) in various ways through a `flake-parts` flake. For more info, please refer to the [official documentation](https://nixos.org/learn/). ## What yt-dlp-webui is not `yt-dlp-webui` isn't your ordinary website where to download stuff from the internet, so don't try asking for links of where this is hosted. It's a self hosted platform for a Linux NAS. ## Troubleshooting - **It says that it isn't connected.** - In some circumstances, you must set the server ip address or hostname in the settings section (gear icon). - **The download doesn't start.** - Simply, yt-dlp process takes a lot of time to fire up. (yt-dlp isn't fast especially if you have a lower-end/low-power NAS/server/desktop. Furthermore some yt-dlp builds are slower than others) ", Assign "at most 3 tags" to the expected json: {"id":"13174","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"