diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 00000000..2b4978ce --- /dev/null +++ b/docker/README.md @@ -0,0 +1,48 @@ +# Running ytdl-sub in Docker +The ytdl-sub docker image uses +[LinuxServer's](https://www.linuxserver.io/) +[base alpine image](https://github.com/linuxserver/docker-baseimage-alpine). +It looks, feels, and operates like other LinuxServer.io images. + +The image will install ytdl-sub as a python package, and can be used +via command line with `ytdl-sub`. + +## Building Locally +Run `make docker` in the root directory of this repo to build the image. This +will build the python wheel and install it in the Dockerfile. + +## Usage +### docker-compose +```yaml +version: "2.1" +services: + ytdl-sub: + image: ytdl-sub:latest + container_name: ytdl-sub + environment: + - PUID=1000 + - PGID=1000 + - TZ=America/Los_Angeles + volumes: + - :/config + - :/tv_shows # optional + - :/movies # optional + - :/music_videos # optional + - :/music # optional + restart: unless-stopped +``` +### docker cli +```commandline +docker run -d \ + --name=ytdl-sub \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=America/Los_Angeles \ + -v :/config \ + -v :/tv_shows \ + -v :/movies \ + -v :/music_videos \ + -v :/music \ + --restart unless-stopped \ + ytdl-sub:latest +``` \ No newline at end of file