catman/yt-mls
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changed Readme

Browse Source
This commit is contained in:
Maximilian Wagner
2023-08-05 15:49:05 +02:00
parent 6b796c52ba
commit 6f5d03f449
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,16 +1,13 @@
## yt-mls
YouTube Media Library Server aims to make downloading and updating media libraries easy.
## 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
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.
- Listening to song via an embed
## media sources
Currently supported is YouTube but its possible to expand since the download itself is handled by yt-dlp.
@@ -19,6 +16,7 @@ Currently supported is YouTube but its possible to expand since the download its
## 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:
Clone the repo or download as zip and unpack.
Navigate into the created directory.
@@ -30,7 +28,15 @@ $ pip install -r requirements.txt
$ python server.py
```
Install ffmpeg / ffprobe.
### configuration
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.
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.
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.
## 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.