carch-web-api/README.md

# yt-dlp-web-api

## This is a socketio based web api for using [yt-dlp](https://github.com/yt-dlp/yt-dlp). The ultimate goal of this library is to provide simple access to yt-dlp's functionality in order to create downloader websites

### See also: [https://gitlab.com/wizdevgirl1/yt-dlp-web-ui](https://gitlab.com/wizdevgirl1/yt-dlp-web-ui) for a premade front end

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`

or 

`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
Update README.md 2023-10-04 13:46:38 +00:00			`# yt-dlp-web-api`

			`## This is a socketio based web api for using [yt-dlp](https://github.com/yt-dlp/yt-dlp). The ultimate goal of this library is to provide simple access to yt-dlp's functionality in order to create downloader websites`

			`### See also: [https://gitlab.com/wizdevgirl1/yt-dlp-web-ui](https://gitlab.com/wizdevgirl1/yt-dlp-web-ui) for a premade front end`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`Requirements:`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`Either python3 installed locally or docker/podman with compose`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`First clone this repo`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`Next, copy .conf.json.example to .conf.json and modify the paremeters to your liking`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`Parameters:`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`maxLength: maximum length of videos allowed to download in seconds`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`maxPlaylistLength: maximum number of videos allowed on playlist to download`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`maxGifLength: maximum length of gifs in seconds`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`maxGifResolution: maximum resolution of gifs in pixels`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`maxLengthPlaylistVideo: maximum length of individual videos on playlists`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`proxyListURL: url to download proxies from, if not leave as false`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`url: base url of server`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`bugcatcher: whether to use a bug catching service`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`bugcatcherdsn: dsn of bug catching service`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`allowedorigins: allowed urls of clients`
Initial commit 2023-08-16 16:33:37 +00:00

First commit 2023-10-04 03:31:24 +00:00			`Python:`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`run:`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`pip3 install -r requirement.txt`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`pip3 install --upgrade sentry-sdk`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`bash start.sh`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`/`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`make a downloads folder in the yt-dlp-web directory`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`python3 run.py`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`Docker/podman compose:`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`run:`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`bash start-docker.sh`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`or`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`bash start-podman.sh`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`depending on whether you have docker compose or podman compose installed`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`For more details please read the inline comments`
Initial commit 2023-08-16 16:33:37 +00:00
First commit 2023-10-04 03:31:24 +00:00			`Coming soon:`
Initial commit 2023-08-16 16:33:37 +00:00
Update README.md 2023-10-04 03:41:49 +00:00			`Multi-node functionality`