Documentation Index
Fetch the complete documentation index at: https://mintlify.com/chrisbenincasa/tunarr/llms.txt
Use this file to discover all available pages before exploring further.
Tunarr can source content from one or more Plex Media Servers. All metadata — titles, artwork, episode information, and more — is pulled directly from Plex. Once connected, you can browse your Plex libraries when building channel schedules and mix Plex content with other sources.
Connecting a Plex Server
To add a Plex server, navigate to Settings > Sources in the Tunarr web UI and click the Add button, then choose Plex. Tunarr supports two connection methods: automatic server discovery via OAuth, and manual token entry.
Open Media Sources settings
In the Tunarr web UI, navigate to Settings > Sources.
Click Add and select Plex
Click the Add button in the Media Sources table toolbar, then select Plex from the dropdown.
Choose a connection method
Select either Auto (recommended) or Manual depending on your setup. Auto (OAuth)
Manual (Token)
The automatic connection method launches a Plex sign-in popup in your browser. After you sign in with your Plex account credentials, Tunarr uses the Plex API to discover all Plex servers associated with your account and automatically adds any reachable servers to Tunarr.This is the simplest approach and requires no additional information from you beyond your Plex account login.
If you cannot use automatic discovery — for example, because your Plex server is not accessible from your browser, or you prefer not to use OAuth — you can add a server manually by supplying the server URL and a Plex authentication token.To obtain your Plex token, follow the official Plex instructions at support.plex.tv. Once you have the token, enter the server URL and token in the Add Plex Media Source dialog. Confirm the connection
After completing authentication (Auto) or entering credentials (Manual), Tunarr will attempt to reach the server. Successfully connected servers will appear in the Media Sources table.
Library Synchronization
After connecting a Plex server, you can configure Tunarr to periodically sync metadata from your Plex libraries into its own database. This is a one-way import — Tunarr reads from Plex and never writes back or mutates any Plex data.
Library synchronization is an alpha-only feature planned for general availability in v1.0. Enabling it gives you richer search and scheduling capabilities inside Tunarr.
Open the Edit Libraries dialog
In the Media Sources table on Settings > Sources, find your Plex server and click the Edit Libraries button.
Select libraries to sync
You will see a list of all Plex libraries that Tunarr can access. Toggle on each library you want Tunarr to synchronize.
Wait for the initial sync
Selected libraries are queued immediately for synchronization. Tunarr syncs one library per source at a time. Progress is visible in the Media Sources settings page.
Streaming from Disk
Streaming directly from disk — rather than routing media through Plex over the network — significantly improves streaming performance, stability, and reduces unnecessary network traffic. There are two ways to configure this.
The simplest approach is to ensure that Tunarr can access the same file paths that Plex uses. No additional configuration inside Tunarr is required.In a Docker deployment, this typically means adding the same bind mounts to your Tunarr container that you have for your Plex container. For example, if Plex mounts /media/movies into the container, add the same mount to Tunarr so it sees files at the same path.
If Tunarr runs in an environment where paths differ from those reported by Plex — for example, because Tunarr and Plex are on different machines or use different mount points — you can configure path replacement rules.Path replacements tell Tunarr how to transform a path as reported by Plex into a locally accessible path.Open the Edit dialog for the Plex source
In the Media Sources table, click the Edit button on the row for your Plex server.
Add a path replacement rule
Click Add Path Replacement. Enter the path prefix as Plex reports it (the “from” value) and the corresponding path that Tunarr can access (the “to” value).
Save and test
Save the changes. Tunarr will apply the replacement rule whenever it resolves a media file path from this Plex server.
Path replacements per media source are configurable in alpha versions of Tunarr.
