60ff645750
I've been running into variations in style in the docs I've edited so far. I've been including changes for consistency in with other commits but in many cases that makes one part of one doc more consistent with the rest but less consistent with itself. It seems like a bit of cleanup may be in order. This change applies the following conventions: - Section heading heirarchy: #. ``=`` with overline for document title, IOW first heading #. ``-`` #. ``~`` #. ``"`` - Two newlines before ``-`` sections for readability - A newline between every section of any level and the first line of text - Wrap paragraph lines at 88 characters to match Python's Black I've only applied these changes to those ``*.rst`` files that aren't generated. In the future, I might suggest another bulk change to match [the Sphinx conventions for section headings](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections).
61 lines
1.5 KiB
ReStructuredText
61 lines
1.5 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
|