Ctrl+K

Docker

Docker#

For automating subscriptions.yaml downloads to pull new media, see this page on how to set up a cron job in any of the docker containers.

The ytdl-sub Docker images use LSIO-based images and install ytdl-sub on top. There are two flavors to choose from.

GUI Image#

The GUI image uses LSIO’s docker-code-server image for its base image. More info on other code-server environment variables can be found within its documentation.

After starting, the code-server will be running at http://localhost:8443. Open this page in a browser to access and interact with ytdl-sub.

Headless Image#

The headless image uses LSIO’s docker-baseimage-alpine image for its base image. Execute the following command to access and interact with ytdl-sub:

docker exec -u abc -it ytdl-sub /bin/bash

Install with Docker Compose#

Docker Compose is an easy “set it and forget it” install method. Follow the instructions below to create a compose.yaml file for your chosen ytdl-sub image.

compose.yaml#
services:
ytdl-sub:
  image: ghcr.io/jmbannon/ytdl-sub-gui:latest
  container_name: ytdl-sub
  environment:
    - PUID=1000
    - PGID=1000
    - TZ=America/Los_Angeles
  volumes:
    - <path/to/ytdl-sub/config>:/config
    - <path/to/tv_shows>:/tv_shows  # optional
    - <path/to/movies>:/movies  # optional
    - <path/to/music_videos>:/music_videos  # optional
    - <path/to/music>:/music  # optional
  ports:
    - 8443:8443
  restart: unless-stopped
compose.yaml#
services:
ytdl-sub:
  image: ghcr.io/jmbannon/ytdl-sub:latest
  container_name: ytdl-sub
  environment:
    - PUID=1000
    - PGID=1000
    - TZ=America/Los_Angeles
    - DOCKER_MODS=linuxserver/mods:universal-cron
  volumes:
    - <path/to/ytdl-sub/config>:/config
    - <path/to/tv_shows>:/tv_shows  # optional
    - <path/to/movies>:/movies  # optional
    - <path/to/music_videos>:/music_videos  # optional
    - <path/to/music>:/music  # optional
  restart: unless-stopped

Device Passthrough#

For CPU or GPU passthrough, you must use either the GUI image or the headless Ubuntu image ghcr.io/jmbannon/ytdl-sub:ubuntu-latest.

The docker-compose examples use the GUI image.

CPU Passthrough#

compose.yaml#
services:
  ytdl-sub:
    image: ghcr.io/jmbannon/ytdl-sub-gui:latest
    container_name: ytdl-sub
    devices:
      - /dev/dri:/dev/dri  # CPU passthrough
    restart: unless-stopped

GPU Passthrough#

compose.yaml#
services:
ytdl-sub:
  image: ghcr.io/jmbannon/ytdl-sub-gui:latest
  container_name: ytdl-sub
  environment:
  - ..
  - NVIDIA_DRIVER_CAPABILITIES=all  # Nvidia ENV args
  - NVIDIA_VISIBLE_DEVICES=all
  deploy:
    resources:
      reservations:
        devices:
          - capabilities: ["gpu"]  # GPU passthrough
  restart: unless-stopped

Docker CLI#

If you prefer to only run the container once, you can use the CLI command instead. The following command is for the gui image, and will not restart if it comes down for any reason. See the Docker reference for further information on the parameters and other options you can use.

docker run -d \
  --name=ytdl-sub \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=America/Los_Angeles \
  -p 8443:8443 \
  -v <path/to/ytdl-sub/config>:/config \
  -v <OPTIONAL/path/to/tv_shows>:/tv_shows \
  -v <OPTIONAL/path/to/movies>:/movies \
  -v <OPTIONAL/path/to/music_videos>:/music_videos \
  -v <OPTIONAL/path/to/music>:/music \
  ghcr.io/jmbannon/ytdl-sub-gui:latest
Contents