danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(docker): Recommended image DEFAULT_WORKSPACE

Browse source
This commit is contained in:
Ross Patterson 2025-08-30 09:39:53 -07:00
parent 45c155c039
commit 281988a370
No known key found for this signature in database
GPG key ID: 2EFF7CCE6828E359
5 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -68,7 +68,7 @@ __preset__:
# Pass any arg directly to yt-dlp's Python API # Pass any arg directly to yt-dlp's Python API
ytdl_options: ytdl_options:
cookiefile: "/config/cookie.txt" cookiefile: "/config/ytdl-sub-configs/cookie.txt"
################################################################### ###################################################################
# TV Show Presets. Can replace Plex with Plex/Jellyfin/Emby/Kodi # TV Show Presets. Can replace Plex with Plex/Jellyfin/Emby/Kodi

2
docker/root/defaults/subscriptions.yaml
View file

@ -20,7 +20,7 @@ __preset__:
# Pass any arg directly to yt-dlp's Python API # Pass any arg directly to yt-dlp's Python API
# ytdl_options: # ytdl_options:
# cookiefile: "/config/cookie.txt" # cookiefile: "/config/ytdl-sub-configs/cookie.txt"
################################################################### ###################################################################
# Subscriptions nested under this will use the # Subscriptions nested under this will use the

2
docs/source/config_reference/subscription_yaml.rst
View file

@ -31,7 +31,7 @@ supply a cookies file path.
# Directly set plugin options: # Directly set plugin options:
ytdl_options: ytdl_options:
cookiefile: "/config/cookie.txt" cookiefile: "/config/ytdl-sub-configs/cookie.txt"
Layout Layout
------ ------

7
docs/source/guides/install/docker.rst
View file

@ -38,6 +38,13 @@ For example::
$ docker compose run --rm --user="${PUID}:${PGID}" --entrypoint="ytdl-sub" ytdl-sub sub $ docker compose run --rm --user="${PUID}:${PGID}" --entrypoint="ytdl-sub" ytdl-sub sub
.. note::
In `the recommended GUI image <gui image_>`_, the ``DEFAULT_WORKSPACE`` directory is
``/config/ytdl-sub-configs/`` which is used throughout the documentation and
examples. In the headless images, that directory is just ``/config/``, so substitute
that path if using a headless image.
Install with Docker Compose Install with Docker Compose
--------------------------- ---------------------------

2
examples/advanced/tv_show_config.yaml
View file

@ -69,7 +69,7 @@ presets:
# ytdl_options lets you pass any arg into yt-dlp's Python API # ytdl_options lets you pass any arg into yt-dlp's Python API
ytdl_options: ytdl_options:
# Set the cookie file # Set the cookie file
# cookiefile: "/config/youtube_cookies.txt" # cookiefile: "/config/ytdl-sub-configs/youtube_cookies.txt"
# For YouTube, get English metadata if multiple languages are present # For YouTube, get English metadata if multiple languages are present
extractor_args: extractor_args: