mirror of
https://github.com/marcopiovanello/yt-dlp-web-ui.git
synced 2026-02-03 18:11:14 -06:00
Copilot is thinking...
Do we really need an AI to generate a commit description??
This commit is contained in:
Marco Piovanello
GitHub
parent
8c06485880
commit
e0ebe9a995
315
README.md
315
README.md
@ -1,312 +1,17 @@
|
||||
> [!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
|
||||
## I'm migrating away from GitHub
|
||||
|
||||
# yt-dlp Web UI
|
||||
This project is not, and will not, use AI generated code or any AI "powered" tool.
|
||||
Fuck copilot, fuck openAI and fuck all the corporate greed shit that is stripping off our privacy, making our life worse and destryoing the planet.
|
||||
|
||||
A not so terrible web ui for yt-dlp.
|
||||
GitHub (basically Microsoft) is training models with ass-level code, found in the majority of the public (and even) private repositories, to help us produce more ass-level code and making worse products.
|
||||
|
||||
High performance extendeable web ui and RPC server for yt-dlp with low impact on resources.
|
||||
Maybe the funny guy with aviator sunglasses was right.
|
||||
|
||||
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)**.
|
||||
### I'm still going to contribute in this project... but...
|
||||
|
||||
```sh
|
||||
docker pull marcobaobao/yt-dlp-webui
|
||||
```
|
||||
```sh
|
||||
# latest dev
|
||||
docker pull ghcr.io/marcopiovanello/yt-dlp-web-ui:latest
|
||||
```
|
||||
We can meet here: [https://gitea.aidystopia.xyz](https://gitea.aidystopia.xyz/marco/yt-dlp-webui). I'm migrating everything to my presonal gitea.
|
||||
See you there!
|
||||
|
||||
## 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> |
|
||||
|
||||
<sub>Generated by <a href="https://deploystack.io/c/marcopiovanello-yt-dlp-web-ui" target="_blank">DeployStack.io</a></sub>
|
||||
|
||||
## [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)
|
||||
Bye :)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user