51c134a036
Drastically simplifies setting up cron within ytdl-sub. Below is the documentation which is available in readthedocs, and a section on how to migrate from the old way to this.
## New Cron Documentation
Cron is preconfigured in every ytdl-sub docker container. Enable by adding the following ENV variables to your docker setup.
```
services:
ytdl-sub:
environment:
- CRON_SCHEDULE="0 */6 * * *"
- CRON_RUN_ON_START=false
```
- CRON_SCHEDULE follows the standard [cron scheduling syntax](https://crontab.guru/#0_*/6_*_*_*). The above value will run the script once every 6 hours.
- CRON_RUN_ON_START toggles whether to run your cron script on container start.
The cron script will reside in the main directory with the file name `cron`. Cron logs should show when viewing the Docker logs.
## Migrating Existing Cron Setup
Containers' cron files will remain intact until you add the `CRON_SCHEDULE` variable. Once you add that with your preferred schedule, it will write that value to /config/crontabs/abc and create a new file `cron` within your working directory. Simply copy everything from your existing `run_cron` script into `cron`.
If you have the ENV variable `DOCKER_MODS` in your docker-compose, remove it. It is now included by default. Not removing this will prevent cron logs from showing in your docker container logs.
154 lines
No EOL
4.7 KiB
ReStructuredText
154 lines
No EOL
4.7 KiB
ReStructuredText
======
|
|
Docker
|
|
======
|
|
|
|
For automating ``subscriptions.yaml`` downloads to pull new media, see :ref:`this page <guides/getting_started/automating_downloads:docker and unraid>` on how to set up a cron job in any of the docker containers.
|
|
|
|
The ``ytdl-sub`` Docker images use :lsio:`LSIO-based images <\ >` and install ytdl-sub on top. There are two flavors to choose from.
|
|
|
|
.. margin::
|
|
|
|
.. tip::
|
|
|
|
The recommended docker image is the GUI image.
|
|
|
|
:ref:`Docker Compose <guides/install/docker:install with docker compose>` is the recommended way of setting up a ``ytdl-sub`` docker container.
|
|
|
|
GUI Image
|
|
---------
|
|
|
|
The GUI image uses LSIO's :lsio-gh:`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 :lsio-gh:`docker-baseimage-alpine image <\ >` for its base image. Execute the following command to access and interact with ``ytdl-sub``:
|
|
|
|
.. code-block:: bash
|
|
|
|
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.
|
|
|
|
.. margin::
|
|
|
|
.. important::
|
|
|
|
Set the PUID and PGID to the UID and GID associated with the user you want to own the downloaded files. Setting these values to root UID and GID may create issues with your media managers.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: GUI Image
|
|
|
|
.. code-block:: yaml
|
|
:caption: 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
|
|
|
|
.. tab-item:: Headless Image
|
|
|
|
.. code-block:: yaml
|
|
:caption: 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
|
|
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
|
|
^^^^^^^^^^^^^^^
|
|
|
|
.. code-block:: yaml
|
|
:emphasize-lines: 5-6
|
|
:caption: 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
|
|
^^^^^^^^^^^^^^^
|
|
|
|
.. Awe
|
|
|
|
.. code-block:: yaml
|
|
:caption: compose.yaml
|
|
:emphasize-lines: 5-13
|
|
|
|
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 <https://docs.docker.com/engine/reference/run/>`_ for further information on the parameters and other options you can use.
|
|
|
|
.. code-block:: bash
|
|
|
|
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 |