Changed Readme

This commit is contained in:
Maximilian Wagner
2023-08-05 15:46:59 +02:00
parent 306d3b6c88
commit 6b796c52ba

View File

@@ -1,25 +1,25 @@
# yt-mls
## yt-mls
YouTube Media Library Server aims to make downloading and updating media libraries easy.
# features
## features
- Download of channels, playlists and videos in mp3 or mp4
- Download of processed files either individually or entire channels and playlists as a .zip
- Update of channels and playlists from the library
- Watching videos via an embed
# currently not supported
## currently not supported
Having the same video in mp3 _and_ mp4 is not possible with how the download process and database work. This includes channels and playlists. The chosen type on initial download dictates what you have.
# media sources
Currently supported is YouTube but its possible expand since the download itself is handled by yt-dlp.
## media sources
Currently supported is YouTube but its possible to expand since the download itself is handled by yt-dlp.
# deployment
## deployment
To deploy this app, you need a production-ready WSGI server like Waitress. Do not use the Flask built-in development server.
## Deployment with waitress:
### Deployment with waitress:
Clone the repo or download as zip and unpack.
Navigate into the created directory.
@@ -31,4 +31,6 @@ $ python server.py
```
Starting the server using `waitress.serve` is handled by server.py.
The default port is `5000` and can be changed by editing the `PORT` variable in the script.
The default port is `5000` and can be changed by editing the `PORT` variable in the script.
If you want to limit the duration of videos you want to download e.g. if you want to download only single titles from a playlist with mixes, set `MAX_VIDEO_DOWNLOAD_LENGTH_MINUTES` to the desired amount. Default is `10` minutes.