From cf25aad71809d0b3179ed7879df6e964bc7c2d54 Mon Sep 17 00:00:00 2001 From: Chaz Larson Date: Tue, 29 Mar 2022 10:30:30 -0500 Subject: [PATCH] Add extra-instance examples to pages. --- docs/config/plex.md | 34 +++++++++++++++++++++++++++++-- docs/config/radarr.md | 38 ++++++++++++++++++++++++++++++++++- docs/config/sonarr.md | 44 ++++++++++++++++++++++++++++++++++++++++- docs/config/tautulli.md | 24 ++++++++++++++++++++++ 4 files changed, 136 insertions(+), 4 deletions(-) diff --git a/docs/config/plex.md b/docs/config/plex.md index 9ada438c..913f8df4 100644 --- a/docs/config/plex.md +++ b/docs/config/plex.md @@ -1,8 +1,8 @@ # Plex Attributes -Configuring [Plex](https://www.plex.tv/) is required in order to connect to your libraries. +Configuring [Plex](https://www.plex.tv/) is required in order to connect to your libraries. -A `plex` mapping can be either in the root of the config file as global mapping for all libraries, or you can specify the `plex` mapping individually per library. +A `plex` mapping can be either in the root of the config file as global mapping for all libraries, or you can specify the `plex` mapping individually per library. Below is a `plex` mapping example and the full set of attributes: ```yaml @@ -27,3 +27,33 @@ plex: * This script can be run on a remote Plex server, but be sure that the `url` provided is publicly addressable, and it's recommended to use `HTTPS`. * If you need help finding your Plex authentication token, please see Plex's [support article](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/). + +# Other examples: + +Specifying a second Plex server for a specific library: + +In this example we have two Plex servers [with the same libraries] and want to add the same collections to each. The second Plex is less responsive, so it needs a higher timeout than the primary one. + +```yaml +libraries: + Movies: + metadata_path: + - file: config/Movies.yml + Movies_on_Second_Plex: + library_name: Movies + metadata_path: + - file: config/Movies.yml + plex: + url: http://plex.boing.bong + token: SOME_TOKEN + timeout: 360 +... +plex: + url: http://plex.bing.bang + token: SOME_TOKEN + timeout: 60 + clean_bundles: false + empty_trash: false + optimize: false +... +``` diff --git a/docs/config/radarr.md b/docs/config/radarr.md index 4779d909..d08f37e6 100644 --- a/docs/config/radarr.md +++ b/docs/config/radarr.md @@ -1,6 +1,6 @@ # Radarr Attributes -Configuring [Radarr](https://radarr.video/) is optional but will allow you to send movies to a Radarr instance when they're found missing while updating a library's collections. +Configuring [Radarr](https://radarr.video/) is optional but will allow you to send movies to a Radarr instance when they're found missing while updating a library's collections. Radarr V2 may work, but it is not supported please upgrade to V3 if you can. @@ -47,3 +47,39 @@ radarr: * You can set most attributes per collection by using the [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition. ![Radarr Details](radarr.png) + +# Other examples: + +Specifying a second Radarr instance for a specific library: + +In this example we have two Radarr instances, standard and 4K. We want to add 4K movies to the 4K Radarr instance with a different root folder and availbility. + +```yaml +libraries: + Movies: + metadata_path: + - file: config/Movies.yml + Movies - 4K: + metadata_path: + - file: config/Movies.yml + radarr: + url: https://radarr-4K.bing.bang + token: SOME_TOKEN + root_folder_path: /movies-4K + availability: cinemas +... +radarr: + url: https://radarr.bing.bang + token: SOME_TOKEN + root_folder_path: /movies + monitor: true + availability: released + quality_profile: Any + tag: + search: false + add_existing: false + radarr_path: + plex_path: + add_missing: true +... +``` diff --git a/docs/config/sonarr.md b/docs/config/sonarr.md index b6efae4b..90b62a66 100644 --- a/docs/config/sonarr.md +++ b/docs/config/sonarr.md @@ -51,5 +51,47 @@ sonarr: * The `quality_profile` and `language_profile` must be the exact name of the desired quality profile, including all spaces and capitalization. * You can set most attributes per collection by using the [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition. - + ![Sonarr Details](sonarr.png) + +# Other examples: + +Specifying a second Sonarr instance for a specific library: + +In this example we have two Sonarr instances, standard and 4K. We want to add 4K shows to the 4K Sonarr instance with a different root folder and quality profile. Also, shows are being added to the "TV Shows - 4K" library outside Sonarr via a custom script and I want those new shows added to Sonarr for tracking. + +```yaml +libraries: + TV Shows: + metadata_path: + - file: config/TV.yml + TV Shows - 4K: + metadata_path: + - file: config/TV.yml + sonarr: + url: https://sonarr-4K.bing.bang + token: SOME_TOKEN + root_folder_path: /shows-4K + quality_profile: 4K + add_existing: true + sonarr_path: /shows-4K + plex_path: /mnt/unionfs/Media/TV +... +sonarr: + url: https://sonarr.bing.bang + token: SOME_TOKEN + add_missing: false + add_existing: false + root_folder_path: /shows + monitor: all + quality_profile: HD-1080p + language_profile: English + series_type: standard + season_folder: true + tag: + search: false + cutoff_search: false + sonarr_path: + plex_path: +... +``` diff --git a/docs/config/tautulli.md b/docs/config/tautulli.md index cabaa417..49429a13 100644 --- a/docs/config/tautulli.md +++ b/docs/config/tautulli.md @@ -18,3 +18,27 @@ tautulli: | `apikey` | Tautulli API Key | N/A | ✅ | * The apikey can be found by going to Tautulli > Settings > Web Interface > API > API Key + +# Other examples: + +Specifying a second Tautulli instance for a specific library: + +In this example we have a separate Tautulli instance for TV. + +```yaml +libraries: + Movies: + metadata_path: + - file: config/Movies.yml + TV Shows: + metadata_path: + - file: config/TV.yml + tautulli: + url: http://192.168.1.14:8659 + apikey: SOME_KEY +... +tautulli: + url: http://192.168.1.12:8659 + apikey: SOME_KEY +... +``` \ No newline at end of file