diff --git a/docs/images/plex_scanner_agent.png b/docs/images/plex_scanner_agent.png new file mode 100644 index 00000000..49ce6b33 Binary files /dev/null and b/docs/images/plex_scanner_agent.png differ diff --git a/docs/images/unraid_badconsole.png b/docs/images/unraid_badconsole.png new file mode 100644 index 00000000..73cc15a9 Binary files /dev/null and b/docs/images/unraid_badconsole.png differ diff --git a/docs/source/faq/index.rst b/docs/source/faq/index.rst index c728b7ca..489240de 100644 --- a/docs/source/faq/index.rst +++ b/docs/source/faq/index.rst @@ -1,8 +1,8 @@ +=== FAQ === -Since ytdl-sub is relatively new to the public, there has not been many question asked yet. We will update this as -more questions get asked. +Since ytdl-sub is relatively new to the public, there has not been many question asked yet. We will update this as more questions get asked. .. contents:: Frequently Asked Questions :depth: 3 @@ -10,12 +10,25 @@ more questions get asked. How do I... ----------- +...get support or reach out to contribute? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you need support, you can: + +* :ytdl-sub-gh:`Open an issue on GitHub ` + +* `Join our Discord `_ + +If you would like to contribute, we're happy to accept any help, even non-coders! To find out how you can help this project, you can: + +* `Join our Discord `_ and leave a comment in #development with where you think you can assist or what skills you would like to contribute. + +* If you just want to fix one thing, you're welcome to :ytdl-sub-gh:`submit a pull request ` with information on what issue you're resolving and it will be reviewed as soon as possible. + ...download age-restricted YouTube videos? -'''''''''''''''''''''''''''''''''''''''''' -See -`ytdls recommended way `_ -to download your YouTube cookie, then add it to your -`ytdl options `_ section of your config: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +See `yt-dl's recommended way `_ to download your YouTube cookie, then add it to your :ref:`ytdl options ` section of your config: .. code-block:: yaml @@ -23,14 +36,16 @@ to download your YouTube cookie, then add it to your cookiefile: "/path/to/cookies/file.txt" ...automate my downloads? -''''''''''''''''''''''''' -`This part of the wiki `_ shows how to set up ``ytdl-sub`` to run in a cron job within Docker. +~~~~~~~~~~~~~~~~~~~~~~~~~ + +:doc:`This page ` shows how to set up ``ytdl-sub`` to run automatically on various platforms. There is a bug where... ----------------------- ...date_range is not downloading older videos after I changed the range -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Your preset most likely has ``break_on_existing`` set to True, which will stop downloading additional metadata/videos if the video exists in your download archive. Set the following in your config to skip downloading videos that exist instead of stopping altogether. .. code-block:: yaml @@ -38,11 +53,12 @@ Your preset most likely has ``break_on_existing`` set to True, which will stop d ytdl_options: break_on_existing: False -After your download your new date_range duration, re-enable ``break_on_existing`` to speed up successive downloads. +After you download your new date_range duration, re-enable ``break_on_existing`` to speed up successive downloads. ...it is downloading non-English title and description metadata -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -Most likely the video has a non-English language set to its 'native' language. You can tell yt-dlp to explicitly download English metadata using +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Most likely the video has a non-English language set to its 'native' language. You can tell yt-dlp to explicitly download English metadata using. .. code-block:: yaml @@ -53,7 +69,19 @@ Most likely the video has a non-English language set to its 'native' language. Y - "en" ...Plex is not showing my TV shows correctly -'''''''''''''''''''''''''''''''''''''''''''' -Set the following -`Scanner and Agent `_ -for your library. \ No newline at end of file +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Set the following for your ytdl-sub library that has been added to Plex. + +.. figure:: ../../images/plex_scanner_agent.png + :alt: The Plex library editor, under the advanced settings, showing the required options for Plex to show the TV shows correctly. + +**Scanner:** Plex Series Scanner + +**Agent:** Personal Media shows + +**Visibility:** Exclude from home screen and global search + +**Episode sorting:** Library default + +**YES** Enable video preview thumbnails \ No newline at end of file diff --git a/docs/source/guides/install/docker.rst b/docs/source/guides/install/docker.rst index 9c89e9be..04b5e456 100644 --- a/docs/source/guides/install/docker.rst +++ b/docs/source/guides/install/docker.rst @@ -17,14 +17,14 @@ The ``ytdl-sub`` Docker images use :lsio:`LSIO-based images <\ >` and install yt GUI Image --------- -The GUI image uses LSIO's :lsio-gh:`docker-code-server image` for its base image. More info on other code-server environment variables can be found within its documentation. +The GUI image uses LSIO's :lsio-gh:`docker-code-server image <\ >` for its base image. More info on other code-server environment variables can be found within its documentation. -After starting, code-server will be running at http://localhost:8443. Open this page in a browser to access and interact with ``ytdl-sub``. +After starting, the code-server will be running at http://localhost:8443. Open this page in a browser to access and interact with ``ytdl-sub``. Headless Image -------------- -The headless image uses LSIO's :lsio-gh:`docker-baseimage-alpine image` for its base image. Execute the following command to access and interact with ``ytdl-sub``: +The headless image uses LSIO's :lsio-gh:`docker-baseimage-alpine image <\ >` for its base image. Execute the following command to access and interact with ``ytdl-sub``: .. code-block:: bash diff --git a/docs/source/guides/install/unraid.rst b/docs/source/guides/install/unraid.rst index ac979a99..d27535dd 100644 --- a/docs/source/guides/install/unraid.rst +++ b/docs/source/guides/install/unraid.rst @@ -1,3 +1,16 @@ Unraid -------------- -You can install our :unraid:`unraid community apps ` through the `Unraid Community Apps plugin `_. Uses Docker under the hood. \ No newline at end of file +You can install our :unraid:`unraid community apps ` through the `Unraid Community Apps plugin `_. + + +If you installed the ``ytdl-sub-gui`` app, the code-server will be running at http://localhost:8443 (replace ``localhost`` with the IP of the computer running Unraid if you aren't trying to access ``ytdl-sub`` on that computer). Open this page in a browser to access and interact with ``ytdl-sub``. + +If you installed the ``ytdl-sub`` app (headless), open the normal app-specific console to access and interact with ``ytdl-sub``. Once open, you must first run ``su abc -s /bin/bash`` to change to the non-root user. You can confirm that this command worked by running ``whoami`` and verifying that the result is ``abc``. + + +.. warning:: + + If you use the below option to access the ``ytdl-sub`` console, be sure to run ``su abc -s /bin/bash`` first thing. You can confirm that this command worked by running ``whoami`` and verifying that the result is ``abc``. Do **NOT** run ``ytdl-sub`` as the root user! Running as root will set the owner of all modified files to root, which prevents most media managers and players from accessing the files. + + .. figure:: ../../../images/unraid_badconsole.png + :alt: The Unraid community app plugin GUI, with an arrow pointing at the "Console" option in the dropdown after selecting ytdl-sub-gui \ No newline at end of file