From 003fbf04068b151d5d76d6ba2c0ca0e430b93688 Mon Sep 17 00:00:00 2001 From: Chaz Larson Date: Sun, 19 Jan 2025 14:41:46 -0600 Subject: [PATCH] reorder config to put required things first (#2451) --- config/config.yml.template | 27 +++++++++++++++------------ docs/config/overview.md | 4 ++-- mkdocs.yml | 9 ++++----- 3 files changed, 21 insertions(+), 19 deletions(-) diff --git a/config/config.yml.template b/config/config.yml.template index d59f5a05..d7686b89 100644 --- a/config/config.yml.template +++ b/config/config.yml.template @@ -1,5 +1,20 @@ ## This file is a template remove the .template to use the file +## These are the two connections which are required for the script to run +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 + db_cache: + clean_bundles: false + empty_trash: false + optimize: false + verify_ssl: +tmdb: # REQUIRED for the script to run + apikey: ################################ + language: en + +## At least one library has to be configured for the script to do anything meaningful libraries: # This is called out once within the config.yml file Movies: # These are names of libraries in your Plex remove_overlays: false # Set this to true to remove all overlays @@ -83,18 +98,6 @@ webhooks: # Can be individually specified per library 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 - db_cache: - clean_bundles: false - empty_trash: false - optimize: false - verify_ssl: -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: ################################ diff --git a/docs/config/overview.md b/docs/config/overview.md index 7e361dc9..2f13d9f2 100644 --- a/docs/config/overview.md +++ b/docs/config/overview.md @@ -15,12 +15,12 @@ requirements for setup that can be found by clicking the links within the table | Attribute | Required | |:--------------------------------------------|:----------------------------------------------------------------------| +| [`plex`](plex.md) | :fontawesome-solid-circle-check:{ .green } Required here; can be overridden per library | +| [`tmdb`](tmdb.md) | :fontawesome-solid-circle-check:{ .green } | | [`libraries`](libraries.md) | :fontawesome-solid-circle-check:{ .green } | | [`playlist_files`](../notused/playlists.md) | :fontawesome-solid-circle-xmark:{ .red } | | [`settings`](settings.md) | :fontawesome-solid-circle-xmark:{ .red } | | [`webhooks`](webhooks.md) | :fontawesome-solid-circle-xmark:{ .red } | -| [`plex`](plex.md) | :fontawesome-solid-circle-check:{ .green } Either here or per library | -| [`tmdb`](tmdb.md) | :fontawesome-solid-circle-check:{ .green } | | [`tautulli`](tautulli.md) | :fontawesome-solid-circle-xmark:{ .red } | | [`github`](github.md) | :fontawesome-solid-circle-xmark:{ .red } | | [`omdb`](omdb.md) | :fontawesome-solid-circle-xmark:{ .red } | diff --git a/mkdocs.yml b/mkdocs.yml index c6d28cf9..50a9bd15 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -171,6 +171,9 @@ nav: - CONFIGURATION FILE: - Overview: config/overview.md - STRUCTURE: + - REQUIRED CONNECTIONS: + - Plex: config/plex.md + - TMDb: config/tmdb.md - LIBRARIES: - Library Attributes: config/libraries.md - File Blocks: config/files.md @@ -179,11 +182,6 @@ nav: - Playlist Files: config/playlists.md - SETTINGS: - Settings: config/settings.md - - WEBHOOKS: - - Webhooks: config/webhooks.md - - REQUIRED CONNECTIONS: - - Plex: config/plex.md - - TMDb: config/tmdb.md - OPTIONAL CONNECTIONS: - Tautulli: config/tautulli.md - Github: config/github.md @@ -197,6 +195,7 @@ nav: - Trakt: config/trakt.md - MyAnimeList: config/myanimelist.md - Trakt and MyAnimeList Authentication: config/authentication.md + - Webhooks: config/webhooks.md - OTHER: - Scheduling Parts: config/schedule.md - KOMETA DEFAULTS: