adb08ed5f9
* docs(presets): Stale copied prebuilt comment * docs(start): How to configure subscriptions Revise the subscriptions file Getting Started tutorial from the perspective of a new user. The idea is that the ref docs describe a component as the code sees it, whereas the how-to/tutorial/getting-started docs provide a narrative description of the component from the external perspective of a typical new user. * docs(start): Document subscription override mode It's debatable whether this belongs here. Having moved onto my own custom presets, the only use cases for override mode in my subscriptions file are for those series that also have TVDB metadata. Those ytdl-sub downloads I integrate into my Sonarr library need per-subscription overrides such as: - Sonarr manages years 2020-2023 for one series and ytdl-sub fills in from there, so set a `sonarr_series_after: "20240101"` override - each series needs a directory named per Sonarr's configuration with the TVDB ID, the subscription key, but also a series name prefix without the TVDB ID for each episode file, so set a `sonarr_series_prefix: "Foo Series (2020)"` override So are there other use cases for override mode that are more common and less niche than mine? * docs(docker): Revert example bind mount volumes Per [PR feedback](https://github.com/jmbannon/ytdl-sub/pull/1310#discussion_r2306067263).
69 lines
1.7 KiB
ReStructuredText
69 lines
1.7 KiB
ReStructuredText
Automating Downloads
|
|
====================
|
|
|
|
:ref:`Guide for Docker and Unraid Containers <guides/getting_started/automating_downloads:docker and unraid>`
|
|
|
|
:ref:`Guide for Linux <guides/getting_started/automating_downloads:linux>`
|
|
|
|
:ref:`Guide for Windows <guides/getting_started/automating_downloads:windows>`
|
|
|
|
.. _cron scheduling syntax: https://crontab.guru/#0_*/6_*_*_*
|
|
|
|
|
|
.. _docker-unraid-setup:
|
|
|
|
Docker and Unraid
|
|
-----------------
|
|
|
|
Cron is preconfigured in every ytdl-sub docker container. Enable by adding the following
|
|
ENV variables to your docker setup.
|
|
|
|
.. code-block:: yaml
|
|
|
|
services:
|
|
ytdl-sub:
|
|
environment:
|
|
- CRON_SCHEDULE="0 */6 * * *"
|
|
- CRON_RUN_ON_START=false
|
|
|
|
|
|
- ``CRON_SCHEDULE`` follows the standard `cron scheduling syntax`_. 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 in
|
|
addition to the cron schedule.
|
|
|
|
The cron script will reside in the main directory with the file name ``cron``. Cron
|
|
logs should show when viewing the Docker logs.
|
|
|
|
|
|
.. _linux-setup:
|
|
|
|
Linux
|
|
-----
|
|
Must configure crontab manually, like so:
|
|
|
|
.. code-block:: shell
|
|
|
|
crontab -e
|
|
0 */6 * * * /config/run_cron
|
|
|
|
|
|
.. _windows-setup:
|
|
|
|
Windows
|
|
-------
|
|
|
|
To be tested (please contact code owner or join the discord server if you can test this
|
|
out for us)
|
|
|
|
.. code-block:: powershell
|
|
|
|
ytdl-sub.exe --config \path\to\config\config.yaml sub \path\to\config\subscriptions.yaml
|
|
|
|
|
|
Next Steps
|
|
----------
|
|
|
|
Once you have a significant quantity of subscriptions or have use cases not served using
|
|
:doc:`YAML keys and the special characters <./subscriptions>`, it's time to start
|
|
:doc:`defining your own custom presets <./first_config>`.
|