Wiki / Setup — connections & keys

Plex

What it is for. Kustos reads your libraries, your collections, your people and their watch history from Plex, and writes artwork and collections back. Nothing works without it.

Cost. Free. A Plex Pass is not needed to run Kustos, and everything the rest of this page sets up works without one.

One feature does need it: promoting a collection onto Plex's own hubs — the library's Recommended row, your Home, and your friends' Home. Those are the Visible on controls, and they are a Plex Pass feature of Plex itself rather than of Kustos. Without a Pass, Kustos still stores your choice and Plex ignores it: nothing appears, and nothing errors to tell you why. The per-person suggestion rows lean on the same mechanism, so they need a Pass too.

This one is not a pasted key. Plex uses a sign-in, not an API key, and the Plex card has no key field to fill in. If you are staring at a key box trying to find a Plex token, you are on the wrong card.

Steps

  1. In Kustos, go to Connections.
  2. On the Plex card, press Sign in with Plex. A Plex window opens.
  3. Sign in as the server owner. This matters: a managed or shared account can see the libraries but cannot write artwork, and the failure looks like Kustos silently doing nothing.
  4. Approve the request. The window closes on its own.
  5. Back on the card, choose your server from the list, then tick the libraries Kustos should manage.

How you know it worked. The card turns green and names your server. The Media Library screen fills up within a minute or two.

If the window opens and nothing happens, your browser blocked the popup. Allow popups for the Kustos address and press the button again.