Settings

Settings are accessible to administrators via the gear icon in the navigation menu. This page covers all configuration options available in Streamarr.

General

API Key

This is your Streamarr API key, which can be used to integrate Streamarr with third-party applications.

Do not share this key publicly, as it can be used to gain administrator access!

If you need to generate a new API key for any reason, click the regenerate button next to the text box.

Application Title

Customize the application title displayed in the browser tab and throughout the UI. Default is "Streamarr".

Application URL

Set this to the externally-accessible URL of your Streamarr instance (e.g., https://streamarr.example.com).

You must configure this setting to enable:

• Password reset emails

• Correct links in email notifications

• QR codes for invites

Enable Proxy Support

If you have Streamarr behind a reverse proxy, enable this setting to allow Streamarr to correctly register client IP addresses.

For details, please see the Express documentation.

This setting is disabled by default.

Enable CSRF Protection

This is an advanced setting. We do not recommend enabling it unless you understand the implications of doing so.

CSRF stands for cross-site request forgery. When this setting is enabled, all external API access that alters Streamarr application data is blocked.

If you do not use Streamarr integrations with third-party applications to modify data, you can enable this setting for additional security.

HTTPS is required when CSRF protection is enabled. You will no longer be able to access Streamarr over HTTP.

If you enable this setting and find yourself unable to access Streamarr, you can disable it by editing settings.json in your config directory.

This setting is disabled by default.

Enable Image Caching

When enabled, Streamarr will proxy and cache images from external sources (such as TMDB). This can use a significant amount of disk space.

Images are saved in config/cache/images/ and stale images are cleared every 24 hours.

Enable this if you are having issues loading images directly from TMDB in your browser.

This setting is disabled by default.

Display Language

Set the default display language for Streamarr. Users can override this in their individual settings.

Support URL

Set the URL for the "Get Support" link shown in the Help Centre and footer.

Support Email

Set the support email address displayed in the Help Centre.

Enable Release Schedule

When enabled, the Release Schedule (Calendar) page is available in the navigation menu. This shows upcoming releases from Sonarr and Radarr, plus custom events.

This setting is disabled by default.

This setting controls the visibility of the schedule feature. You still need to configure Sonarr and/or Radarr in Services for release data to appear.

Enable Extended Homepage

When enabled, the homepage displays additional sections including FAQs and feature highlights below the main hero area.

When disabled, the homepage shows a minimal layout.

This setting is enabled by default.

Custom Logo

Upload custom logos to replace the default Streamarr branding. Two variants are supported:

Variant	Recommended Size	Where Used
Full Logo	190 × 45 px	Sidebar, sign-in page, desktop navigation
Small Logo	45 × 45 px	Mobile navigation, PWA icon, compact views

Supported formats: JPG, PNG, GIF, SVG (max 5 MB each).

Uploaded logos are stored in config/cache/logos/ and served via the API. To remove a custom logo and revert to the default Streamarr branding, click the delete button next to the logo preview.

Theme

Customize the application colors to match your brand. Streamarr uses DaisyUI theme tokens stored in OKLCH color space for perceptually uniform colors.

Color Tokens

The following 20 color tokens can be customized:

Token	Default	Purpose
primary	#974ede	Main brand/accent color
primary-content	#fff	Text on primary backgrounds
secondary	#080011	Secondary accent color
secondary-content	#cfcbdc	Text on secondary backgrounds
accent	#e5a00d	Highlight/emphasis color
accent-content	#fff	Text on accent backgrounds
neutral	#737373	Neutral/gray tones
neutral-content	#e0e2e4	Text on neutral backgrounds
base-100	#121212	Primary background color
base-200	#161616	Secondary background (cards, panels)
base-300	#1f1f1f	Tertiary background (borders, dividers)
base-content	#fff	Default text color on base backgrounds
info	#2563eb	Informational status color
info-content	#d2e2ff	Text on info backgrounds
success	#84cc16	Success status color
success-content	#fff	Text on success backgrounds
warning	#ffc107	Warning status color
warning-content	#fff	Text on warning backgrounds
error	#b91c1c	Error/danger status color
error-content	#fff	Text on error backgrounds

Color Picker

Click any color swatch in the theme grid to open the color picker. The picker supports three selection modes:

1. Palette — Choose from a curated grid of Tailwind colors

2. Picker — Visual color wheel for freeform selection

3. Sliders — HSL sliders for precise control (Hue, Saturation, Lightness)

Colors can be entered or displayed in four formats via the dropdown:

• OKLCH — oklch(L C H) (perceptually uniform, used internally)

• HSL — hsl(H, S%, L%)

• RGB — rgb(R, G, B)

• Hex — #RRGGBB

Theme Application

Theme colors are applied globally at runtime via CSS custom properties. They also propagate to embedded service iframes (Plex Web, *Arr services) for a consistent look across the application.

To reset all colors to defaults, click the "Reset to Default" button in the theme section.

---

Users

Enable Local Sign-In

When enabled, users who have configured passwords can sign in using their email address instead of Plex OAuth.

When disabled, Plex OAuth becomes the only sign-in option, and any "local users" you have created will not be able to sign in.

This setting is enabled by default.

Enable New Plex Sign-In

When enabled, users with access to your Plex server can sign in to Streamarr even if they have not been explicitly imported.

Users will be automatically assigned the permissions configured in Default Permissions upon first sign-in.

This setting is enabled by default.

Enable Sign Up

When enabled, users can sign up for an account using an invite code.

This setting is disabled by default.

Default Permissions

Select the permissions assigned to new users by default upon account creation.

See Users for a full list of available permissions.

Default Invite Quotas

Configure the default invite quota settings for new users:

• Quota Limit — Maximum number of invites a user can create

• Quota Days — Time period (in days) for the quota to reset

---

Trial Period

Enable Trial Period

When enabled, newly signed-up users are placed in a trial period where certain features are restricted (such as creating invites).

This setting is disabled by default.

Trial Period Days

The number of days a new user remains in trial status. Default is 30 days.

---

Plex

Plex Settings

To set up Plex, you can either enter your details manually or select a server retrieved from plex.tv. Click the button to retrieve available servers.

Depending on your setup, you may need to enter your Plex server details manually.

Hostname or IP Address

The hostname or IP address of your Plex server. If Streamarr is on the same network as Plex, you can use the local IP address.

Port

The port your Plex server listens on. Default is 32400.

Use SSL

Enable this to connect to Plex via HTTPS. Note that self-signed certificates are not supported.

Plex Libraries

Select which libraries Streamarr should have access to. These libraries will be:

• Available for sharing with invited users

• Synced for media counts

• Available in the internal Plex proxy

Shared Libraries (Default)

Configure which libraries are shared with users by default. Options:

• All Libraries — Share all enabled libraries

• Specific Libraries — Select specific library IDs (comma-separated)

Individual user settings can override this default.

---

Services

Streamarr integrates with various *Arr services to provide a unified dashboard.

Radarr

Connect one or more Radarr instances for movie management and calendar integration.

For each server, configure:

Setting	Description
Server Name	Friendly name for the server
Hostname or IP	Address of your Radarr server
Port	Default is 7878
API Key	Found in Radarr → Settings → General → Security
Use SSL	Enable for HTTPS connections
Base URL	URL path for internal proxy access (e.g., /radarr)
External URL	External URL for links (if different from internal)
Default	Mark one server as default
4K Server	Mark if this server is for 4K content
Enable Sync	Enable calendar sync
Past/Future Days	Days to sync for calendar

Sonarr

Connect one or more Sonarr instances for TV series management and calendar integration.

Configuration options are the same as Radarr, with the default port being 8989.

Other Services

Bazarr

Connect Bazarr for subtitle management.

Setting	Description
Hostname or IP	Address of your Bazarr server
Port	Default is 6767
API Key	Found in Bazarr → Settings → General
URL Base	Default is /bazarr

Prowlarr

Connect Prowlarr for indexer management.

Setting	Description
Hostname or IP	Address of your Prowlarr server
Port	Default is 9696
API Key	Found in Prowlarr → Settings → General
URL Base	Default is /prowlarr

Lidarr

Connect Lidarr for music management.

Setting	Description
Hostname or IP	Address of your Lidarr server
Port	Default is 8686
API Key	Found in Lidarr → Settings → General
URL Base	Default is /lidarr

Overseerr

Connect Overseerr for request management.

Setting	Description
Hostname or IP	Address of your Overseerr server
Port	Default is 5055
API Key	Found in Overseerr → Settings → General
URL Base	Default is /overseerr

Tdarr

Connect Tdarr for transcoding management.

Setting	Description
Enable	Enable or disable the Tdarr integration
Hostname or IP	Address of your Tdarr server
Port	Default is 8265

Tautulli

Connect Tautulli for Plex statistics.

Setting	Description
Hostname or IP	Address of your Tautulli server
Port	Default is 8181
API Key	Found in Tautulli → Settings → Web Interface
URL Base	Default is /tautulli

Uptime Kuma

Connect an Uptime Kuma instance (or any status page) to provide users with a link to your server status page.

Setting	Description
Enable	Enable or disable the status page integration
External URL	The publicly-accessible URL of your status page (e.g., https://status.example.com)

When enabled, the status page URL is exposed publicly (accessible without authentication) and displayed in the Help Centre. This allows users to check if your services are experiencing issues without needing to sign in.

While this setting is named "Uptime Kuma," it works with any status page URL — you are not required to use Uptime Kuma specifically.

---

Downloads

Configure download clients for torrent management. Supported clients:

• qBittorrent

• Deluge

• Transmission

For each client:

Setting	Description
Client Name	Friendly name
Client Type	qBittorrent, Deluge, or Transmission
Hostname or IP	Address of the client
Port	Client web UI port
Use SSL	Enable for HTTPS
Username/Password	Credentials for authentication
External URL	External URL for direct access

See Downloads for usage details.

---

Notifications

Configure notification agents. See Notifications for detailed setup instructions for each agent.

---

Jobs & Cache

Streamarr performs maintenance tasks as scheduled jobs. You can also manually trigger them here.

Scheduled Jobs

Job	Default Schedule	Description
Plex Full Library Scan	Daily at 3:00 AM	Full sync of Plex library metadata
Plex Token Refresh	Daily at 5:00 AM	Refresh admin Plex token
Image Cache Cleanup	Daily at 5:00 AM	Clean stale cached images
Invite & QR Cleanup	Daily at 1:00 AM	Mark expired invites and clean QR codes
Notification Cleanup	Daily at 1:30 AM	Clean old notifications

Cache Management

Streamarr caches requests to external APIs. You can flush individual caches if needed:

Cache	Description
TMDB	Movie/TV metadata from The Movie Database
Plex TV	Plex.tv API data
PlexGUID	Plex media GUID mappings
Radarr	Radarr API responses (includes calendar data)
Sonarr	Sonarr API responses (includes calendar data)
Lidarr	Lidarr API responses
Prowlarr	Prowlarr API responses
IMDB	IMDB data from Radarr proxy
GitHub	GitHub API responses (for update checks)

Flushing the Radarr or Sonarr cache will also clear cached calendar events, triggering a fresh fetch on the next calendar view.