746370ef9a
* docs(quick): Stale Sphinx ref link target name Not sure how I missed this in my local testing, but this should have been a part a previous PR. Refs #1304 * docs(usage): Stale CLI options help output From [merged PR feedback](https://github.com/jmbannon/ytdl-sub/pull/1305#discussion_r2304503286). Refs #1305
73 lines
3.1 KiB
ReStructuredText
73 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:subscriptions 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 :ref:`to avoid repeating downloads and to
|
|
minimize requests <guides/getting_started/index:minimize the work to only what's
|
|
necessary>`.
|
|
|
|
#. Automate downloads:
|
|
|
|
:ref:`Set up ytdl-sub to run periodically
|
|
<guides/getting_started/automating_downloads:docker and unraid>`.
|