From 4a96cbfb0e6231a253c67e4555e42f6b594db451 Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Wed, 23 Oct 2024 15:18:13 +0000 Subject: [PATCH] docs(plex): Clean up api/webhook sections and add migration guide --- config/plex.webhook.json.example | 1 + docsite/docs/configuration/configuration.mdx | 30 ++++++++++++++++---- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/config/plex.webhook.json.example b/config/plex.webhook.json.example index 05938d5..35e9207 100644 --- a/config/plex.webhook.json.example +++ b/config/plex.webhook.json.example @@ -1,4 +1,5 @@ [ + // DEPRECATED, use API Source instead // rename files to plex.json to use { "name": "MyPlex", diff --git a/docsite/docs/configuration/configuration.mdx b/docsite/docs/configuration/configuration.mdx index 2f42a58..1b9446a 100644 --- a/docsite/docs/configuration/configuration.mdx +++ b/docsite/docs/configuration/configuration.mdx @@ -241,11 +241,14 @@ If your Spotify player has [Automix](https://community.spotify.com/t5/FAQs/What- ### [Plex](https://plex.tv) + + + :::tip[Important Defaults] By default... -* multi-scrobbler will **only** scrobbling for the user authenticated with the Plex Token. +* multi-scrobbler will **only** scrobble for the user authenticated with the Plex Token. * Allowed Users (`usersAllow` or `PLEX_USERS_ALLOW`) are only necessary if you want to scrobble for additional users. * multi-scrobbler will only scrobble media found in Plex libraries that are labelled as **Music.** * `librariesAllow` or `PLEX_LIBRARIES_ALLOW` will override this @@ -260,7 +263,7 @@ Find your [**Plex Token**](https://support.plex.tv/articles/204059436-finding-an | Environmental Variable | Required? | Default | Description | | ---------------------- | --------- | ------- | ---------------------------------------------------------------------- | - | `PLEX_URL` | **Yes** | | The URL of the Plex server IE `http://localhost:8096` | + | `PLEX_URL` | **Yes** | | The URL of the Plex server IE `http://localhost:32400` | | `PLEX_TOKEN` | **Yes** | | The **Plex Token** to use with the API | | `PLEX_USERS_ALLOW` | No | | Comma-separated list of usernames (from Plex) to scrobble for | | `PLEX_USERS_BLOCK` | No | | Comma-separated list of usernames (from Plex) to disallow scrobble for | @@ -294,12 +297,28 @@ Find your [**Plex Token**](https://support.plex.tv/articles/204059436-finding-an -#### Legacy Webhooks + + + +:::warning[Deprecated] -Multi-scrobbler < 0.9.0 used [webhooks](https://support.plex.tv/articles/115002267687-webhooks) to support Plex scrobbling. The legacy docs are below. +Multi-scrobbler < 0.9.0 used [webhooks](https://support.plex.tv/articles/115002267687-webhooks) to support Plex scrobbling. This approach has been deprecated in favor of using Plex's API directly which has many benefits including **not requiring Plex Pass.** + +:::
+ Migrating to API + + * Follow the instructions in the API tab + * The `user` (`PLEX_USER`) setting has been renamed `usersAllow` (`PLEX_USERS_ALLOW`) + * If you were using this filter to ensure only scrobbles from yourself were registered then you no longer need this setting -- by default MS will only scrobble for the user the Plex Token is used for. + * The `servers` setting is no longer available as MS only scrobbles from the server using the API anyways. + * If you need to scrobble for multiple servers set up each server as a separate Plex API source + * The `libraries` setting has been renamed to `librariesAllow` + +
+ * In the Plex dashboard Navigate to your **Account/Settings** and find the **Webhooks** page * Click **Add Webhook** * URL -- `http://localhost:9078/plex` (substitute your domain if different than the default) @@ -338,7 +357,8 @@ Multi-scrobbler < 0.9.0 used [webhooks](https://support.plex.tv/articles/1150022 - + + ### [Tautulli](https://tautulli.com)