Skip to content
This repository was archived by the owner on Nov 18, 2023. It is now read-only.

Commit 013ee26

Browse files
committed
Docker: document usage.
1 parent be03f16 commit 013ee26

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,20 @@ Or for Python 3:
7777
$ sudo pip3 install --upgrade youtube-dl
7878

7979
It is advisable to run this regularly as it has to keep up with YouTube updates.
80-
Certainly first try updating youtube-dl when plaincast stops working.
80+
Certainly first try updating `youtube-dl` when plaincast stops working.
8181

82+
## Docker
83+
84+
Both `Dockerfile` and Docker Compose manifest are provided. The former builds
85+
a Docker image with the program binary built from local code and the required
86+
build dependencies. The Docker image also includes a recent `youtube-dl`
87+
version. This will avoid the need of installing a recent version for the local
88+
OS and version on the host, thus avoiding the risks of installing any software.
89+
The [Docker Compose manifest](./docker-compose.yml) contains the configuration
90+
settings needed to launch a Docker container.
91+
To run the Docker image, just run:
92+
93+
$ docker-compose up --build --force-recreate
8294

8395
## Known issues
8496

0 commit comments

Comments
 (0)