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

Commit

Permalink
Docker: document usage.
Browse files Browse the repository at this point in the history
  • Loading branch information
pataquets committed Nov 16, 2020
1 parent be03f16 commit 013ee26
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,20 @@ Or for Python 3:
$ sudo pip3 install --upgrade youtube-dl

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

## Docker

Both `Dockerfile` and Docker Compose manifest are provided. The former builds
a Docker image with the program binary built from local code and the required
build dependencies. The Docker image also includes a recent `youtube-dl`
version. This will avoid the need of installing a recent version for the local
OS and version on the host, thus avoiding the risks of installing any software.
The [Docker Compose manifest](./docker-compose.yml) contains the configuration
settings needed to launch a Docker container.
To run the Docker image, just run:

$ docker-compose up --build --force-recreate

## Known issues

Expand Down

0 comments on commit 013ee26

Please sign in to comment.