mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
[33] update configuration
This commit is contained in:
parent
6839f45278
commit
61398f36db
4 changed files with 12 additions and 184 deletions
2
VERSION
2
VERSION
|
@ -1 +1 @@
|
|||
1.18.3-develop32
|
||||
1.18.3-develop33
|
||||
|
|
|
@ -29,186 +29,5 @@ This table outlines the third-party services that Plex Meta Manager can make use
|
|||
|
||||
This example outlines what a "standard" config.yml file might look like when in use.
|
||||
|
||||
<details>
|
||||
<summary>Example config.yml file</summary>
|
||||
|
||||
```yaml
|
||||
## This file is a template remove the .template to use the file
|
||||
|
||||
libraries: # This is called out once within the config.yml file
|
||||
Movies: # These are names of libraries in your Plex
|
||||
metadata_path:
|
||||
- pmm: basic # This is a file within PMM's defaults folder
|
||||
- pmm: imdb # This is a file within PMM's defaults folder
|
||||
# see the wiki for how to use local files, folders, URLs, or files from git
|
||||
overlay_path:
|
||||
- remove_overlays: false # Set this to true to remove all overlays
|
||||
- pmm: ribbon # This is a file within PMM's defaults folder
|
||||
# see the wiki for how to use local files, folders, URLs, or files from git
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: basic # This is a file within PMM's defaults folder
|
||||
- pmm: imdb # This is a file within PMM's defaults folder
|
||||
# see the wiki for how to use local files, folders, URLs, or files from git
|
||||
overlay_path:
|
||||
- remove_overlays: false # Set this to true to remove all overlays
|
||||
- pmm: ribbon # This is a file within PMM's defaults folder
|
||||
# see the wiki for how to use local files, folders, URLs, or files from git
|
||||
Anime:
|
||||
metadata_path:
|
||||
- pmm: basic # This is a file within PMM's defaults folder
|
||||
- pmm: anilist # This is a file within PMM's defaults folder
|
||||
# see the wiki for how to use local files, folders, URLs, or files from git
|
||||
Music:
|
||||
metadata_path:
|
||||
- file: config/Music.yml # This is a local file THAT YOU MIGHT CREATE
|
||||
playlist_files:
|
||||
- pmm: playlist # This is a file within PMM's defaults folder
|
||||
# see the wiki for how to use local files, folders, URLs, or files from git
|
||||
settings:
|
||||
cache: true
|
||||
cache_expiration: 60
|
||||
asset_directory: config/assets
|
||||
asset_folders: true
|
||||
asset_depth: 0
|
||||
create_asset_folders: false
|
||||
prioritize_assets: false
|
||||
dimensional_asset_rename: false
|
||||
download_url_assets: false
|
||||
show_missing_season_assets: false
|
||||
show_missing_episode_assets: false
|
||||
show_asset_not_needed: true
|
||||
sync_mode: append
|
||||
minimum_items: 1
|
||||
default_collection_order:
|
||||
delete_below_minimum: true
|
||||
delete_not_scheduled: false
|
||||
run_again_delay: 2
|
||||
missing_only_released: false
|
||||
only_filter_missing: false
|
||||
show_unmanaged: true
|
||||
show_unconfigured: true
|
||||
show_filtered: false
|
||||
show_options: false
|
||||
show_missing: true
|
||||
show_missing_assets: true
|
||||
save_report: false
|
||||
tvdb_language: eng
|
||||
ignore_ids:
|
||||
ignore_imdb_ids:
|
||||
item_refresh_delay: 0
|
||||
playlist_sync_to_user: all
|
||||
playlist_exclude_users:
|
||||
playlist_report: false
|
||||
verify_ssl: true
|
||||
custom_repo:
|
||||
check_nightly: false
|
||||
webhooks: # Can be individually specified per library as well
|
||||
error:
|
||||
version:
|
||||
run_start:
|
||||
run_end:
|
||||
changes:
|
||||
plex: # Can be individually specified per library as well; REQUIRED for the script to run
|
||||
url: http://192.168.1.12:32400
|
||||
token: ####################
|
||||
timeout: 60
|
||||
clean_bundles: false
|
||||
empty_trash: false
|
||||
optimize: false
|
||||
tmdb: # REQUIRED for the script to run
|
||||
apikey: ################################
|
||||
language: en
|
||||
tautulli: # Can be individually specified per library as well
|
||||
url: http://192.168.1.12:8181
|
||||
apikey: ################################
|
||||
omdb:
|
||||
apikey: ########
|
||||
cache_expiration: 60
|
||||
mdblist:
|
||||
apikey: #########################
|
||||
cache_expiration: 60
|
||||
notifiarr:
|
||||
apikey: ####################################
|
||||
anidb: # Not required for AniDB builders unless you want mature content
|
||||
username: ######
|
||||
password: ######
|
||||
radarr: # Can be individually specified per library as well
|
||||
url: http://192.168.1.12:7878
|
||||
token: ################################
|
||||
add_missing: false
|
||||
add_existing: false
|
||||
root_folder_path: S:/Movies
|
||||
monitor: true
|
||||
availability: announced
|
||||
quality_profile: HD-1080p
|
||||
tag:
|
||||
search: false
|
||||
radarr_path:
|
||||
plex_path:
|
||||
sonarr: # Can be individually specified per library as well
|
||||
url: http://192.168.1.12:8989
|
||||
token: ################################
|
||||
add_missing: false
|
||||
add_existing: false
|
||||
root_folder_path: "S:/TV 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:
|
||||
trakt:
|
||||
client_id: ####################
|
||||
client_secret: ####################
|
||||
pin:
|
||||
authorization:
|
||||
# everything below is autofilled by the script
|
||||
access_token:
|
||||
token_type:
|
||||
expires_in:
|
||||
refresh_token:
|
||||
scope: public
|
||||
created_at:
|
||||
mal:
|
||||
client_id: ####################
|
||||
client_secret: ####################
|
||||
authorization:
|
||||
# everything below is autofilled by the script
|
||||
access_token:
|
||||
token_type:
|
||||
expires_in:
|
||||
refresh_token:
|
||||
```
|
||||
</details>
|
||||
|
||||
**Expand the above to see the full config.yml file before continuing.**
|
||||
<br/>
|
||||
|
||||
<details>
|
||||
<summary>Example config.yml file 2</summary>
|
||||
|
||||
```{include} ../../config/config.yml.template
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Example config.yml file 3</summary>
|
||||
|
||||
```yaml
|
||||
|
||||
```{include} ../../config/config.yml.template
|
||||
```
|
||||
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
```{include} ../../config/config.yml.template
|
||||
```{literalinclude} ../../config/config.yml.template
|
||||
```
|
8
docs/home/guides/contributor.md
Normal file
8
docs/home/guides/contributor.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
# Contributor Guide
|
||||
|
||||
## How to set up a local Wiki Server
|
||||
|
||||
1. In addition to your normal `python -m pip install -r requirements.txt` to install requirements you'll also need to install the docs `requirements.txt` by running `python -m pip install -r docs/requirements.txt`.
|
||||
2. Run `docs\make.bat html` from the main PMM directory to build the html wiki files.
|
||||
3. Run `sphinx-reload docs` to boot up the Reloading Server at `http://localhost:5500`
|
||||
4. Now you can make changes inside the docs folder to update the Wiki and when you want to see the changes just run `docs\make.bat html` again and then refresh that page.
|
|
@ -3,4 +3,5 @@ sphinx_bootstrap_theme
|
|||
sphinx_inline_tabs
|
||||
sphinx-copybutton
|
||||
sphinx-reredirects
|
||||
sphinx_design
|
||||
sphinx_design
|
||||
sphinx-reload
|
Loading…
Reference in a new issue