Plex

A library provider for Plex.

https://github.com/anibridge/anibridge-plex-provider

Configuration

library_provider_config:
  plex:
    url: ...
    token: ...
    # home_user: ...
    # sections: []
    # genres: []
    # strict: true

url

str (required)

The base URL of the Plex server (e.g., http://localhost:32400).

token

str (required)

The Plex authentication token for the target user being synchronized.

Generate a Plex API token

home_user

str (optional, default: None)

Optional Plex Home user to use. If the token provided belongs to the user you want to synchronize, you can leave this unset.

If set, the provider will attempt to switch to the specified Plex Home user using the Plex API. The account token provided must be the token of the Plex Home owner, otherwise the provider will fail to authenticate.

sections

list[str] (optional, default: [])

A list of Plex library section names to constrain synchronization to. Leave empty/unset to include all sections.

genres

list[str] (optional, default: [])

A list of genres to constrain synchronization to. Leave empty/unset to include all genres.

strict

bool (optional, default: True)

Whether to enforce strict matching when resolving mappings. If true, only exact mapping matches of a show's episode ordering (TMDB or TVDB) will be considered. If false, falling back from TMDB to TVDB (or vice versa) is allowed.

You can configure episode ordering in the show's or section's 'Advanced' settings.

Plex Webhooks

The Plex provider supports Plex webhooks for automatic synchronization on activity. To set up webhooks, configure your Plex server to send webhook requests to your AniBridge instance at the following URL:

http://<your-server-host>:<port>/webhook/plex

Refer to the Plex documentation for instructions on setting up webhooks: Plex Webhooks.

Tautulli Webhooks

If you don't have Plex Pass, you can use Tautulli webhooks as an alternative. Tautulli is a third-party monitoring tool for Plex that supports webhooks through its "Notification Agents" feature.

Tatulli's webhooks setup is a bit more involved, but it allows you to achieve similar functionality without needing Plex Pass:

1. After installing and setting up Tautulli, navigate to "Settings" > "Notification Agents" in the Tautulli web interface.
2. Click "Add a new notification agent" and select "Webhook" as the notification type.
3. Under the "Configuration" tab:
4. Configure the "Webhook URL" to your AniBridge instance at the following URL: http://<your-server-host>:<port>/webhook/plex?format=tautulli.
5. Configure the "Webhook Method" to POST.
6. Under the "Triggers" tab, select:
7. "Playback Stop"
8. "Watched"
9. "Recently Added"
10. Under the "Data" tab configure the following "JSON Data" template for every trigger you selected in [4]:

<movie>
{
  "action": "{action}",
  "user_id": "{user_id}",
  "rating_key": "{rating_key}",
  "parent_rating_key": "{parent_rating_key}",
  "grandparent_rating_key": "{grandparent_rating_key}"
}
</movie>
<show>
{
  "action": "{action}",
  "user_id": "{user_id}",
  "rating_key": "{rating_key}",
  "parent_rating_key": "{parent_rating_key}",
  "grandparent_rating_key": "{grandparent_rating_key}"
}
</show>
<season>
{
  "action": "{action}",
  "user_id": "{user_id}",
  "rating_key": "{rating_key}",
  "parent_rating_key": "{parent_rating_key}",
  "grandparent_rating_key": "{grandparent_rating_key}"
}
</season>
<episode>
{
  "action": "{action}",
  "user_id": "{user_id}",
  "rating_key": "{rating_key}",
  "parent_rating_key": "{parent_rating_key}",
  "grandparent_rating_key": "{grandparent_rating_key}"
}
</episode>