From ec51361728ddb58d687b35769cef93b40cc37c1d Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Wed, 15 Mar 2023 16:08:15 -0700 Subject: [PATCH] [DOCS] Docker passthrough install docs (#548) --- docs/install.rst | 63 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 59 insertions(+), 4 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 660cb6d4..9b6fef57 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -33,10 +33,65 @@ on how set up a cron job in the docker container. - DOCKER_MODS=linuxserver/mods:universal-cron volumes: - :/config - - :/tv_shows # optional - - :/movies # optional - - :/music_videos # optional - - :/music # optional + - :/tv_shows # optional + - :/movies # optional + - :/music_videos # optional + - :/music # optional + restart: unless-stopped + +Nvidia GPU Passthrough +^^^^^^^^^^^^^^^^^^^^^^ +For GPU passthrough, you must use the ``ytdl-sub`` Ubuntu version with the following additions: + +.. code-block:: yaml + + services: + ytdl-sub: + image: ghcr.io/jmbannon/ytdl-sub:ubuntu-latest + container_name: ytdl-sub + environment: + - PUID=1000 + - PGID=1000 + - TZ=America/Los_Angeles + - DOCKER_MODS=linuxserver/mods:universal-cron + - NVIDIA_DRIVER_CAPABILITIES=all # Nvidia ENV args + - NVIDIA_VISIBLE_DEVICES=all + volumes: + - :/config + - :/tv_shows # optional + - :/movies # optional + - :/music_videos # optional + - :/music # optional + deploy: + resources: + reservations: + devices: + - capabilities: [gpu] # GPU passthrough + restart: unless-stopped + +CPU Passthrough +^^^^^^^^^^^^^^^^^^^^^^ +For CPU passthrough, you must use the ``ytdl-sub`` Ubuntu version with the following additions: + +.. code-block:: yaml + + services: + ytdl-sub: + image: ghcr.io/jmbannon/ytdl-sub:ubuntu-latest + container_name: ytdl-sub + environment: + - PUID=1000 + - PGID=1000 + - TZ=America/Los_Angeles + - DOCKER_MODS=linuxserver/mods:universal-cron + volumes: + - :/config + - :/tv_shows # optional + - :/movies # optional + - :/music_videos # optional + - :/music # optional + devices: + - /dev/dri:/dev/dri # CPU passthrough restart: unless-stopped Docker