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).
128 lines
3.7 KiB
ReStructuredText
128 lines
3.7 KiB
ReStructuredText
==================
|
|
Subscription File
|
|
==================
|
|
|
|
A subscription file is designed to both define and organize many things to download in
|
|
condensed YAML.
|
|
|
|
.. hint::
|
|
|
|
Read the :ref:`getting started guide <guides/getting_started/index:Getting Started>`
|
|
first before reviewing this section.
|
|
|
|
|
|
File Preset
|
|
-----------
|
|
|
|
Many examples show ``__preset__`` at the top. This is known as the *subscription file
|
|
preset*. It is where a single :ref:`preset <guides/getting_started/first_config:Custom
|
|
Preset Definition>` can be defined that gets applied to each subscription within the
|
|
file.
|
|
|
|
This is a good place to apply file-wide variables such as ``tv_show_directory`` or
|
|
supply a cookies file path.
|
|
|
|
.. code-block:: yaml
|
|
|
|
__preset__:
|
|
# Variables that override defaults from `overrides:` for presets in YAML keys:
|
|
overrides:
|
|
tv_show_directory: "/tv_shows"
|
|
|
|
# Directly set plugin options:
|
|
ytdl_options:
|
|
cookiefile: "/config/cookie.txt"
|
|
|
|
Layout
|
|
------
|
|
|
|
A subscription file is comprised of YAML keys and values. Keys can be either
|
|
|
|
- a preset
|
|
- an override value
|
|
- a subscription name
|
|
|
|
Take the following example:
|
|
|
|
.. code-block:: yaml
|
|
|
|
Jellyfin TV Show by Date:
|
|
= News:
|
|
"Breaking News": "https://www.youtube.com/@SomeBreakingNews"
|
|
"BBC News": "https://www.youtube.com/@BBCNews"
|
|
|
|
All three types of keys are used for the following:
|
|
|
|
- ``Jellyfin TV Show by Date`` - a prebuilt preset
|
|
- ``= News`` - an override value for genre
|
|
- ``Breaking News``, ``BBC News`` - The subscription names
|
|
|
|
The lowest level, most indented keys should always be the subscription name. It is good
|
|
practice to put subscription names in quotes to differentiate between preset names and
|
|
subscription names.
|
|
|
|
Values should always be the subscription itself. The simplest form is just the
|
|
URL. Further sections will show more exotic examples that go beyond a single URL.
|
|
|
|
|
|
Inheritance
|
|
-----------
|
|
|
|
A subscription inherits every key above it. In the above example, both ``Breaking News``
|
|
and ``BBC News`` inherits the ``Jellyfin TV Show by Date`` preset and the ``= News``
|
|
override value.
|
|
|
|
.. note::
|
|
|
|
There are no limits or boundaries on how one structures their presets. This
|
|
flexibility is intended for subscription authors to organize their downloads as they
|
|
see fit.
|
|
|
|
|
|
Multi Keys
|
|
----------
|
|
|
|
Subscription keys support pipe syntax, or ``|``, which allows multiple keys to be
|
|
defined on a single line. The following is equivalent to the above example:
|
|
|
|
.. code-block:: yaml
|
|
|
|
Jellyfin TV Show by Date | = News:
|
|
"Breaking News": "https://www.youtube.com/@SomeBreakingNews"
|
|
"BBC News": "https://www.youtube.com/@BBCNews"
|
|
|
|
|
|
Override Mode
|
|
-------------
|
|
|
|
Often times, it is convenient to set multiple override values for a single
|
|
subscription. We can put a preset in *override mode* by using tilda syntax, or ``~``.
|
|
|
|
Suppose we want to apply the :ref:`Only Recent <prebuilt_presets/helpers:Only Recent>`
|
|
preset to the above examples. But for ``BBC News`` specifically, we want to set the date
|
|
range to be different than the default ``2months`` value to ``2weeks``.
|
|
|
|
We can change it as follows:
|
|
|
|
.. code-block:: yaml
|
|
|
|
Jellyfin TV Show by Date
|
|
= News | Only Recent:
|
|
"Breaking News": "https://www.youtube.com/@SomeBreakingNews"
|
|
"~BBC News":
|
|
url: "https://www.youtube.com/@BBCNews"
|
|
only_recent_date_range: "2weeks"
|
|
|
|
.. important::
|
|
|
|
When using override mode, we need to set the ``url`` variable since we are no longer
|
|
using the simplified *subscription_value*. For more info on how this works, read about
|
|
:ref:`subscription variables <config_reference/scripting/static_variables:Subscription
|
|
Variables>`.
|
|
|
|
|
|
Map Mode
|
|
--------
|
|
|
|
Map mode is for highly advanced presets that benefit from a more complex subscription
|
|
definition. TODO: Show music video example here.
|