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).
56 lines
1.6 KiB
ReStructuredText
56 lines
1.6 KiB
ReStructuredText
Initial Download
|
|
================
|
|
|
|
Once you've created :doc:`a subscriptions file <./subscriptions>`, you can perform your
|
|
first download. Access ``ytdl-sub``, navigate to the directory containing your
|
|
``subscriptions.yaml`` file.
|
|
|
|
|
|
Dry Run
|
|
-------
|
|
|
|
Performing a dry run is important when applying any change to your subscriptions to
|
|
ensure output looks as expected. Dry runs will pull metadata to *simulate* a download
|
|
without actually downloading the media file.
|
|
|
|
.. code-block:: shell
|
|
|
|
ytdl-sub --dry-run sub subscriptions.yaml
|
|
|
|
|
|
Faster Iteration Cycle
|
|
----------------------
|
|
|
|
Testing subscriptions can take quite some time to perform a full download. This can be
|
|
speed up by applying an override via command-line to set max number of downloads.
|
|
|
|
.. code-block:: shell
|
|
|
|
ytdl-sub --dry-run sub subscriptions.yaml -o '--ytdl_options.max_downloads 3'
|
|
|
|
Having many subscriptions could still make this dry run take a while. A subset of
|
|
subscriptions can be dry ran using a match.
|
|
|
|
.. code-block:: shell
|
|
:caption: Only run subscriptions that have PBS in their names
|
|
|
|
ytdl-sub --dry-run sub subscriptions.yaml -o '--ytdl_options.max_downloads 3' --match PBS
|
|
|
|
|
|
Downloading
|
|
-----------
|
|
|
|
Once the subscriptions file is validated, a download can be performed by omitting the
|
|
dry run argument.
|
|
|
|
.. code-block:: shell
|
|
|
|
ytdl-sub sub subscriptions.yaml
|
|
|
|
Multiple subscription file names can be provided to perform a download on all of them. A
|
|
single file named ``subscriptions.yaml`` does not require a file name specification
|
|
since it will look for that file name by default, making the following command valid.
|
|
|
|
.. code-block:: shell
|
|
|
|
ytdl-sub sub
|