From a96fcff55fffeb6c40d46d5d53bb7a20b6238263 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Wed, 15 Mar 2023 16:12:42 -0700 Subject: [PATCH] [DOCS] passthrough in README (#549) --- README.md | 2 ++ docs/install.rst | 50 ++++++++++++++++++++++++------------------------ 2 files changed, 27 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 94ed04d7..1291ac37 100644 --- a/README.md +++ b/README.md @@ -238,6 +238,8 @@ player to recognize downloads as: `ytdl-sub` can be installed on the following platforms. - [Docker Compose](https://ytdl-sub.readthedocs.io/en/latest/install.html#docker-compose_) + - [with CPU passthrough](https://ytdl-sub.readthedocs.io/en/latest/install.html#cpu-passthrough) + - [with GPU passthrough](https://ytdl-sub.readthedocs.io/en/latest/install.html#nvidia-gpu-passthrough) - [Docker CLI](https://ytdl-sub.readthedocs.io/en/latest/install.html#docker) - [Windows](https://ytdl-sub.readthedocs.io/en/latest/install.html#windows) - [Linux](https://ytdl-sub.readthedocs.io/en/latest/install.html#linux) diff --git a/docs/install.rst b/docs/install.rst index 9b6fef57..584d39cb 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -39,6 +39,31 @@ on how set up a cron job in the docker container. - :/music # optional 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 + Nvidia GPU Passthrough ^^^^^^^^^^^^^^^^^^^^^^ For GPU passthrough, you must use the ``ytdl-sub`` Ubuntu version with the following additions: @@ -69,31 +94,6 @@ For GPU passthrough, you must use the ``ytdl-sub`` Ubuntu version with the follo - 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 -------------- .. code-block:: bash