Media Requester¶

Overseerr¶

The Overseerr charm (overseerr-k8s) manages Overseerr in your Charmarr stack. Overseerr is where users request movies and TV shows.

Relations¶

The charm talks to other charms to figure out how to set up Overseerr. The order in which these connections happen doesn't matter. The charm sorts it out.

Connects To	Interface	What It Learns
Radarr/Sonarr	`media-manager`	API URL, quality profiles, root folders. Configures them automatically in Overseerr.
Plex	`media-server`	Allows Overseerr to talk to Plex
Ingress	`istio_ingress_route`	Enables external access to Overseerr

The charm aggressively reconciles Radarr/Sonarr servers. If you manually add a server in Overseerr that isn't a Juju relation, it gets deleted. Charms are declarative and Charmarr is designed to ✨just work✨.

Lifecycle¶

sequenceDiagram
    participant OC as Overseerr Charm
    participant Overseerr as Overseerr App
    participant RC as Radarr/Sonarr
    participant User

    OC->>Overseerr: Start
    Overseerr-->>OC: API key
    Note over OC: Waits for web UI setup

    User->>Overseerr: Complete web UI setup (manual)
    Overseerr-->>OC: Ready

    RC-->>OC: API URLs, profiles, folders
    OC->>Overseerr: Configure Radarr/Sonarr servers

Note

The web UI setup cannot be automated. The charm waits for the user to complete it before configuring Radarr/Sonarr. See Post-Deploy for details.

Configuration¶

See overseerr-k8s on Charmhub for all options.