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

docs(sphinx): Fix extlinks LSIO reference usage

Browse source
This commit is contained in:
Ross Patterson 2025-08-15 15:19:55 -07:00
parent 66c792b80b
commit 19e68f7cac
No known key found for this signature in database
GPG key ID: 2EFF7CCE6828E359
1 changed files with 12 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -13,25 +13,24 @@ automate running ``ytdl-sub`` in a container running either variant.
GUI Image GUI Image
--------- ---------
The GUI image is based on :lsio-gh:`LSIO's docker-code-server image <\ >` to provide you The GUI image is based on LSIO's :lsio-gh:`docker-code-server` to provide you full
full management of ``ytdl-sub``, such as file editing and terminal access, all within management of ``ytdl-sub``, such as file editing and terminal access, all within your
your browser using the VS Code web UI. See its documentation regarding environment browser using the VS Code web UI. See its documentation regarding environment variables
variables and other details. Once running, open `the web UI`_ to edit the and other details. Once running, open `the web UI`_ to edit the `configuration`_ and run
`configuration`_ and run ``ytdl-sub``. ``ytdl-sub``.
.. _`the web UI`: http://localhost:8443 .. _`the web UI`: http://localhost:8443
Headless Image Headless Image
-------------- --------------
The headless image is based on :lsio-gh:`LSIO's docker-baseimage-alpine image <\ The headless image is based on LSIO's :lsio-gh:`docker-baseimage-alpine`. Once running,
>`. Once running, the default command just starts services including cron for the default command just starts services including cron for :ref:`Automating Downloads
:ref:`Automating Downloads <guides/getting_started/automating_downloads:docker and <guides/getting_started/automating_downloads:docker and unraid>` but otherwise doesn't
unraid>` but otherwise doesn't run ``ytdl-sub``. You may run arbitrary ``ytdl-sub`` run ``ytdl-sub``. You may run arbitrary ``ytdl-sub`` commands using the
commands using the ``--rm --user="${PUID}:${PGID}" --entrypoint="ytdl-sub"`` options to ``--rm --user="${PUID}:${PGID}" --entrypoint="ytdl-sub"`` options to either ``$ docker
either ``$ docker run`` or ``$ docker compose run``. Overriding the image's run`` or ``$ docker compose run``. Overriding the image's ``ENTRYPOINT`` is important so
``ENTRYPOINT`` is important so that cron doesn't run ``ytdl-sub`` while you're running that cron doesn't run ``ytdl-sub`` while you're running it manually.
it manually.
For example:: For example::