¶ Table of Contents
- Table of Contents
- Forced Authentication
- How do I reset Stats?
- Category Not Available or Missing
- Can I add any (generic) Torrent RSS Feed?
- Can I add any (generic) Torznab or Newznab indexer?
- Can I use flaresolverr indexers?
- How can I add an indexer that is down or not functional?
- Prowlarr will not sync to Sonarr
- Prowlarr will not sync X Indexer to App
- What *Arr Indexer Settings are Compared for App Full Sync
- How do I update Prowlarr?
- Can I switch from
nightlyback todevelop? - Can I switch between branches?
- Help, my Mac says Prowlarr cannot be opened because the developer cannot be verified
- Help, my Mac says Prowlarr.app is damaged and can’t be opened
- How do I request a feature for Prowlarr?
- I am getting an error: Database disk image is malformed
- I use Prowlarr on a Mac and it suddenly stopped working. What happened?
- How do I change from the Windows Service to a Tray App?
- How do I Backup/Restore Prowlarr?
- WebUI only Loads at localhost on Windows
- Finding Cookies
- I got a pop-up that said config.xml was corrupt, what now?
- Invalid Certificate and other HTTPS or SSL issues
- Help I have locked myself out
- Weird UI Issues
- VPNs, Jackett, and the *ARRs
- How do I stop the browser from launching on startup?
- Can I easily add all indexers at once?
¶ Forced Authentication
If Prowlarr is exposed so that the UI can be accessed from outside your local network then you should have some form of authentication method enabled in order to access the UI. This is also increasingly required by Trackers and Indexers.
As of Prowlarr v1, Authentication is Mandatory.
AuthenticationTypeandAuthenticationMethodare mandatory required attributes in the configuration file.
¶ Authentication Method
Basic(Browser pop-up) - Basic Auth is not supported as of Prowlarr v1Forms(Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Prowlarr. This is recommended.External- Configurable via Config File Only- Disables app authentication completely. Use at your own risk especially if exposed to the internet Suggested only if you use an external authentication such as Authelia, Authetik, NGINX Basic auth, etc. you can prevent needing to double authenticate by shutting down the app, setting
<AuthenticationMethod>External</AuthenticationMethod>in the config file, and restarting the app. Note that multipleAuthenticationMethodentries in the file are not supported and only the topmost value will be used
- Disables app authentication completely. Use at your own risk especially if exposed to the internet Suggested only if you use an external authentication such as Authelia, Authetik, NGINX Basic auth, etc. you can prevent needing to double authenticate by shutting down the app, setting
¶ Authentication Required
- If you do not expose the app externally and/or do not wish to have auth required for local (e.g. LAN) access then change in Settings => General Security => Authentication Required to
Disabled For Local Addresses- The config file equivalent of this is
<AuthenticationType>DisabledForLocalAddresses</AuthenticationType>
- The config file equivalent of this is
<AuthenticationType>Enabled</AuthenticationType>is also a valid value
¶ How do I reset Stats
- To reset your stats and clear history do the following:
- History => Options
- Set History Cleanup to
1. This will keep only through yesterday's History and Stats - Navigate to System => Tasks
- Run the
Clean Up HistoryTask - Run the
HousekeepingTask - Return to History => Options
- Set History Cleanup to your desired retention period for History and Stats
¶ Category Not Available or Missing
- Please note that custom/non-standard indexer specific categories are mapped to standard ones, so searching will standard ones will incorporate all custom ones. Review your specific Indexer's category mapping definition for details.
¶ Can I add any (generic) Torrent RSS Feed
Yes. Use "TorrentRSS".
The following attributes are mandatory:
- guid
- title
- infohash
- enclosure or link
The following attributes are optional, but recommended:
- size
- pubDate
¶ Can I add any (generic) Torznab or Newznab indexer
- Yes.
- Go to
Indexers=>Add Indexer(+) =>Generic TorznaborGeneric Newznab
¶ Can I use flaresolverr indexers
- Yes.
- Configure your flaresolverr instance by adding it as a proxy in Settings => Indexers
- Add a tag to the created flaresolverr proxy
- Add the same tag to your Indexer
The tags must match & Cloudflare must be detected for Flaresolverr to be used. A Flaresolverr proxy is disabled if no tags are used.
See TRaSH's Guides on "How to setup Flaresolverr" for more details
¶ How can I add an indexer that is down or not functional
- Follow the standard steps to add the indexer noting the following changes.
- Uncheck (Disable) the
Enabledbox - Press
Save - Press
Saveagain to trigger a force save - Edit the Indexer (Wrench Icon)
- Check (Enable) the
Enabledbox - Press
Save - Press
Saveagain to trigger a force save
¶ Prowlarr will not sync to Sonarr
- Prowlarr only supports Sonarr v3+
- Sonarr v2 (fka nzbdrone) is not supported by Prowlarr nor supported in general and has been end-of-life since March 2021
¶ Prowlarr will not sync X Indexer to App
- Prowlarr only syncs if Add and Remove or Full Sync is enabled for the app.
- Only in instances where an App and Indexer have matching tags or no tags at all will an indexer be synced to an app
- Indexers are synced based on the capabilities/categories they claim to support.
- If an indexer supports only TV categories it will not be synced to Lidarr, Radarr, and Readarr.
- A given indexer will only be synced to Sonarr if "Supported" Categories can be selected as an advanced setting on a per app basis.
- Indexers will not be attempted to be synced if the specific Categories supported by the Indexer are not selected in Settings => Application => {App} => Sync Categories (Advanced Settings) and logs will not show any indication of a sync attempt.
- The most common cause for this is that the *Arrs only accept indexers whose test queries return results containing at least one of the configured categories. In other words, if you're syncing to an App and your indexer's empty query does not return results with any release within the categories configured for the App then it will be unable to add the indexer to *Arr.
- The specific error will be an HTTP 400 from *Arr stating
Query successful, but no results in the configured categories were returned from your indexer. This may be an issue with the indexer or your indexer category settings.- Possibly that indexer simply cannot be used with that *Arr. This is common for attempting to use public trackers or usenet indexers with Readarr and Lidarr.
- Adjust the categories synced in the advanced settings for the *Arr application within Prowlarr
- Note that certain Trackers - primarily "crappy" public trackers - require one to select and sync the
8000 - Othercategory. This is often - but not always - noted within the Tracker's details within Prowlarr.
- Note that certain Trackers - primarily "crappy" public trackers - require one to select and sync the
- Try again later
- If the issue persist you may have a corrupted database. Check your logs for instances of
Database disk image is malformedorError creating main database. See this heading for possible solutions.
¶ What *Arr Indexer Settings are Compared for App Full Sync
When Full Sync is enabled, Prowlarr compares the following settings between the *Arr app and Prowlarr to determine if an indexer needs to be updated:
¶ Sonarr
| Setting | Description | Code Reference |
|---|---|---|
| Indexer Name | The name of the indexer (with "(Prowlarr)" suffix) | SonarrIndexer.cs:71 |
| Enable RSS | Whether RSS feeds are enabled for the indexer | SonarrIndexer.cs:68 |
| Enable Automatic Search | Whether automatic searches are enabled | SonarrIndexer.cs:69 |
| Enable Interactive Search | Whether interactive (manual) searches are enabled | SonarrIndexer.cs:70 |
| Priority | Indexer priority for search order | SonarrIndexer.cs:73 |
| Implementation | Indexer protocol type (Newznab/Torznab) | SonarrIndexer.cs:72 |
| Base URL | The base URL for the indexer API endpoint | SonarrIndexer.cs:32 |
| API Path | The API path (typically "/api") | SonarrIndexer.cs:40-42 |
| API Key | Prowlarr's API key for authentication | SonarrIndexer.cs:36-38 |
| Categories | Supported categories mapped between Prowlarr and Sonarr | SonarrIndexer.cs:33 |
| Anime Categories | Anime-specific category mappings | SonarrIndexer.cs:34 |
| Anime Standard Format Search | Whether to use standard format for anime searches | SonarrIndexer.cs:44-46 |
| Minimum Seeders | Minimum number of seeders required (torrent indexers only) | SonarrIndexer.cs:48-50 |
| Seed Ratio | Seed ratio for torrent downloads | SonarrIndexer.cs:60-62 |
| Seed Time | Minimum seed time for torrents | SonarrIndexer.cs:52-54 |
| Season Pack Seed Time | Seed time for season packs | SonarrIndexer.cs:56-58 |
| Reject Blocklisted Torrent Hashes | Whether to reject blocklisted torrent hashes while grabbing | SonarrIndexer.cs:64-66 |
¶ Radarr
| Setting | Description | Code Reference |
|---|---|---|
| Indexer Name | The name of the indexer (with "(Prowlarr)" suffix) | RadarrIndexer.cs:61 |
| Enable RSS | Whether RSS feeds are enabled for the indexer | RadarrIndexer.cs:58 |
| Enable Automatic Search | Whether automatic searches are enabled | RadarrIndexer.cs:59 |
| Enable Interactive Search | Whether interactive (manual) searches are enabled | RadarrIndexer.cs:60 |
| Priority | Indexer priority for search order | RadarrIndexer.cs:63 |
| Implementation | Indexer protocol type (Newznab/Torznab) | RadarrIndexer.cs:62 |
| Base URL | The base URL for the indexer API endpoint | RadarrIndexer.cs:31 |
| API Path | The API path (typically "/api") | RadarrIndexer.cs:38-40 |
| API Key | Prowlarr's API key for authentication | RadarrIndexer.cs:34-36 |
| Categories | Supported categories mapped between Prowlarr and Radarr | RadarrIndexer.cs:32 |
| Minimum Seeders | Minimum number of seeders required (torrent indexers only) | RadarrIndexer.cs:42-44 |
| Seed Ratio | Seed ratio for torrent downloads | RadarrIndexer.cs:50-52 |
| Seed Time | Minimum seed time for torrents | RadarrIndexer.cs:46-48 |
| Reject Blocklisted Torrent Hashes | Whether to reject blocklisted torrent hashes while grabbing | RadarrIndexer.cs:54-56 |
¶ Lidarr
| Setting | Description | Code Reference |
|---|---|---|
| Indexer Name | The name of the indexer (with "(Prowlarr)" suffix) | LidarrIndexer.cs:65 |
| Enable RSS | Whether RSS feeds are enabled for the indexer | LidarrIndexer.cs:62 |
| Enable Automatic Search | Whether automatic searches are enabled | LidarrIndexer.cs:63 |
| Enable Interactive Search | Whether interactive (manual) searches are enabled | LidarrIndexer.cs:64 |
| Priority | Indexer priority for search order | LidarrIndexer.cs:67 |
| Implementation | Indexer protocol type (Newznab/Torznab) | LidarrIndexer.cs:66 |
| Base URL | The base URL for the indexer API endpoint | LidarrIndexer.cs:31 |
| API Path | The API path (typically "/api") | LidarrIndexer.cs:38-40 |
| API Key | Prowlarr's API key for authentication | LidarrIndexer.cs:34-36 |
| Categories | Supported categories mapped between Prowlarr and Lidarr | LidarrIndexer.cs:32 |
| Minimum Seeders | Minimum number of seeders required (torrent indexers only) | LidarrIndexer.cs:42-44 |
| Seed Ratio | Seed ratio for torrent downloads | LidarrIndexer.cs:54-56 |
| Seed Time | Minimum seed time for torrents | LidarrIndexer.cs:46-48 |
| Discography Seed Time | Seed time for discography downloads | LidarrIndexer.cs:50-52 |
| Reject Blocklisted Torrent Hashes | Whether to reject blocklisted torrent hashes while grabbing | LidarrIndexer.cs:58-60 |
With Full Sync enabled, if any of the above settings differ between the *Arr app and Prowlarr, the indexer will be synced and updated in the *Arr app.
¶ How do I update Prowlarr
- Go to Settings and then the General tab and show advanced settings (use the toggle by the save button).
- Under the Updates section change the branch name to
master,develop, ornightly - Save
This will not install the bits from that branch immediately, it will happen during the next update.
-
master-- (Default/Stable): It has been tested by users on the develop and nightly branches and it’s not known to have any major issues. On GitHub, this is the
masterbranch. -
develop-- (Beta): This is the testing edge. Released after tested in nightly to ensure no immediate issues. New features and bug fixes released here first after nightly. It can be considered semi-stable, but is still
beta.
On GitHub, this is a snapshot of the
developbranch at a specific point in time and is tagged as pre-release.
nightly-- (Alpha/Unstable): This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch. Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update. This version is updated immediately.
Warning: You may not be able to go back to
developafter switching to this branch. On GitHub, this is thedevelopbranch.
- Note: If your install is through Docker append
:latest,:testing,:develop, or:nightlyto the end of your container tag depending on who makes your builds.
master (stable) |
develop (beta) |
nightly (unstable) |
|
|---|---|---|---|
| hotio | latest |
testing |
nightly |
| LinuxServer.io | latest |
develop |
nightly |
¶ Can I update Prowlarr inside my Docker container
- Technically, yes. But you absolutely should not. It is a primary philosophy of Docker. Database issues can arise if you upgrade your installation inside to the most recent
nightly, but then update the Docker container itself (possibly downgrading to an older version).
¶ Installing a newer version
¶ Native
- Go to System and then the Updates tab
- Newer versions that are not yet installed will have an update button next to them, clicking that button will install the update.
¶ Docker
- Repull your tag and update your container
¶ Can I switch from nightly back to develop
- See Can I switch between branches? below.
¶ Can I switch between branches
- If version is identical you can switch, otherwise check with the development team to see if you can switch from
nightlytodevelop; ordeveloptonightlyfor your given build. - Failure to follow these instructions may result in your Prowlarr becoming unusable or throwing errors. You have been warned
- The most common errors are database errors around missing columns or tables.
¶ Help, my Mac says Prowlarr cannot be opened because the developer cannot be verified
- This is simple, please see the Mac help documentation for more information
- Alternatively, you may need to self-sign Prowlarr
codesign --force --deep -s - /Applications/Prowlarr.app && xattr -rd com.apple.quarantine
¶ Help, my Mac says Prowlarr.app is damaged and can’t be opened
That is either due to a corrupt download (so try again), or security issues answered just above this.
¶ How do I request a feature for Prowlarr
To request a feature for Prowlarr, first search on GitHub to ensure no similar request exists, then submit a feature request on GitHub to add your request.
¶ I am getting an error: Database disk image is malformed
- Errors of
Error creating log databaseindicate issues with logs.db- This can quickly be resolved by renaming or removing the database. The logs database contains unimportant information regarding commands history and update install history, and Info, Warn, and Error entries
- Errors of
Error creating main databaseor genericdatabase disk image is malformedwith no specified database indicate issues with prowlarr.db- Continue with the steps noted below
- This means your SQLite database that stores most of the information for Prowlarr is corrupt. Your options are to try (a) backup(s), try recovering the existing database, try recovering the backup(s), or if all else fails starting over with a fresh new database.
- This error may show if the database file is not writable by the user/group *Arr is running as. Permissions being the cause will likely only be an issue for new installs, migrated installs to a new server, if you recently modified your appdata directory permissions, or if you changed the user and group *Arr run as.
- Your best and first option is to try restoring from a backup
- You can also try recovering your database. This is typically the only option for when this issue occurs after an update. Try the sqlite3
.recovercommand- If your sqlite does not have
.recoveror you wish a more GUI (i.e. Windows) friendly way then follow our instructions on this wiki.
- If your sqlite does not have
- Another possible cause of you getting an error with your Database is that you're placing your database on a network drive (nfs or smb or something else not local). SQLite is designed for situations where the data and application coexist on the same machine. Thus your *Arr AppData Folder (/config mount for docker) MUST be on local storage. SQLite and network drives not play nice together and will cause a malformed database eventually.
- If you are using mergerFS you need to remove
direct_ioas SQLite uses mmap which isn’t supported bydirect_ioas explained in the mergerFS docs here
¶ I use Prowlarr on a Mac and it suddenly stopped working. What happened
- Most likely this is due to a MacOS bug which caused the Prowlarr database to be corrupted. Please check the FAQ entry for restoring a corrupt database.
¶ How do I change from the Windows Service to a Tray App
- Shut Prowlarr down
- Run serviceuninstall.exe that's in the Prowlarr directory
- Run Prowlarr.exe as an administrator once to give it proper permissions and open the firewall. Once complete, then you can close it and run it normally.
- (Optional) Drop a shortcut to Prowlarr.exe in the startup folder to auto-start on boot.
¶ How do I Backup/Restore Prowlarr
¶ Backing up Prowlarr
¶ Using built-in backup
- Go to System => Backup in the Prowlarr UI
- Click the Backup button
- Download the zip after the backup is created for safekeeping
¶ Using file system directly
- Find the location of the AppData directory for Prowlarr
- Via the Prowlarr UI go to System => About
- Prowlarr Appdata Directory
- Stop Prowlarr - This will prevent the database from being corrupted
- Copy the contents to a safe location
¶ Restoring from Backup
Restoring to an OS that uses different paths will not work (Windows to Linux, Linux to Windows, Windows to OS X or OS X to Windows), moving between OS X and Linux may work, since both use paths containing
/instead of\that Windows uses, but is not supported. You'll need to manually edit all paths in the database.
¶ Using zip backup
- Re-install Prowlarr (if applicable / not already installed)
- Run Prowlarr
- Navigate to System => Backup
- Select Restore Backup
- Select Choose File
- Select your backup zip file
- Select Restore
¶ Using file system backup
- Re-install Prowlarr (if applicable / not already installed)
- Find the location of the AppData directory for Prowlarr
- Running Prowlarr once and via the UI go to System => About
- Prowlarr Appdata Directory
- Stop Prowlarr
- Delete the contents of the AppData directory (Including the .db-wal/.db-journal files if they exist)
- Restore from your backup
- Start Prowlarr
- As long as the paths are the same, everything will pick up where it left off
¶ File System Restore on Synology NAS
CAUTION: Restoring on a Synology requires knowledge of Linux and Root SSH access to the Synology Device.
- Re-install Prowlarr (if applicable / not already installed)
- Find the location of the AppData directory for Prowlarr
- Running Prowlarr once and via the UI go to System => About
- Prowlarr Appdata Directory
- Stop Prowlarr
- Connect to the Synology NAS through SSH and log in as root
On some installations, the user is different than the below commands:
chown -R sc-Prowlarr:Prowlarr *
-
Execute the following commands:
rm -r /usr/local/Prowlarr/var/.config/Prowlarr/Prowlarr.db cp -f /tmp/Prowlarr_backup/* /usr/local/Prowlarr/var/.config/Prowlarr/ -
Update permissions on the files:
cd /usr/local/Prowlarr/var/.config/Prowlarr/ chown -R Prowlarr:users * chmod -R 0644 * -
Start Prowlarr
¶ WebUI only Loads at localhost on Windows
If you can only reach your web interface at http://localhost:9696/ or http://127.0.0.1:9696, you need to run Prowlarr as Administrator at least once, maybe even always.
¶ Finding Cookies
Some sites cannot be logged into automatically and require you to login manually then give the cookies to Prowlarr to work. Please see this article for details.
¶ I got a pop-up that said config.xml was corrupt, what now
Prowlarr was unable to read your config file on start-up as it became corrupted somehow. In order to get Prowlarr back online, you will need to delete .xml in your AppData Folder, once deleted start Prowlarr and it will start on the default port (9696), you should now re-configure any settings you configured on the General Settings page.
¶ Invalid Certificate and other HTTPS or SSL issues
Your download client stopped working and you're getting an error like Localhost is an invalid certificate?
Prowlarr validates SSL certificates. If there is no SSL certificate set in the download client, or you're using a self-signed https certificate without the CA certificate added to your local certificate store, then Prowlarr will refuse to connect. Free properly signed certificates are available from let's encrypt.
If your download client and Prowlarr are on the same machine there is no reason to use HTTPS, so the easiest solution is to disable SSL for the connection. Most would agree it's not required on a local network either. It is possible to disable certificate validation in advanced settings if you want to keep an insecure SSL setup.
¶ Help I have locked myself out
- Close Prowlarr
- Open config.xml in a text editor
- Find the authentication method line will be
<AuthenticationMethod>Basic</AuthenticationMethod>or<AuthenticationMethod>Forms</AuthenticationMethod>
(Be sure that you do not have two AuthenticationMethod entries in your file) - Change the
AuthenticationMethodline to<AuthenticationMethod>External</AuthenticationMethod> - Restart Prowlarr
- Prowlarr will now be accessible without a password, you should go the
Settings=>Generalin the UI, change the Authentication Method to Forms and set your new username and password
¶ Weird UI Issues
- If you experience any weird UI issues or a certain view or sort not working, try viewing in a Chrome Incognito Window or Firefox Private Window. If it works fine there, clear your browser cache and cookies for your specific ip/domain. For more information, see the Clear Cache Cookies and Local Storage wiki article.
¶ VPNs, Jackett, and the *ARRs
For comprehensive VPN guidance, see the dedicated VPN Guide page.
- Unless you're in a repressive country like China or Australia, your BitTorrent client is typically the only thing that needs to be behind a VPN. Usenet does not require VPN protection as it uses encrypted SSL connections. For most countries including the UK, using secure DNS (like Cloudflare's 1.1.1.1 or Google's 8.8.8.8) is sufficient to resolve access issues without requiring a VPN. Other *Arr apps not connecting to trackers should not be behind a VPN. Because the VPN endpoint is shared by many users, you can and will experience rate limiting, DDOS protection, and ip bans from various services each software uses.
To be clear it is not a matter if VPNs will cause issues with the *Arrs, but when: image providers will block you and cloudflare is in front of most of *Arr servers (updates, metadata, etc.) and liable to block you too
- Many private trackers will ban you for using or accessing them (i.e. using Jackett or Prowlarr) via a VPN.
¶ How do I stop the browser from launching on startup
Depending on your OS, there are multiple possible ways.
- In
Settings=>Generalon some OS'es, there is a checkbox to launch the browser on startup. - When invoking Prowlarr, you can add
-nobrowser(*nix) or/nobrowser(Windows) to the arguments. - Stop Prowlarr and edit the config.xml file, and change
<LaunchBrowser>True</LaunchBrowser>to<LaunchBrowser>False</LaunchBrowser>.
¶ Can I easily add all indexers at once
No. This would not be a good thing to do, and this functionality will not be added. It is much better to choose your indexers wisely, pay attention to the stats to remove indexers that are too slow or not producing grabs. Proper pruning and maintenance of your indexers will result in much better results overall, and quicker results on searches from your apps.