Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-26 06:20:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

[192] fix dead wiki links

Browse source
This commit is contained in:
meisnate12 2022-11-08 16:48:52 -05:00
parent becd838eae
commit 747f5d42b7
10 changed files with 204 additions and 228 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
VERSION
View file

@ -1 +1 @@
1.17.3-develop191 1.17.3-develop192

64
docs/_templates/navbar.html vendored
View file

@ -22,66 +22,66 @@
<div class="collapse navbar-collapse nav-collapse"> <div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav"> <ul class="nav navbar-nav">
{% if theme_navbar_links %} {% if theme_navbar_links %}
{%- for link in theme_navbar_links %} {%- for menu in theme_navbar_links %}
{% if link[0] == "_menu" %} {% if menu[0] == "_menu" %}
<li class="dropdown"> <li class="dropdown">
<a role="button" id="{{ link[1] }}Toc" data-toggle="dropdown" data-target="#" href="#" aria-expanded="false">{{ link[1] }} <b class="caret"></b></a> <a role="button" id="{{ menu[1] }}Toc" data-toggle="dropdown" data-target="#" href="#" aria-expanded="false">{{ menu[1] }} <b class="caret"></b></a>
<ul class="dropdown-menu multi-level" role="menu" aria-labelledby="{{ link[1] }}Toc"> <ul class="dropdown-menu multi-level" role="menu" aria-labelledby="{{ menu[1] }}Toc">
{%- for sublink in link[2] %} {%- for link in menu[2] %}
{% if sublink[0] == "_divider" %} {% if link[0] == "_divider" %}
<li class="divider"></li> <li class="divider"></li>
{% elif sublink[0] == "_menu" %} {% elif link[0] == "_menu" %}
<li class="dropdown-submenu"> <li class="dropdown-submenu">
{% if sublink|length == 4 %} {% if link|length == 4 %}
<a tabindex="-1" href="{{ pathto(sublink[2]) }}">{{ sublink[1] }}</a> <a tabindex="-1" href="{{ pathto(link[2]) }}">{{ link[1] }}</a>
{% elif sublink|length == 5 %} {% elif link|length == 5 %}
<a tabindex="-1" href="{{ pathto(sublink[2]) }}{{ sublink[3] }}">{{ sublink[1] }}</a> <a tabindex="-1" href="{{ pathto(link[2]) }}{{ link[3] }}">{{ link[1] }}</a>
{% else %} {% else %}
<a tabindex="-1" href="#">{{ sublink[1] }}</a> <a tabindex="-1" href="#">{{ link[1] }}</a>
{% endif %} {% endif %}
<ul class="dropdown-menu"> <ul class="dropdown-menu">
{%- for subsublink in sublink[-1] %} {%- for sublink in link[-1] %}
{% if subsublink[0] == "_divider" %} {% if sublink[0] == "_divider" %}
<li class="divider"></li> <li class="divider"></li>
{% elif subsublink[0] == "_menu" %} {% elif sublink[0] == "_menu" %}
<li class="dropdown-submenu"> <li class="dropdown-submenu">
{% if subsublink|length == 4 %} {% if sublink|length == 4 %}
<a tabindex="-1" href="{{ pathto(subsublink[2]) }}">{{ subsublink[1] }}</a> <a tabindex="-1" href="{{ pathto(sublink[2]) }}">{{ sublink[1] }}</a>
{% elif subsublink|length == 5 %} {% elif sublink|length == 5 %}
<a tabindex="-1" href="{{ pathto(subsublink[2]) }}{{ subsublink[3] }}">{{ subsublink[1] }}</a> <a tabindex="-1" href="{{ pathto(sublink[2]) }}{{ sublink[3] }}">{{ sublink[1] }}</a>
{% else %} {% else %}
<a tabindex="-1" href="#">{{ subsublink[1] }}</a> <a tabindex="-1" href="#">{{ sublink[1] }}</a>
{% endif %} {% endif %}
<ul class="dropdown-menu"> <ul class="dropdown-menu">
{%- for subsubsublink in subsublink[-1] %} {%- for specificlink in sublink[-1] %}
{% if subsubsublink[0] == "_divider" %} {% if specificlink[0] == "_divider" %}
<li class="divider"></li> <li class="divider"></li>
{% elif subsubsublink|length > 2 %} {% elif specificlink|length > 2 %}
<li><a href="{{ pathto(subsubsublink[1]) }}{{ subsubsublink[2] }}">{{ subsubsublink[0] }}</a></li> <li><a href="{{ pathto(specificlink[1]) }}{{ specificlink[2] }}">{{ specificlink[0] }}</a></li>
{% else %} {% else %}
<li><a href="{{ pathto(subsubsublink[1]) }}">{{ subsubsublink[0] }}</a></li> <li><a href="{{ pathto(specificlink[1]) }}">{{ specificlink[0] }}</a></li>
{% endif %} {% endif %}
{%- endfor %} {%- endfor %}
</ul> </ul>
</li> </li>
{% elif subsublink|length > 2 %} {% elif sublink|length > 2 %}
<li><a href="{{ pathto(subsublink[1]) }}{{ subsublink[2] }}">{{ subsublink[0] }}</a></li> <li><a href="{{ pathto(sublink[1]) }}{{ sublink[2] }}">{{ sublink[0] }}</a></li>
{% else %} {% else %}
<li><a href="{{ pathto(subsublink[1]) }}">{{ subsublink[0] }}</a></li> <li><a href="{{ pathto(sublink[1]) }}">{{ sublink[0] }}</a></li>
{% endif %} {% endif %}
{%- endfor %} {%- endfor %}
</ul> </ul>
</li> </li>
{% elif sublink|length > 2 %} {% elif link|length > 2 %}
<li><a href="{{ pathto(sublink[1]) }}{{ sublink[2] }}">{{ sublink[0] }}</a></li> <li><a href="{{ pathto(link[1]) }}{{ link[2] }}">{{ link[0] }}</a></li>
{% else %} {% else %}
<li><a href="{{ pathto(sublink[1]) }}">{{ sublink[0] }}</a></li> <li><a href="{{ pathto(link[1]) }}">{{ link[0] }}</a></li>
{% endif %} {% endif %}
{%- endfor %} {%- endfor %}
</ul> </ul>
</li> </li>
{% else %} {% else %}
<li><a href="{{ pathto(*link[1:]) }}">{{ link[0] }}</a></li> <li><a href="{{ pathto(*menu[1:]) }}">{{ menu[0] }}</a></li>
{% endif %} {% endif %}
{%- endfor %} {%- endfor %}
{% endif %} {% endif %}

2
docs/config/paths.md
View file

@ -153,7 +153,7 @@ Within the above example, PMM will:
## Playlist Files ## Playlist Files
The [`playlist_files`](libraries.md#playlist-files-attribute) at the top level in your [Configuration File](configuration). The [`playlist_files`](playlists) at the top level in your [Configuration File](configuration).
### Example ### Example

34
docs/config/radarr.md
View file

@ -25,27 +25,27 @@ radarr:
plex_path: /share/CACHEDEV1_DATA/Multimedia plex_path: /share/CACHEDEV1_DATA/Multimedia
``` ```
| Attribute | Allowed Values | Default | Required | | Attribute | Allowed Values | Default | Required |
|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------:|:--------:| |:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------:|:--------:|
| `url` | Radarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; | | `url` | Radarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; |
| `token` | Radarr API Token. | N/A | &#9989; | | `token` | Radarr API Token. | N/A | &#9989; |
| `add_missing` | Adds all missing movies found from all collections to Radarr.<br>Use the `radarr_add_missing` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; | | `add_missing` | Adds all missing movies found from all collections to Radarr.<br>Use the `radarr_add_missing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; |
| `add_existing` | Adds all existing movies in collections to Radarr.<br>Use the `radarr_add_existing` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; | | `add_existing` | Adds all existing movies in collections to Radarr.<br>Use the `radarr_add_existing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; |
| `upgrade_existing` | Upgrades all existing movies in collections to match the Quality Profile of the collection.<br>Use the `radarr_upgrade_existing` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; | | `upgrade_existing` | Upgrades all existing movies in collections to match the Quality Profile of the collection.<br>Use the `radarr_upgrade_existing` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; |
| `root_folder_path` | Default Root Folder Path to use when adding new movies.<br>Use the `radarr_folder` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to set the Root Folder per collection. | N/A | &#9989; | | `root_folder_path` | Default Root Folder Path to use when adding new movies.<br>Use the `radarr_folder` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | &#9989; |
| `monitor` | Monitor the movie when adding new movies.<br>Use the `radarr_monitor` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to set the Monitor value per collection. | true | &#10060; | | `monitor` | Monitor the movie when adding new movies.<br>Use the `radarr_monitor` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Monitor value per collection. | true | &#10060; |
| `availability` | Default Minimum Availability to use when adding new movies.<br>Use the `radarr_availability` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to set the Availability per collection.<br>**Options:** `announced`, `cinemas`, `released`, `db` | `announced` | &#9989; | | `availability` | Default Minimum Availability to use when adding new movies.<br>Use the `radarr_availability` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Availability per collection.<br>**Options:** `announced`, `cinemas`, `released`, `db` | `announced` | &#9989; |
| `quality_profile` | Default Quality Profile to use when adding new movies.<br>Use the `radarr_quality` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to set the Quality Profile per collection. | N/A | &#10060; | | `quality_profile` | Default Quality Profile to use when adding new movies.<br>Use the `radarr_quality` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | &#10060; |
| `tag` | Default this list or comma-separated string of tags to use when adding new movies.<br>Use the `radarr_tag` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to set the Tags per collection. | ` ` | &#10060; | | `tag` | Default this list or comma-separated string of tags to use when adding new movies.<br>Use the `radarr_tag` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the Tags per collection. | ` ` | &#10060; |
| `search` | Start search for missing movie when adding new movies.<br>Use the `radarr_search` [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; | | `search` | Start search for missing movie when adding new movies.<br>Use the `radarr_search` [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `plex_path` | When using `add_existing` or `radarr_add_all` Convert this part of the path to `radarr_path`. | ` ` | &#10060; | | `plex_path` | When using `add_existing` or `radarr_add_all` Convert this part of the path to `radarr_path`. | ` ` | &#10060; |
| `radarr_path` | When using `add_existing` or `radarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; | | `radarr_path` | When using `add_existing` or `radarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; |
* The `token` can be found by going to `Radarr > Settings > General > Security > API Key` * The `token` can be found by going to `Radarr > Settings > General > Security > API Key`
* The `quality_profile` must be the exact name of the desired quality profile, including all spaces and capitalization. * The `quality_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 [Radarr Details](../metadata/details/arr.md#radarr-details) in the collection definition. * You can set most attributes per collection by using the [Radarr Details](../metadata/details/arr.md#radarr-definition-settings) in the collection definition.
![Radarr Details](radarr.png) ![Radarr Details](radarr.png)
@ -53,7 +53,7 @@ radarr:
Specifying a second Radarr instance for a specific library: 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. 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 availability.
```yaml ```yaml
libraries: libraries:

38
docs/config/sonarr.md
View file

@ -28,30 +28,30 @@ sonarr:
plex_path: /share/CACHEDEV1_DATA/Multimedia plex_path: /share/CACHEDEV1_DATA/Multimedia
``` ```
| Attribute | Allowed Values | Default | Required | | Attribute | Allowed Values | Default | Required |
|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------:|:--------:| |:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------:|:--------:|
| `url` | Sonarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; | | `url` | Sonarr URL (Including URL Base if set).<br>**Example:** http://192.168.1.12:32788 | N/A | &#9989; |
| `token` | Sonarr API Token. | N/A | &#9989; | | `token` | Sonarr API Token. | N/A | &#9989; |
| `add_missing` | Adds all missing shows found from all collections to Sonarr.<br>Use the `sonarr_add_missing` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; | | `add_missing` | Adds all missing shows found from all collections to Sonarr.<br>Use the `sonarr_add_missing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to add missing per collection.<br>**boolean:** true or false | false | &#10060; |
| `add_existing` | Adds all existing shows in collections to Sonarr.<br>Use the `sonarr_add_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; | | `add_existing` | Adds all existing shows in collections to Sonarr.<br>Use the `sonarr_add_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to add existing per collection.<br>**boolean:** true or false | false | &#10060; |
| `upgrade_existing` | Upgrades all existing shows in collections to match the Quality Profile of the collection.<br>Use the `sonarr_upgrade_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; | | `upgrade_existing` | Upgrades all existing shows in collections to match the Quality Profile of the collection.<br>Use the `sonarr_upgrade_existing` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to upgrade the Quality Profile per collection.<br>**boolean:** true or false | false | &#10060; |
| `root_folder_path` | Default Root Folder Path to use when adding new shows.<br>Use the `sonarr_folder` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the Root Folder per collection. | N/A | &#9989; | | `root_folder_path` | Default Root Folder Path to use when adding new shows.<br>Use the `sonarr_folder` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Root Folder per collection. | N/A | &#9989; |
| `monitor` | Default Monitor to use when adding new shows.<br>Use the `sonarr_monitor` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the Monitor value per collection.<br>**Values:** <table class="clearTable"><tr><td>`all`</td><td>All episodes except specials</td></tr><tr><td>`future`</td><td>Episodes that have not aired yet</td></tr><tr><td>`missing`</td><td>Episodes that do not have files or have not aired yet</td></tr><tr><td>`existing`</td><td>Episodes that have files or have not aired yet</td></tr><tr><td>`pilot`</td><td>The first episode, all others will be ignored</td></tr><tr><td>`first`</td><td>All episodes of the first season, all others will be ignored</td></tr><tr><td>`latest`</td><td>All episodes of the latest season and future seasons</td></tr><tr><td>`none`</td><td>No episodes</td></tr></table> | `all` | &#10060; | | `monitor` | Default Monitor to use when adding new shows.<br>Use the `sonarr_monitor` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Monitor value per collection.<br>**Values:** <table class="clearTable"><tr><td>`all`</td><td>All episodes except specials</td></tr><tr><td>`future`</td><td>Episodes that have not aired yet</td></tr><tr><td>`missing`</td><td>Episodes that do not have files or have not aired yet</td></tr><tr><td>`existing`</td><td>Episodes that have files or have not aired yet</td></tr><tr><td>`pilot`</td><td>The first episode, all others will be ignored</td></tr><tr><td>`first`</td><td>All episodes of the first season, all others will be ignored</td></tr><tr><td>`latest`</td><td>All episodes of the latest season and future seasons</td></tr><tr><td>`none`</td><td>No episodes</td></tr></table> | `all` | &#10060; |
| `quality_profile` | Default Quality Profile to use when adding new shows.<br>Use the `sonarr_quality` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the Quality Profile per collection. | N/A | &#9989; | | `quality_profile` | Default Quality Profile to use when adding new shows.<br>Use the `sonarr_quality` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Quality Profile per collection. | N/A | &#9989; |
| `language_profile` | Default Language Profile to use when adding new shows.<br>Use the `sonarr_language` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the Language Profile per collection. | First Profile | &#10060; | | `language_profile` | Default Language Profile to use when adding new shows.<br>Use the `sonarr_language` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Language Profile per collection. | First Profile | &#10060; |
| `series_type` | Default Series Type to use when adding new shows.<br>Use the `sonarr_series` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the Series Type per collection.<br>**Values:** <table class="clearTable"><tr><td>`standard`</td><td>Episodes released with SxxEyy pattern</td></tr><tr><td>`daily`</td><td>Episodes released daily that use year-month-day pattern (2017-05-25)</td></tr><tr><td>`anime`</td><td>Episodes released using an absolute episode number</td></tr></table>`standard`: Episodes released with SxxEyy pattern<br>`daily`: Episodes released daily or less frequently that use year-month-day (2017-05-25)<br>`anime`: Episodes released using an absolute episode number | `standard` | &#10060; | | `series_type` | Default Series Type to use when adding new shows.<br>Use the `sonarr_series` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the Series Type per collection.<br>**Values:** <table class="clearTable"><tr><td>`standard`</td><td>Episodes released with SxxEyy pattern</td></tr><tr><td>`daily`</td><td>Episodes released daily that use year-month-day pattern (2017-05-25)</td></tr><tr><td>`anime`</td><td>Episodes released using an absolute episode number</td></tr></table>`standard`: Episodes released with SxxEyy pattern<br>`daily`: Episodes released daily or less frequently that use year-month-day (2017-05-25)<br>`anime`: Episodes released using an absolute episode number | `standard` | &#10060; |
| `season_folder` | Use the Season Folder Option when adding new shows.<br>Use the `sonarr_season` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the season folder value per collection. <br>**boolean:** true or false | true | &#10060; | | `season_folder` | Use the Season Folder Option when adding new shows.<br>Use the `sonarr_season` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the season folder value per collection. <br>**boolean:** true or false | true | &#10060; |
| `tag` | Default this list or comma-separated string of tags to use when adding new shows.<br>Use the `sonarr_tag` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the tags per collection. | ` ` | &#10060; | | `tag` | Default this list or comma-separated string of tags to use when adding new shows.<br>Use the `sonarr_tag` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the tags per collection. | ` ` | &#10060; |
| `search` | Start search for missing episodes when adding new shows.<br>Use the `sonarr_search` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; | | `search` | Start search for missing episodes when adding new shows.<br>Use the `sonarr_search` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `cutoff_search` | Start search for cutoff unmet episodes when adding new shows.<br>Use the `sonarr_cutoff_search` [Sonarr Details](../metadata/details/arr.md#sonarr-details) in the collection definition to set the cutoff search value per collection.<br>**boolean:** true or false | false | &#10060; | | `cutoff_search` | Start search for cutoff unmet episodes when adding new shows.<br>Use the `sonarr_cutoff_search` [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition to set the cutoff search value per collection.<br>**boolean:** true or false | false | &#10060; |
| `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path`. | ` ` | &#10060; | | `plex_path` | When using `add_existing` or `sonarr_add_all` Convert this part of the path to `sonarr_path`. | ` ` | &#10060; |
| `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; | | `sonarr_path` | When using `add_existing` or `sonarr_add_all` Convert the `plex_path` part of the path to this. | ` ` | &#10060; |
* The `token` can be found by going to `Sonarr > Settings > General > Security > API Key` * The `token` can be found by going to `Sonarr > Settings > General > Security > API Key`
* The `quality_profile` and `language_profile` must be the exact name of the desired quality profile, including all spaces and capitalization. * 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. * You can set most attributes per collection by using the [Sonarr Details](../metadata/details/arr.md#sonarr-definition-settings) in the collection definition.
![Sonarr Details](sonarr.png) ![Sonarr Details](sonarr.png)

6
docs/defaults/overlays.md
View file

@ -196,7 +196,7 @@ libraries:
## Rating Overlays ## Rating Overlays
By default for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata. By default, for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata.
**Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library** **Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library**
@ -210,7 +210,7 @@ Plex has three available spots in the Plex DB to store ratings and thus Plex Met
To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb. To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb.
**mass_*_rating_update** sources can be found here: [operations](../../config/operations) **mass_*_rating_update** sources can be found here: [operations](../config/operations)
![](images/ratings_operations.png) ![](images/ratings_operations.png)
@ -233,7 +233,7 @@ libraries:
overlay_level: episode overlay_level: episode
``` ```
Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: ratings` has a page [here](ratings). Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: ratings` has a page [here](overlays/ratings).
**In addition to the defined `template_variables` almost all default Overlay files have access to the [Shared Variables](collection_variables).** **In addition to the defined `template_variables` almost all default Overlay files have access to the [Shared Variables](collection_variables).**

278
docs/home/kb.md
View file

@ -8,146 +8,118 @@ This sections aims to answer the most commonly asked questions that users have.
### "How do I update to the latest version of Plex Meta Manager?" ### "How do I update to the latest version of Plex Meta Manager?"
<details> [type this into your terminal]
<summary>OS X/Linux</summary>
<br />
[type this into your terminal] ````{tab} OS X/Linux
<br/>
``` ```
cd /Users/mroche/Plex-Meta-Manager cd /Users/mroche/Plex-Meta-Manager
git pull git pull
source pmm-venv/bin/activate source pmm-venv/bin/activate
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
``` ```
</details> <br/>
````
<details> ````{tab} Windows:
<summary>Windows</summary> ```
<br /> cd C:\Users\mroche\Plex-Meta-Manager
git pull
[type this into your terminal] .\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
``` ```
cd C:\Users\mroche\Plex-Meta-Manager <br/>
git pull ````
.\pmm-venv\Scripts\activate ````{tab} Docker:
python -m pip install -r requirements.txt ```
``` docker pull meisnate12/plex-meta-manager
</details> ```
<br/>
<details> ````
<summary>Docker</summary>
<br />
[type this into your terminal]
```
docker pull meisnate12/plex-meta-manager
```
</details>
### "How do I switch to the develop branch?" ### "How do I switch to the develop branch?"
<details> [type this into your terminal]
<summary>OS X/Linux</summary>
<br />
[type this into your terminal] ````{tab} OS X/Linux
<br/>
``` ```
cd /Users/mroche/Plex-Meta-Manager cd /Users/mroche/Plex-Meta-Manager
git checkout develop git checkout develop
git pull git pull
source pmm-venv/bin/activate source pmm-venv/bin/activate
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
``` ```
</details> <br/>
````
<details> ````{tab} Windows:
<summary>Windows</summary> ```
<br /> cd C:\Users\mroche\Plex-Meta-Manager
git checkout develop
[type this into your terminal] git pull
.\pmm-venv\Scripts\activate
``` python -m pip install -r requirements.txt
cd C:\Users\mroche\Plex-Meta-Manager ```
git checkout develop <br/>
git pull ````
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
</details>
### "How do I switch to the nightly branch" ### "How do I switch to the nightly branch"
<details> [type this into your terminal]
<summary>OS X/Linux</summary>
<br />
[type this into your terminal] ````{tab} OS X/Linux
<br/>
``` ```
cd /Users/mroche/Plex-Meta-Manager cd /Users/mroche/Plex-Meta-Manager
git checkout nightly git checkout nightly
git pull git pull
source pmm-venv/bin/activate source pmm-venv/bin/activate
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
``` ```
</details> <br/>
````
<details> ````{tab} Windows:
<summary>Windows</summary> ```
<br /> cd C:\Users\mroche\Plex-Meta-Manager
git checkout nightly
[type this into your terminal] git pull
.\pmm-venv\Scripts\activate
``` python -m pip install -r requirements.txt
cd C:\Users\mroche\Plex-Meta-Manager ```
git checkout nightly <br/>
git pull ````
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
</details>
### "How do I switch back to the master branch?" ### "How do I switch back to the master branch?"
<details> [type this into your terminal]
<summary>OS X/Linux</summary>
<br />
[type this into your terminal] ````{tab} OS X/Linux
<br/>
``` ```
cd /Users/mroche/Plex-Meta-Manager cd /Users/mroche/Plex-Meta-Manager
git checkout master git checkout master
git pull git pull
source pmm-venv/bin/activate source pmm-venv/bin/activate
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
``` ```
</details> <br/>
````
<details> ````{tab} Windows:
<summary>Windows</summary> ```
<br /> cd C:\Users\mroche\Plex-Meta-Manager
git checkout master
[type this into your terminal] git pull
.\pmm-venv\Scripts\activate
``` python -m pip install -r requirements.txt
cd C:\Users\mroche\Plex-Meta-Manager ```
git checkout master <br/>
git pull ````
.\pmm-venv\Scripts\activate
python -m pip install -r requirements.txt
```
</details>
## Knowledgebase ## Knowledgebase
This section aims to provide some guidance on the most common issues that we see. This section aims to provide some guidance on the most common issues that we see.
### Locating Log Files ### Locating Log Files
The meta.log file can be found within the `logs` folder of your Plex Meta Manager config folder [right next to `config.yml`]. The meta.log file can be found within the `logs` folder of your Plex Meta Manager config folder [right next to `config.yml`].
`meta.log` is the most recent run of Plex Meta Manager, `meta.log.1` is the previous run, `meta.log.2` is the run before that, so on and so forth. `meta.log` is the most recent run of Plex Meta Manager, `meta.log.1` is the previous run, `meta.log.2` is the run before that, so on and so forth.
@ -157,15 +129,16 @@ Wondering how to troubleshoot Plex Meta Manager and how to read through the meta
**Using a text editor like [Visual Studio Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/) is recommended** **Using a text editor like [Visual Studio Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/) is recommended**
In all cases, the first step is to open the [`meta.log`](#meta.log-location) with your text editor and perform these steps: In all cases, the first step is to open the [`meta.log`](#locating-log-files) with your text editor and perform these steps:
1. Check that you are running the latest [`version`](#plex-meta-manager-version) of your branch. Your current version can be found in the `meta.log` file either below the Plex Meta Manager ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](https://metamanager.wiki/en/nightly/home/guides/local.html?highlight=upgrade#i-want-to-update-to-the-latest-version-of-pmm) to the latest version of Plex Meta Manager. 1. Check that you are running the latest [`version`](#checking-plex-meta-manager-version) of your branch. Your current version can be found in the `meta.log` file either below the Plex Meta Manager ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](../home/guides/local.md#i-want-to-update-to-the-latest-version-of-pmm) to the latest version of Plex Meta Manager.
2. When scanning your meta.log file, search for `[CRITICAL]` items first as these will definitely need to be fixed 2. When scanning your meta.log file, search for `[CRITICAL]` items first as these will definitely need to be fixed
3. Scan your meta.log file for `[ERROR]` and make a note of the content of the full line to start your search below on how to resolve 3. Scan your meta.log file for `[ERROR]` and make a note of the content of the full line to start your search below on how to resolve
### Checking Plex Meta Manager Version ### Checking Plex Meta Manager Version
Checking the version: You will find that in your [`meta.log`](#meta.log-location) around the 8th-10th line and will look something like this:
Checking the version: You will find that in your [`meta.log`](#locating-log-files) around the 8th-10th line and will look something like this:
``` ```
| | | |
| Version: 1.17.1-develop10 | | Version: 1.17.1-develop10 |
@ -180,6 +153,7 @@ If you are not on the latest version of your branch, you will see Newest Version
``` ```
### Understanding Log File Event Types ### Understanding Log File Event Types
There are five main event types that you need to be aware of when understanding the log files, detailed below: There are five main event types that you need to be aware of when understanding the log files, detailed below:
| Type | Short Info | Description | Recommendation | | Type | Short Info | Description | Recommendation |
@ -193,49 +167,51 @@ There are five main event types that you need to be aware of when understanding
### Common Log File Messages ### Common Log File Messages
This section aims to explain some of the commonly seen event messages that are produced in the logs. This section aims to explain some commonly seen event messages that are produced in the logs.
#### CRITICAL #### CRITICAL
This table details examples of the most commonly-seen `[CRITICAL]` events and what they mean for the user. This table details examples of the most commonly-seen `[CRITICAL]` events and what they mean for the user.
| Type | Short Info | Description | Recommendation | | Type | Short Info | Description | Recommendation |
|:-------------|:------------------------------------------------------------------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-------------:|:----------------------------------------------------|:------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------|
| `[CRITICAL]` | `Failed to Connect to https://api.themoviedb.org/3` | Current step PMM was on made an API call to TMDb, but it aborted and moved on | Determine if TMDb was offline and not replying to api requests. Try again and see if it fails again or not. | | | `[CRITICAL]` | `Failed to Connect to https://api.themoviedb.org/3` | Current step PMM was on made an API call to TMDb, but it aborted and moved on | Determine if TMDb was offline and not replying to api requests. Try again and see if it fails again or not. | |
#### ERROR #### ERROR
| Type | Short Info | Description | Recommendation | | Type | Short Info | Description | Recommendation |
|:-------------|:------------------------------------------------------------------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:----------:|:------------------------------------------------------------------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[ERROR]` | `Playlist Error: Library: XYZ not defined` | Plex library XYZ is not found | Ensure that your config file has defined the proper library name as found in Plex | | `[ERROR]` | `Playlist Error: Library: XYZ not defined` | Plex library XYZ is not found | Ensure that your config file has defined the proper library name as found in Plex |
| `[ERROR]` | `Plex Error: resolution: No matches found with regex pattern XYZ` | While looking for a pattern in Plex, this one was not found | This may be normal and require 0 actions. However, if you expect that Plex should have returned records, check the pattern to ensure it is working properly | | `[ERROR]` | `Plex Error: resolution: No matches found with regex pattern XYZ` | While looking for a pattern in Plex, this one was not found | This may be normal and require 0 actions. However, if you expect that Plex should have returned records, check the pattern to ensure it is working properly |
| `[ERROR]` | `Plex Error: No Items found in Plex` | While using the PMM builder, no items with that criteria were returned from Plex | This may be normal and require 0 actions. However, if you expect that Plex should have returned records, check the builder to ensure it is working properly | | `[ERROR]` | `Plex Error: No Items found in Plex` | While using the PMM builder, no items with that criteria were returned from Plex | This may be normal and require 0 actions. However, if you expect that Plex should have returned records, check the builder to ensure it is working properly |
| `[ERROR]` | `IMDb Error: Failed to parse URL:` | While using the PMM builder, url does not exist | This may be normal and require 0 actions. However, if you expect that the URL should have returned records, check the url in your browser to ensure it is working properly | | `[ERROR]` | `IMDb Error: Failed to parse URL:` | While using the PMM builder, url does not exist | This may be normal and require 0 actions. However, if you expect that the URL should have returned records, check the url in your browser to ensure it is working properly |
| `[ERROR]` | `Trakt Error: No TVDb ID found for Nightfall (2022)` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. For example, at the time of that error, the Trakt record for "Nightfall (2022)" didn't contain a TVDb ID. This could be because the record just hasn't been updated, or because "Nightfall (2022)" isn't listed on TVDb. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. | | `[ERROR]` | `Trakt Error: No TVDb ID found for Nightfall (2022)` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. For example, at the time of that error, the Trakt record for "Nightfall (2022)" didn't contain a TVDb ID. This could be because the record just hasn't been updated, or because "Nightfall (2022)" isn't listed on TVDb. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. |
| `[ERROR]` | `MdbList Error: Not Found` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. For example, at the time of that error, the the MDBlist record was trying to get a rating for a media item and could not find it. | | `[ERROR]` | `MdbList Error: Not Found` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. For example, at the time of that error, the the MDBlist record was trying to get a rating for a media item and could not find it. |
| `[ERROR]` | `Plex Error: actor: Mel B not found` | Actor not found and hence unable to create the collection | Report error in #pmm-support channel and see if there is a fix. | | `[ERROR]` | `Plex Error: actor: Mel B not found` | Actor not found and hence unable to create the collection | Report error in #pmm-support channel and see if there is a fix. |
| `[ERROR]` | `Input Failed` | A token or password is no longer valid for an online source of information | Review the meta.log for more information | | `[ERROR]` | `Input Failed` | A token or password is no longer valid for an online source of information | Review the meta.log for more information |
| `[ERROR]` | `Collection Error: trakt_list requires Trakt to be configured` | You are using a builder that has not been configured yet. | Review the meta.log for more information on what went wrong. Refer to the wiki for details on how to set this up (in this case Trakt) | | `[ERROR]` | `Collection Error: trakt_list requires Trakt to be configured` | You are using a builder that has not been configured yet. | Review the meta.log for more information on what went wrong. Refer to the wiki for details on how to set this up (in this case Trakt) |
#### WARNING #### WARNING
This table details examples of the most commonly-seen `[WARNING]` events and what they mean for the user. This table details examples of the most commonly-seen `[WARNING]` events and what they mean for the user.
| Type | Short Info | Description | Recommendation | | Type | Short Info | Description | Recommendation |
|:-------------|:------------------------------------------------------------------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:------------:|:-----------------------------------------------------------------|:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[WARNING]` | `Convert Error: No TVDb ID Found for TMDb ID: 15733` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. For example, at the time of that error, the TMDb record for "The Two Mrs. Grenvilles" [ID 15733] didn't contain a TVDb ID. This could be because the record just hasn't been updated, or because "The Two Mrs. Grenvilles" isn't listed on TVDB. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. | | `[WARNING]` | `Convert Error: No TVDb ID Found for TMDb ID: 15733` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. For example, at the time of that error, the TMDb record for "The Two Mrs. Grenvilles" [ID 15733] didn't contain a TVDb ID. This could be because the record just hasn't been updated, or because "The Two Mrs. Grenvilles" isn't listed on TVDB. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. |
| `[WARNING]` | `Convert Error: AniDB ID not found for AniList ID: 21400` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. | | `[WARNING]` | `Convert Error: AniDB ID not found for AniList ID: 21400` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. |
| `[WARNING]` | `Convert Error: No TVDb ID or IMDb ID found for AniDB ID: 14719` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. | | `[WARNING]` | `Convert Error: No TVDb ID or IMDb ID found for AniDB ID: 14719` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. |
| `[WARNING]` | `Convert Error: AniDB ID not found for MyAnimeList ID: 36838` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. | | `[WARNING]` | `Convert Error: AniDB ID not found for MyAnimeList ID: 36838` | Online sources are missing information | These sorts of errors indicate that the thing can't be cross-referenced between sites. The fix is for someone [like you, perhaps] to go to the relevant site and fill in the missing data. |
#### INFO #### INFO
This table details examples of the most commonly-seen `[INFO]` events and what they mean for the user. This table details examples of the most commonly-seen `[INFO]` events and what they mean for the user.
| Type | Short Info | Description | Recommendation | | Type | Short Info | Description | Recommendation |
|:-------------|:------------------------------------------------------------------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:---------:|:----------------------------------------------|:--------------------------------------|:------------------------------------------------------------------------------------------------------------------------------|
| `[INFO]` | `Detail: TMDb_person updated poster to [URL]` | Person image was downloaded from TMDb | May require you to update the people poster image to your style or request it in the style of the PMM defaults people posters | | `[INFO]` | `Detail: TMDb_person updated poster to [URL]` | Person image was downloaded from TMDb | May require you to update the people poster image to your style or request it in the style of the PMM defaults people posters |
#### DEBUG #### DEBUG
This table details examples of the most commonly-seen `[DEBUG]` events and what they mean for the user. This table details examples of the most commonly-seen `[DEBUG]` events and what they mean for the user.
| Type | Short Info | Description | Recommendation | | Type | Short Info | Description | Recommendation |
|:-------------|:------------------------------------------------------------------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:----------:|:-----------|:------------|:---------------|
| `[DEBUG]` | | | | | `[DEBUG]` | | | |

2
docs/metadata/metadata.md
View file

@ -43,7 +43,7 @@ collections:
There are multiple types of attributes that can be utilized within a collection: There are multiple types of attributes that can be utilized within a collection:
* [Builders](builders) * [Builders](builders)
* [Settings/Updates](details) * [Settings/Updates](update)
* [Filters](filters) * [Filters](filters)
### Example ### Example

2
docs/metadata/overlay.md
View file

@ -39,7 +39,7 @@ overlays:
There are multiple types of attributes that can be utilized within an overlay: There are multiple types of attributes that can be utilized within an overlay:
* [Builders](builders) * [Builders](builders)
* [Settings/Updates](details) * [Settings/Updates](update)
* [Filters](filters) * [Filters](filters)
## Overlay ## Overlay

4
docs/metadata/playlist.md
View file

@ -4,7 +4,7 @@ Playlist files are used to create and maintain playlists on the Plex Server.
If utilized to their fullest, these files can be used to maintain the entire server's collections and playlists, and can be used as a backup for these in the event of a restore requirement. If utilized to their fullest, these files can be used to maintain the entire server's collections and playlists, and can be used as a backup for these in the event of a restore requirement.
Playlists are defined in one or more Playlist files that are mapped in the [Playlist Files Attribute](../config/libraries.md#playlist-files-attribute) within the Configuration File. Playlists are defined in one or more Playlist files that are mapped in the [Playlist Files Attribute](../config/playlists) within the Configuration File.
You can use the [`playlist_report` setting](../config/settings.md#playlist-report) to get a list of your playlists printed out in your log. You can use the [`playlist_report` setting](../config/settings.md#playlist-report) to get a list of your playlists printed out in your log.
@ -39,7 +39,7 @@ playlists:
There are multiple types of attributes that can be utilized within a playlist: There are multiple types of attributes that can be utilized within a playlist:
* [Builders](builders) * [Builders](builders)
* [Settings/Updates](details) * [Settings/Updates](update)
* [Filters](filters) * [Filters](filters)
### Special Playlist Attributes ### Special Playlist Attributes