Skip to content

Commit

Permalink
docs(plex): Clean up api/webhook sections and add migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
FoxxMD committed Oct 23, 2024
1 parent 77a3c35 commit 4a96cbf
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 5 deletions.
1 change: 1 addition & 0 deletions config/plex.webhook.json.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[
// DEPRECATED, use API Source instead
// rename files to plex.json to use
{
"name": "MyPlex",
Expand Down
30 changes: 25 additions & 5 deletions docsite/docs/configuration/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -241,11 +241,14 @@ If your Spotify player has [Automix](https://community.spotify.com/t5/FAQs/What-

### [Plex](https://plex.tv)

<Tabs groupId="plexType" queryString>
<TabItem value="api" label="API">

:::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
Expand All @@ -260,7 +263,7 @@ Find your [**Plex Token**](https://support.plex.tv/articles/204059436-finding-an
<TabItem value="env" label="ENV">
| 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 |
Expand Down Expand Up @@ -294,12 +297,28 @@ Find your [**Plex Token**](https://support.plex.tv/articles/204059436-finding-an
</TabItem>
</Tabs>

#### Legacy Webhooks
</TabItem>
<TabItem value="webhook" label="Webhook (Deprecated)">

:::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.**

:::

<details>

<summary>Migrating to API</summary>

* 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`

</details>

* 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)
Expand Down Expand Up @@ -338,7 +357,8 @@ Multi-scrobbler < 0.9.0 used [webhooks](https://support.plex.tv/articles/1150022
</TabItem>
</Tabs>

</details>
</TabItem>
</Tabs>

### [Tautulli](https://tautulli.com)

Expand Down

0 comments on commit 4a96cbf

Please sign in to comment.