From b8e36db43be8b196f5ac65abc0c8f1ddaaaf60f5 Mon Sep 17 00:00:00 2001 From: pataquets Date: Mon, 16 Nov 2020 21:08:30 +0100 Subject: [PATCH] Docker: document usage. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index db9c78d..e1ec7b5 100644 --- a/README.md +++ b/README.md @@ -77,8 +77,18 @@ 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 manifests 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. +To run the Docker image, just run: + + $ docker-compose up --build --force-recreate ## Known issues