e1f81e5274
* docs(config): Clarify preset ordering priority Refs #1276 * docs(architecture): WIP Narrative how it works Much of this is repetition of the reference docs and some of the changes here should also be applied here. The goal is to repeat here the parts of the reference docs that may hang up a user when reading "Getting Started" without sending them off to get lost in the weeds of the reference docs. Note that this references a `Quick Start` document which is just an empty placeholder and is to be written in a subsequent change. Fixes #1279 * docs(terms): Glossary redundant with architecture Now that the introduction includes an architectural overview, that section introduces new users to necessary concepts and associated terminology and makes the terminology section redundant in that part of the docs. * docs(quick): Add a rote quick start guide This is what I came up with when I tried to write instructions requiring as little understanding as possible. Doing so really did reinforce my impression that this just shouldn't be done, that significant understanding is required for *any* use of ytdl-sub and even offering a quick start may be irresponsible. I'm still on the fence, thoughts? That said, I also think I got some good explanations out of this and a better understanding of what the next bits of the Getting Started should be. This Quick Start is currently redundant with other parts of the Getting Started pages. I suspect that I'll end up repeating and/or reorganizing parts of this Quick Start into the next bits of the Getting Started. To that end I might argue that this change is a WIP and that merging should wait. But I could also argue that this is an incremental improvement and can be merged before that other work. Your call. * docs(start): Various rST/Sphinx markup issues
72 lines
3.1 KiB
ReStructuredText
72 lines
3.1 KiB
ReStructuredText
Quick Start
|
|
===========
|
|
|
|
:ref:`Again <guides/getting_started/index:prerequisite knowledge>`, if the following
|
|
serves all your needs, then you're probably better off with :ref:`one of the more
|
|
user-friendly yt-dlp wrappers available <introduction:motivation>`. If you still want to
|
|
get ``ytdl-sub`` up and running quickly and without understanding, then follow these
|
|
instructions to the letter.
|
|
|
|
#. Install using :ref:`the official Docker GUI image variant <guides/install/docker:gui
|
|
image>`.
|
|
|
|
#. Update the paths for your media library:
|
|
|
|
Edit :ref:`the subscriptions file <guides/install/docker:configuration>`. Near the
|
|
top, under ``__preset__:`` and then ``overrides:``, update the values under the
|
|
``*_directory:`` keys with the correct paths for your media library *as they appear
|
|
inside the container*.
|
|
|
|
#. Select your media library software:
|
|
|
|
Change the ``Plex TV Show by Date:`` *key itself* to the preset for your media
|
|
library software. See the comment above for the available options.
|
|
|
|
#. Select the genre:
|
|
|
|
Under the library software preset key from the previous step, change the ``=
|
|
Documentaries`` *key itself* to the genre for this subscription prefixed with ``=
|
|
...``. When adding other subscriptions that have the same genre, place them under the
|
|
same key.
|
|
|
|
#. Update the subscription name and URL:
|
|
|
|
Under the genre key from the previous step, update the ``"NOVA PBS":`` key to the
|
|
directory name the downloaded files should be placed beneath. This directory will be
|
|
created under the ``tv_show_directory:`` from step #2. Then update the
|
|
``"https://www.youtube.com/@novapbs"`` value to the URL of the channel or playlist
|
|
for this subscription.
|
|
|
|
#. Preview what ``ytdl-sub`` would do for this subscription:
|
|
|
|
Run the :ref:`'sub' sub-command <usage:sub options>` but with the ``max_downloads``
|
|
setting from ``yt-dlp`` along with the ``--dry-run`` and ``--match`` options from
|
|
``ytdl-sub`` to minimize requests and prevent actual downloads. Be sure to update the
|
|
``--match="..."`` value with the subscription name::
|
|
|
|
$ ytdl-sub --dry-run sub -o '--ytdl_options.max_downloads 3' --match="NOVA PBS"
|
|
|
|
Examine the output carefully.
|
|
|
|
#. Review the results of real downloads:
|
|
|
|
Run it again without the ``--dry-run`` option to actually download media and place
|
|
the files in your library::
|
|
|
|
$ ytdl-sub sub -o '--ytdl_options.max_downloads 3' --match="NOVA PBS"
|
|
|
|
Examine the output carefully, then examine how the downloads work in your
|
|
library. Repeat with a larger value for ``max_downloads`` and examine the output and
|
|
downloads again.
|
|
|
|
#. Add the rest of your subscriptions:
|
|
|
|
Repeat steps #4-7 for each of your subscriptions. Be sure to repeat the preview and
|
|
review steps for each subscription. In general, move slowly and carefully review
|
|
everything. It's best to catch issues early to avoid repeating downloads and to
|
|
minimize requests to avoid being throttled or banned by servers.
|
|
|
|
#. Automate downloads:
|
|
|
|
:ref:`Set up ytdl-sub to run periodically
|
|
<guides/getting_started/automating_downloads:docker and unraid>`.
|