githubEdit

Introduction

Welcome to the Streamarr Documentation.

Streamarr is an open-source web application designed to wrap your existing *Arr ecosystem—including Sonarrarrow-up-right, Radarrarrow-up-right, Overseerrarrow-up-right, and Plexarrow-up-right—into a seamless, user-friendly experience.

Features

  • Full Plex Integration — Sign in with Plex and manage user access directly from Streamarr

  • Embedded Plex Web — Watch content directly within Streamarr without leaving the app

  • *Arr Service Integration — Connect Radarr, Sonarr, Lidarr, Prowlarr, Bazarr, Tdarr, and more

  • Powerful Invite System — Generate invite codes with usage limits, expiry dates, library access controls, and QR codes

  • Release Calendar — View upcoming releases from Sonarr and Radarr, plus create custom events

  • Download Client Management — Monitor and manage qBittorrent, Deluge, and Transmission with health monitoring

  • Flexible Notifications — Email (with PGP encryption support), Web Push, and In-App notifications

  • Internal Proxy — Securely access embedded *Arr services and Plex Web through Streamarr

  • Granular Permissions — Fine-grained permission system to control user access

  • Trial Periods — Optionally restrict new users during a configurable trial period

  • Interactive Onboarding — Welcome modals and interactive tutorials for both new users and administrators

  • Custom Theming — Fully customize 20 color tokens with a visual picker (OKLCH, RGB, HSL, Hex)

  • Custom Branding — Upload custom logos to replace default Streamarr branding

  • System Health Monitoring — Real-time health status for server and Plex Sync service with restart controls

  • Status Page Integration — Link to Uptime Kuma or any external status page

  • Multi-language Support — Localized interface with per-user language settings

  • PWA Support — Install Streamarr as a Progressive Web App on mobile devices

Motivation

Streamarr was created to provide a unified dashboard for managing Plex servers with extensive *Arr integrations. Instead of juggling multiple applications and browser tabs, Streamarr brings everything together with a focus on:

  • User Experience — A clean, modern interface that's easy for both admins and end users

  • Invite Management — Simplified user onboarding with powerful invite controls

  • Self-Hosting — Full control over your data with easy Docker deployment

We Need Your Help!

Streamarr is under active development. We welcome contributions of all kinds:

Last updated

Was this helpful?