From 8eebd424c8991922ce7d04b9f0501258fb5a93c4 Mon Sep 17 00:00:00 2001 From: Marco Piovanello <35533749+marcopeocchi@users.noreply.github.com> Date: Mon, 26 Aug 2024 15:34:31 +0200 Subject: [PATCH] Update README.md --- README.md | 41 ++++++++++------------------------------- 1 file changed, 10 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index b6f3362..e4f8d66 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,9 @@ docker pull marcobaobao/yt-dlp-webui docker pull ghcr.io/marcopeocchi/yt-dlp-web-ui:latest ``` +## Video showcase [app.webm](https://github.com/marcopeocchi/yt-dlp-web-ui/assets/35533749/91545bc4-233d-4dde-8504-27422cb26964) - -![image](https://github.com/marcopeocchi/yt-dlp-web-ui/assets/35533749/a32fbdaa-b033-4aed-b914-a66701ace0ce) -![image](https://github.com/marcopeocchi/yt-dlp-web-ui/assets/35533749/782c559a-f552-40be-a6fd-10e22f38e85d) - -### Integrated File browser -Stream or download your content, easily. - -![](https://i.ibb.co/k0qzLds/image.png) - ## Settings The currently avaible settings are: @@ -37,23 +29,13 @@ The currently avaible settings are: - Pass custom yt-dlp arguments safely - Download queue (limit concurrent downloads) -![](https://i.ibb.co/YdBVcgc/image.png) -![](https://i.ibb.co/Sf102b1/image.png) - ## 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! -## Troubleshooting -- **It says that it isn't connected/ip in the header is not defined.** - - You must set the server ip address in the settings section (gear icon). -- **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) - -## [Docker](https://github.com/marcopeocchi/yt-dlp-web-ui/pkgs/container/yt-dlp-web-ui) installation -## Docker run +## [Docker](https://github.com/marcopeocchi/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 :/downloads marcobaobao/yt-dlp-webui @@ -143,7 +125,7 @@ Usage yt-dlp-webui: -port int Port where server will listen at (default 3033) -qs int - Download queue size (default 8) + Download queue size (defaults to the number of logical CPU. A min of 2 is recomended.) -user string Username required for auth -pass string @@ -153,6 +135,7 @@ Usage yt-dlp-webui: ### 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 @@ -250,17 +233,13 @@ 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. -Just as an overview, these are the available methods: -- Service.Exec -- Service.Progress -- Service.Formats -- Service.Pending -- Service.Running -- Service.Kill -- Service.KillAll -- Service.Clear - For more information open an issue on GitHub and I will provide more info ASAP. ## 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/ip in the header is not defined.** + - You must set the server ip address in the settings section (gear icon). +- **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)