mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-26 06:20:23 +00:00
remove libraries-first from docs and introduces run_order
This commit is contained in:
YozoraXCII
parent
4e7c396717
commit
b5afd8dacf
2 changed files with 150 additions and 103 deletions
|
|
@ -25,7 +25,7 @@ The available setting attributes which can be set at each level are outlined bel
|
|||
|
||||
|
||||
| Attribute | Global Level | Library Level | Collection/Playlist Level |
|
||||
|:--------------------------------------------------------------|:------------:|:-------------:|:-------------------------:|
|
||||
|:--------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|
|
||||
| [`cache`](#cache) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [`cache_expiration`](#cache-expiration) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [`asset_directory`](#image-asset-directory) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
|
|
@ -59,7 +59,8 @@ The available setting attributes which can be set at each level are outlined bel
|
|||
| [`item_refresh_delay`](#item-refresh-delay) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [`playlist_sync_to_users`](#playlist-sync-to-users) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [`playlist_exclude_users`](#playlist-exclude-users) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [`playlist_report`](#playlist-report) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [`playlist_report`](#playlist-report) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [`run_order`](#run-order) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [`custom_repo`](#custom-repo) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [`verify_ssl`](#verify-ssl) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [`check_nightly`](#check-nightly) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
|
|
@ -80,6 +81,51 @@ The below in an extract of the `config.yml.template` and is the initial values t
|
|||
end="webhooks:"
|
||||
%}
|
||||
~~~
|
||||
|
||||
## Example Library-Level Settings
|
||||
|
||||
The below showcases how to set a library-level setting, assuming that the attribute is listed as a library-level compatible attribute in the above table.
|
||||
|
||||
If no library-level attribute is set, then the global attribute is used.
|
||||
|
||||
???+ tip
|
||||
|
||||
Press the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
run_order: #(1)!
|
||||
- operations
|
||||
- collections
|
||||
- overlays
|
||||
minimum_items: 3 #(2)!
|
||||
metadata_path:
|
||||
# stuff here
|
||||
overlay_path:
|
||||
# stuff here
|
||||
operations:
|
||||
# stuff here
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
# stuff here
|
||||
overlay_path:
|
||||
# stuff here
|
||||
operations:
|
||||
# stuff here
|
||||
settings:
|
||||
run_order: #(3)!
|
||||
- collections
|
||||
- operations
|
||||
- overlays
|
||||
minimum_items: 1 #(4)!
|
||||
```
|
||||
|
||||
1. Sets the `run_order` specifically for the Movies library
|
||||
2. Sets the `minimum_items` attribute specifically for the Movies library
|
||||
3. Sets the global `run_order` which will apply to all libraries unless a library-level `run_order` is found, as showcased in the above example
|
||||
4. Sets the global `minimum_items` which will apply to all libraries unless a library-level `run_order` is found, as showcased in the above example
|
||||
|
||||
## Cache
|
||||
Cache the Plex GUID and associated IDs for each library item for faster subsequent processing. The cache file is created in the same directory as the configuration file.
|
||||
|
||||
|
|
@ -458,14 +504,35 @@ Set the default playlist `exclude_users`.
|
|||
| Allowed Values | list of users or comma-separated string of users |
|
||||
|
||||
|
||||
# Playlist Report
|
||||
## Playlist Report
|
||||
Set `playlist_report` to true to print out a playlist report at the end of the log.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
|----------------|-------------------|
|
||||
| Default Value | false |
|
||||
| Allowed Values | `true` or `false` |
|
||||
|
||||
## Run Order
|
||||
|
||||
Specify the run order of the library components [Metadata Files, Library Operations, and Overlay Files]
|
||||
|
||||
???+ tip
|
||||
|
||||
If not specified, the default run order is Metadata Files, then Library Operations, then Overlay Files
|
||||
|
||||
```yml
|
||||
settings:
|
||||
run_order:
|
||||
- metadata
|
||||
- operations
|
||||
- overlays
|
||||
```
|
||||
|
||||
| | |
|
||||
|----------------|-------------------------------------------------------------------------------|
|
||||
| Default Value | `` |
|
||||
| Allowed Values | List which must include `operations`, `metadata` and `overlays` in any order |
|
||||
|
||||
|
||||
## Custom Repo
|
||||
|
||||
|
|
@ -476,7 +543,7 @@ Specify where the `repo` attribute's base is when defining `metadata_path`, `pla
|
|||
Ensure you are using the raw GitHub link (i.e. https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12 )
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
|----------------|-------------------------|
|
||||
| Default Value | None |
|
||||
| Allowed Values | link to base repository |
|
||||
|
||||
|
|
@ -490,7 +557,7 @@ Turn SSL Verification on or off.
|
|||
set to false if your log file shows any errors similar to "SSL: CERTIFICATE_VERIFY_FAILED"
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
|-----------------|---------------------|
|
||||
| Default Value | true |
|
||||
| Allowed Values | `true` or `false` |
|
||||
|
||||
|
|
@ -506,7 +573,7 @@ Will check nightly for updates instead of develop.
|
|||
It is recommended to set this to `true` if you primarily use the `nightly` branch
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
|-----------------|--------------------|
|
||||
| Default Value | false |
|
||||
| Allowed Values | `true` or `false` |
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Another way to specify environmental variables is by adding them to a .env file
|
|||
|
||||
|
||||
| Attribute | Shell Command | Environment Variable |
|
||||
|:------------------------------------------------------|:----------------------------------------------|:--------------------------|
|
||||
|:------------------------------------------------------|:----------------------------------------------|:-------------------------|
|
||||
| [Config](#config) | `-c` or `--config` | `PMM_CONFIG` |
|
||||
| [Time to Run](#time-to-run) | `-t` or `--times` | `PMM_TIMES` |
|
||||
| [Run Immediately](#run-immediately) | `-r` or `--run` | `PMM_RUN` |
|
||||
|
|
@ -41,7 +41,6 @@ Another way to specify environmental variables is by adding them to a .env file
|
|||
| [Run Collections](#run-collections) | `-rc` or `--run-collections` | `PMM_RUN_COLLECTIONS` |
|
||||
| [Run Libraries](#run-libraries.md) | `-rl` or `--run-libraries` | `PMM_RUN_LIBRARIES` |
|
||||
| [Run Metadata Files](#run-metadata-files) | `-rm` or `--run-metadata-files` | `PMM_RUN_METADATA_FILES` |
|
||||
| [Libraries First](#libraries-first) | `-lf` or `--libraries-first` | `PMM_LIBRARIES_FIRST` |
|
||||
| [Ignore Schedules](#ignore-schedules) | `-is` or `--ignore-schedules` | `PMM_IGNORE_SCHEDULES` |
|
||||
| [Ignore Ghost](#ignore-ghost) | `-ig` or `--ignore-ghost` | `PMM_IGNORE_GHOST` |
|
||||
| [Delete Collections](#delete-collections) | `-dc` or `--delete-collections` | `PMM_DELETE_COLLECTIONS` |
|
||||
|
|
@ -377,25 +376,6 @@ Perform a metadata files run immediately to run only the pre-defined metadata fi
|
|||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-metadata-files "Movies.yml|seasonal|genre"
|
||||
```
|
||||
|
||||
### Libraries First
|
||||
|
||||
Run library operations prior to running collections.
|
||||
|
||||
| | Shell Command | Environment Variable |
|
||||
|:--------|:-----------------------------|:---------------------------|
|
||||
| Flags | `-lf` or `--libraries-first` | `PMM_LIBRARIES_FIRST` |
|
||||
| Example | `--libraries-first` | `PMM_LIBRARIES_FIRST=true` |
|
||||
|
||||
!!! example
|
||||
=== "Local Environment"
|
||||
```
|
||||
python plex_meta_manager.py --libraries-first
|
||||
```
|
||||
=== "Docker Environment"
|
||||
```
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --libraries-first
|
||||
```
|
||||
|
||||
### Ignore Schedules
|
||||
|
||||
Ignore all schedules for the run.
|
||||
|
|
|
|||
Loading…
Reference in a new issue