d0fdb11ac4
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.
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>`.
|