Go to file

Administrator 84dcf5a95f Update Dockerfile		2023-10-06 20:35:55 +00:00
.conf.json.example	First commit	2023-10-03 22:31:24 -05:00
.gitignore	First commit	2023-10-03 22:31:24 -05:00
Dockerfile	Update Dockerfile	2023-10-06 20:35:55 +00:00
README.md	Add logo	2023-10-04 15:33:58 -05:00
docker-compose.yml	Update docker-compose.yml	2023-10-06 20:33:52 +00:00
requirements.txt	First commit	2023-10-03 22:31:24 -05:00
run.py	First commit	2023-10-03 22:31:24 -05:00
start-docker.sh	First commit	2023-10-03 22:31:24 -05:00
start-podman.sh	First commit	2023-10-03 22:31:24 -05:00
start.sh	First commit	2023-10-03 22:31:24 -05:00

yt-dlp-web-api

This is a socketio based web api for using yt-dlp. The ultimate goal of this library is to provide simple access to yt-dlp's functionality in order to create downloader websites

Requirements:

Either python3 installed locally or docker/podman with compose

First clone this repo

Next, copy .conf.json.example to .conf.json and modify the paremeters to your liking

Parameters:

maxLength: maximum length of videos allowed to download in seconds

maxPlaylistLength: maximum number of videos allowed on playlist to download

maxGifLength: maximum length of gifs in seconds

maxGifResolution: maximum resolution of gifs in pixels

maxLengthPlaylistVideo: maximum length of individual videos on playlists

proxyListURL: url to download proxies from, if not leave as false

url: base url of server

bugcatcher: whether to use a bug catching service

bugcatcherdsn: dsn of bug catching service

allowedorigins: allowed urls of clients

Python:

run:

pip3 install -r requirement.txt

pip3 install --upgrade sentry-sdk

bash start.sh

make a downloads folder in the yt-dlp-web directory

python3 run.py

Docker/podman compose:

run:

bash start-docker.sh

bash start-podman.sh

depending on whether you have docker compose or podman compose installed

For more details please read the inline comments

Coming soon:

Multi-node functionality