Skip to content

Commit 2282c57

Browse files
committed
Update README
1 parent fca07be commit 2282c57

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
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)
88

9-
*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).
10-
119
Forked from [manbearwiz/youtube-dl-server](https://github.com/manbearwiz/youtube-dl-server).
1210

1311
![screenshot][1]
@@ -19,7 +17,9 @@ Forked from [manbearwiz/youtube-dl-server](https://github.com/manbearwiz/youtube
1917

2018
For easier deployment, a docker image is available on [dockerhub](https://hub.docker.com/r/nbr23/youtube-dl-server).
2119

22-
The `latest` image now uses youtube-dlc. For the original youtube-dl based image, use `nbr23/youtube-dl-server:youtube-dl`
20+
The `latest` tag uses `youtube-dl`.
21+
22+
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`.
2323

2424
### Docker CLI
2525

@@ -29,12 +29,6 @@ This example uses the docker run command to create the container to run the app.
2929
docker run -d --name youtube-dl -v $HOME/youtube-dl:/youtube-dl nbr23/youtube-dl-server:latest
3030
```
3131

32-
For the original youtube-dl:
33-
34-
```shell
35-
docker run -d --name youtube-dl -v $HOME/youtube-dl:/youtube-dl nbr23/youtube-dl-server:youtube-dl
36-
```
37-
3832
### Docker Compose
3933

4034
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`.
4741
restart: always
4842
```
4943
50-
The `latest` image now uses youtube-dlc. For the original youtube-dl based image, use `nbr23/youtube-dl-server:youtube-dl`
51-
5244
#### Configuration
5345
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.
5446
@@ -76,10 +68,18 @@ docker-compose.yml:
7668

7769
If you have python ^3.3.0 installed in your PATH you can simply run like this, providing optional environment variable overrides inline.
7870

71+
You will need `bottle` and either `youtube-dl` or `youtube-dlc` installed locally.
72+
7973
```shell
8074
YDL_SERVER_PORT=8123 python3 -u ./youtube-dl-server.py
8175
```
8276

77+
To force using `youtube-dl` or `youtube-dlc`, use the variable `YOUTUBE_DL`:
78+
79+
```shell
80+
YOUTUBE_DL=youtube-dlc YDL_SERVER_PORT=8123 python3 -u ./youtube-dl-server.py
81+
```
82+
8383
## Usage
8484

8585
### Start a download remotely
@@ -129,7 +129,7 @@ javascript:(function(){document.body.innerHTML += '<form name="ydl_form" method=
129129

130130
## Implementation
131131

132-
The server uses [`bottle`](https://github.com/bottlepy/bottle) for the web framework and [`youtube-dl`](https://github.com/rg3/youtube-dl) to handle the downloading. The integration with youtube-dl makes use of their [python api](https://github.com/rg3/youtube-dl#embedding-youtube-dl).
132+
The server uses [`bottle`](https://github.com/bottlepy/bottle) for the web framework and [`youtube-dl`](https://github.com/rg3/youtube-dl) / [`youtube-dlc`](https://github.com/blackjack4494/yt-dlc) to handle the downloading. The integration with youtube-dl makes use of their [python api](https://github.com/rg3/youtube-dl#embedding-youtube-dl).
133133

134134
This docker image is based on [`python:alpine`](https://registry.hub.docker.com/_/python/) and consequently [`alpine:3.8`](https://hub.docker.com/_/alpine/).
135135

0 commit comments

Comments
 (0)