DOCSEARCHbyAlgolia
Submit Docs

Overseerr Documentation

repository·develop·Indexed 25 days ago

https://github.com/sct/overseerr

An open-source media request management application that integrates with Plex, Sonarr, and Radarr to allow users to request movies and TV shows. Features include Plex authentication, granular user permissions, and support for multiple notification agents including Discord, Slack, and Telegram. Note: Overseerr is being superseded by Seerr.

Tokens
16.8K
Snippets
22
Records
133
Agent score
90%

What's inside Overseerr

  1. Overview of Overseerr features

    develop

    Overseerr is a free and open source application for managing media requests. It integrates with services like Sonarr, Radarr, and Plex to automate your media library management.

    Key features include:

    • Plex Integration: Authenticate and manage user access via Plex.
    • Service Integration: Supports Sonarr and Radarr for automated media handling.
    • Library Scanning: Scans Plex libraries to track existing titles.
    • Request System: Allows users to request individual seasons or movies through a user-friendly interface.
    • Request Management: Simple UI for approving recent requests.
    • Permissions: Granular permission system for users.
    • Notifications: Support for various notification agents.
    • Mobile Support: Mobile-friendly design for on-the-go request management.

  2. Explore third-party integrations for Overseerr

    develop

    Overseerr can be integrated with various third-party services for dashboards, mobile controllers, bots, and CLI tools. Note that these integrations are not officially supported by Overseerr; for troubleshooting, contact the specific integration's support channels.

    Available integrations include:

  6. Install Overseerr as a Progressive Web App (PWA)

    develop
    Overseerr does not have native mobile apps, but it provides a native-like experience via Progressive Web App (PWA) installation. To use this feature, ensure your Overseerr instance is served over HTTPS (e.g., via a reverse proxy).

  7. Configure notification agents in Overseerr

    develop

    To enable notifications, navigate to Settings → Notifications in the Overseerr web interface. From there, you can configure the global notification agents for the instance.

    Note that individual users can further customize their own personal notification preferences within their own user-specific notification settings.

  12. Enable Web Push notifications

    develop

    To enable the web push notification agent, which allows users to receive Overseerr notifications directly in supported web browsers, navigate to Settings → Notifications → Web Push and enable the agent. Once enabled, you and your users will be prompted by the browser to allow notifications.

    Requirements and Limitations:

    • HTTPS is mandatory: The web push agent only works when Overseerr is accessed via HTTPS. If you are not using HTTPS, refer to the reverse proxy documentation to set up a proxy (e.g., Nginx, Caddy) to handle HTTPS traffic.
    • iOS Support: iOS devices do not currently support these web push notifications.
    • User Control: Users can opt out of notifications or customize which notification types they receive via their individual user settings.