From 2282c5748c33160a3603b351223881bb4e1320b7 Mon Sep 17 00:00:00 2001 From: Maxence Date: Fri, 13 Nov 2020 03:47:35 +0000 Subject: [PATCH] Update README --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d7b23d72..00d2f4fa 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,6 @@ Simple Web and REST interface for downloading youtube videos onto a server. [`bottle`](https://github.com/bottlepy/bottle) + [`youtube-dl`](https://github.com/rg3/youtube-dl) / [`youtube-dlc`](https://github.com/blackjack4494/yt-dlc) -*Note:* The main branch and docker image are now using youtube-dlc, the development of which is more active. To use the original youtube-dl, use branch [youtube-dl](https://github.com/nbr23/youtube-dl-server/tree/youtube-dl). - Forked from [manbearwiz/youtube-dl-server](https://github.com/manbearwiz/youtube-dl-server). ![screenshot][1] @@ -19,7 +17,9 @@ Forked from [manbearwiz/youtube-dl-server](https://github.com/manbearwiz/youtube For easier deployment, a docker image is available on [dockerhub](https://hub.docker.com/r/nbr23/youtube-dl-server). -The `latest` image now uses youtube-dlc. For the original youtube-dl based image, use `nbr23/youtube-dl-server:youtube-dl` +The `latest` tag uses `youtube-dl`. + +You can ensure you are using `youtube-dl` or `youtube-dlc` by using the tags of the same name, eg: `nbr23/youtube-dl-server:youtube-dl` and `nbr23/youtube-dl-server:youtube-dlc`. ### Docker CLI @@ -29,12 +29,6 @@ This example uses the docker run command to create the container to run the app. docker run -d --name youtube-dl -v $HOME/youtube-dl:/youtube-dl nbr23/youtube-dl-server:latest ``` -For the original youtube-dl: - -```shell -docker run -d --name youtube-dl -v $HOME/youtube-dl:/youtube-dl nbr23/youtube-dl-server:youtube-dl -``` - ### Docker Compose This is an example service definition that could be put in `docker-compose.yml`. @@ -47,8 +41,6 @@ This is an example service definition that could be put in `docker-compose.yml`. restart: always ``` -The `latest` image now uses youtube-dlc. For the original youtube-dl based image, use `nbr23/youtube-dl-server:youtube-dl` - #### Configuration For easier configuration management and edition, you can save your variables in an external file and source them in your docker-compose.yml like the following example. @@ -76,10 +68,18 @@ docker-compose.yml: If you have python ^3.3.0 installed in your PATH you can simply run like this, providing optional environment variable overrides inline. +You will need `bottle` and either `youtube-dl` or `youtube-dlc` installed locally. + ```shell YDL_SERVER_PORT=8123 python3 -u ./youtube-dl-server.py ``` +To force using `youtube-dl` or `youtube-dlc`, use the variable `YOUTUBE_DL`: + +```shell +YOUTUBE_DL=youtube-dlc YDL_SERVER_PORT=8123 python3 -u ./youtube-dl-server.py +``` + ## Usage ### Start a download remotely @@ -129,7 +129,7 @@ javascript:(function(){document.body.innerHTML += '