diff --git a/lidarr/environment-variables.md b/lidarr/environment-variables.md index 943387220..99a48cc1c 100644 --- a/lidarr/environment-variables.md +++ b/lidarr/environment-variables.md @@ -59,11 +59,13 @@ The config namespaces are shared between all Servarr apps and correspond to the | `PostgresLogDbConnectionString` | `POSTGRES` | `LOGDBCONNECTIONSTRING` | `LIDARR__POSTGRES__LOGDBCONNECTIONSTRING` | | `UrlBase` | `SERVER` | `URLBASE` | `LIDARR__SERVER__URLBASE` | | `BindAddress` | `SERVER` | `BINDADDRESS` | `LIDARR__SERVER__BINDADDRESS` | +| `AllowedHosts` | `SERVER` | `ALLOWEDHOSTS` | `LIDARR__SERVER__ALLOWEDHOSTS` | | `Port` | `SERVER` | `PORT` | `LIDARR__SERVER__PORT` | | `EnableSsl` | `SERVER` | `ENABLESSL` | `LIDARR__SERVER__ENABLESSL` | | `SslPort` | `SERVER` | `SSLPORT` | `LIDARR__SERVER__SSLPORT` | | `SslCertPath` | `SERVER` | `SSLCERTPATH` | `LIDARR__SERVER__SSLCERTPATH` | | `SslCertPassword` | `SERVER` | `SSLCERTPASSWORD` | `LIDARR__SERVER__SSLCERTPASSWORD` | +| `TrustedNetworks` | `SERVER` | `TRUSTEDNETWORKS` | `LIDARR__SERVER__TRUSTEDNETWORKS` | | `UpdateMechanism` | `UPDATE` | `MECHANISM` | `LIDARR__UPDATE__MECHANISM` | | `UpdateAutomatically` | `UPDATE` | `AUTOMATICALLY` | `LIDARR__UPDATE__AUTOMATICALLY` | | `UpdateScriptPath` | `UPDATE` | `SCRIPTPATH` | `LIDARR__UPDATE__SCRIPTPATH` | diff --git a/lidarr/faq.md b/lidarr/faq.md index e971f8e1f..214266ffe 100644 --- a/lidarr/faq.md +++ b/lidarr/faq.md @@ -284,11 +284,11 @@ See the dedicated [VPN Guide](/vpn). Short version: only your BitTorrent client If Lidarr is reachable from outside your LAN, enable authentication. Trackers and indexers increasingly require it. -As of Lidarr v2, **authentication is mandatory.** The config file must include `AuthenticationType` and `AuthenticationMethod`. +As of Lidarr v2, **authentication is mandatory.** The config file must include `AuthenticationMethod` and `AuthenticationRequired`. #### Authentication Method -- `Basic` — browser-native username/password pop-up. Deprecated; a future major version will drop it. +- `Basic` - browser-native username/password pop-up. Removed in Lidarr v3.0.0; an existing `Basic` config is converted to `Forms` on load. - `Forms` — login page. Recommended for all UI-exposed installs. - `External` — disables app authentication entirely. Only use this for installs behind an external authentication layer (Authelia, Authentik, nginx auth). Configurable via the config file only. Don't use this unless the external auth is actually enforced on the request path. diff --git a/lidarr/naming-guide.md b/lidarr/naming-guide.md index 29485b870..d685c0a5c 100644 --- a/lidarr/naming-guide.md +++ b/lidarr/naming-guide.md @@ -55,6 +55,8 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso | `{Artist CleanNameThe}` | Clean artist name with "The" moved to the end. | | `{Artist Disambiguation}` | Disambiguation string from MusicBrainz, for example, `UK band`. Empty for most artists. | | `{Artist Genre}` | First genre tag associated with the artist. | +| `{Artist NameFirstCharacter}` | First character of the artist's name, with a leading "The" moved to the end before taking the character. Useful for A-Z folder sorting. | +| `{Artist MbId}` | The artist's MusicBrainz identifier. | ## Album tokens @@ -67,6 +69,7 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso | `{Album Disambiguation}` | Disambiguation string from MusicBrainz. Useful when an artist has two albums with the same name. | | `{Album Type}` | Release group type: Album, Single, EP, Compilation, Live, Remix, Soundtrack, etc. | | `{Album Genre}` | First genre tag for the album. | +| `{Album MbId}` | The album's (release group's) MusicBrainz identifier. | | `{Release Year}` | Four-digit release year. | ## Track tokens @@ -74,8 +77,12 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso | Token | Description | |---|---| | `{Track Title}` | Track title. | +| `{Track CleanTitle}` | Track title with illegal filesystem characters removed. | | `{Track ArtistName}` | Track-level artist name. Useful for Various Artists compilations where each track has a different credited artist. | +| `{Track ArtistCleanName}` | Track-level artist name with illegal filesystem characters removed. | | `{Track ArtistNameThe}` | Track artist name with "The" moved to the end. | +| `{Track ArtistCleanNameThe}` | Clean track-level artist name with "The" moved to the end. | +| `{Track ArtistMbId}` | The track-level artist's MusicBrainz identifier. | | `{track:00}` | Track number zero-padded to 2 digits (01, 02 … 99). Use `{track:000}` for 3-digit padding on large releases. | ## Medium (disc) tokens @@ -84,6 +91,7 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso |---|---| | `{medium:0}` | Disc number, single digit. | | `{medium:00}` | Disc number zero-padded to 2 digits. | +| `{Medium Name}` | The disc's title as stored in MusicBrainz, distinct from `{Medium Format}` (the physical media type). | | `{Medium Format}` | Physical format of the disc: CD, Vinyl, Digital Media, etc. | ## Quality and technical tokens @@ -92,7 +100,9 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso |---|---| | `{Quality Title}` | Quality profile name as defined in Lidarr (for example, FLAC, MP3-320). | | `{Quality Full}` | Full quality string including proper/repack designation. | +| `{Quality Proper}` | Proper/repack designation for the track's quality, for example `Proper`. Empty when the release wasn't a proper. | | `{MediaInfo AudioBitRate}` | Audio bitrate (for example, 320kbps). Only available after import; blank on pre-import rename previews. | +| `{MediaInfo AudioBitsPerSample}` | Audio bit depth (for example, 16bit). | | `{MediaInfo AudioChannels}` | Number of audio channels. | | `{MediaInfo AudioCodec}` | Audio codec (for example, FLAC, MP3). | | `{MediaInfo AudioSampleRate}` | Audio sample rate (for example, 44100Hz). | @@ -101,8 +111,11 @@ Wrap tokens in `{}`. Lidarr substitutes them at import time. Any token that reso | Token | Description | |---|---| +| `{Original Title}` | The original release title as parsed from the track file's release name. | +| `{Original Filename}` | The literal original filename of the imported file, unmodified. | | `{Release Group}` | Ripping or encoding group tag from the file. | -| `{Preferred Words}` | Matched preferred words from Release Profiles, joined by spaces. | +| `{Custom Formats}` | Every Custom Format that matched the release and has "Include Custom Format when Renaming" enabled, joined by spaces. | +| `{Custom Format:Name}` | A single named Custom Format. `Name` is a placeholder for the exact Custom Format name, for example `{Custom Format:FLAC}`. Produces no output unless a format with that name matched and has "Include Custom Format when Renaming" enabled. | # Community naming conventions diff --git a/lidarr/settings.md b/lidarr/settings.md index dea58ae81..d96799ed4 100644 --- a/lidarr/settings.md +++ b/lidarr/settings.md @@ -350,7 +350,8 @@ Lidarr can set seed ratio and time goals via the torrent client's API when you a | Setting | Description | |---|---| | **Enable** (Advanced, global) | Automatically import completed downloads from the download client. Disabling this means Lidarr will never import anything, so leave it enabled unless you have a specific reason to disable it. | -| **Remove** (per-client) | After import, ask the download client to remove the completed item. For torrents, removal only occurs when the client reports seeding is complete and the torrent is paused/stopped. | +| **Remove Completed** (per-client) | After import, ask the download client to remove the completed item from its history. For torrents, removal only occurs when the client reports seeding is complete and the torrent is paused/stopped. | +| **Remove Failed** (per-client) | Remove failed downloads from the download client's history. | ### Failed Download Handling @@ -358,7 +359,8 @@ Failed download handling is available for SABnzbd and NZBGet only. It isn't supp | Setting | Description | |---|---| -| **Redownload** | When a download fails, automatically search for a replacement. | +| **Redownload Failed** | When a download fails, automatically search for a replacement. | +| **(Advanced) Redownload Failed from Interactive Search** | Only shown when Redownload Failed is enabled. Automatically search for and attempt to download a different release when the failed release was grabbed from an interactive search. | | **(Advanced) Remove** | Remove the failed download from the client when Lidarr detects the failure. | When Lidarr detects a failure, it logs it, optionally removes the failed item, searches for a replacement, and blocklists the failed release so it isn't grabbed again automatically. @@ -388,6 +390,8 @@ Click **Add (+)** and select a connection type. Most connections share these fie | **Name** | Label for this connection. | | **On Grab** | Trigger when Lidarr sends a release to a download client. | | **On Release Import** | Trigger when a downloaded release is successfully imported. | +| **On Download Failure** | Trigger when a download fails. | +| **On Import Failure** | Trigger when an import fails. | | **On Upgrade** | Trigger when Lidarr upgrades a file to better quality. | | **On Rename** | Trigger when Lidarr renames files. | | **On Artist Added** | Trigger when you add an artist to Lidarr. | @@ -460,6 +464,32 @@ General settings live under **Settings → General**. - A blank value is accepted only when Authentication Required is `Enabled`; otherwise at least one host is required and a blank value is rejected on save. - Enable SSL - If you have SSL credentials and would like to secure communication to and from Lidarr, enable this option. +## Security + +{#security} + +- Authentication - How would you like to authenticate to access your Lidarr instance + - None - You have no authentication to access your Lidarr. Typically if you're the only user of your network, do not have anybody on your network that would care to access your Lidarr or your Lidarr is not exposed to the web + - Basic (Browser pop-up) - Removed in Lidarr v3.0.0; an existing `Basic` value in the config is converted to `Forms` on load. Previously a browser username/password pop-up. + - Forms (Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Lidarr + - External - Hands authentication off entirely to a reverse proxy (e.g. Authelia, Organizr) placed in front of Lidarr. Not selectable in the UI; set it via `config.xml` or the `LIDARR__AUTH__METHOD` environment variable. Lidarr performs no authentication of its own in this mode, so Authentication Required and Trust CGNAT IP Addresses have no effect +- Authentication Required - Controls which requests must authenticate. Do not change this unless you understand the risks. + - Enabled - Always require authentication (recommended) + - Disabled for Local Addresses - Skip authentication for requests Lidarr identifies as coming from localhost or the LAN + +> With Authentication Required set to `Disabled for Local Addresses`, a request that spoofs the `X-Forwarded-For` header can appear local and skip authentication unless Lidarr is behind a properly configured reverse proxy whose address is listed under Trusted Networks below. Lidarr only trusts `X-Forwarded-For` from addresses in that list. If you do not run a trusted reverse proxy, set Authentication Required to `Enabled`, or put Lidarr behind a VPN or Tailscale rather than exposing it directly. +{.is-warning} + +- API Key - This is how other programs would communicate or have Lidarr communicate to other programs. This key if given to the wrong person with access could do all kinds of things to your library. This is why in the logs the API key is redacted +- Certificate Validation - Change how strict HTTPS certification validation is + - Enabled - Validate all HTTPS certificates (recommended) + - Disabled for Local Addresses - Validate all HTTPS certificates except those on localhost and the LAN + - Disabled - Do not validate any HTTPS certificates +- Trusted Networks - Comma-separated list of IP addresses or CIDR networks that trusted reverse proxies are on (for example `172.17.0.1`, `10.0.0.0/8`, or `fc00::/7`). Lidarr only trusts the `X-Forwarded-For` header from these addresses. Only add proxies that are properly configured to send the correct headers. + +> Trust CGNAT IP Addresses - Not exposed in the UI. Set via `config.xml` or the `LIDARR__AUTH__TRUSTCGNATIPADDRESSES` environment variable (default `false`). When enabled, Lidarr treats CGNAT addresses (`100.64.0.0/10`, the range Tailscale uses) as local for the Authentication Required `Disabled for Local Addresses` check. It has no effect with any other Authentication Required or Authentication setting. +{.is-info} + # Logging {#logging} diff --git a/lidarr/system.md b/lidarr/system.md index 635b064f8..a3080163e 100644 --- a/lidarr/system.md +++ b/lidarr/system.md @@ -14,18 +14,11 @@ dateCreated: 2021-06-14T21:36:28.225Z - [Status](#status) - [Health](#health) - [System Warnings](#system-warnings) - - [Branch isn't a valid release branch](#branch-is-not-a-valid-release-branch) - - [Update to .NET version](#update-to-net-version) - - [Fixing Docker installs](#fixing-docker-installs) - - [Fixing Standalone installs](#fixing-standalone-installs) - - [Currently installed mono version is old and unsupported](#currently-installed-mono-version-is-old-and-unsupported) - - [Currently installed SQLite version isn't supported](#currently-installed-sqlite-version-is-not-supported) - [New update is available](#new-update-is-available) - [Can't install update because startup folder is in an App Translocation folder (macOS)](#cannot-install-update-because-startup-folder-is-in-an-app-translocation-folder-macos) - [Can't install update because startup folder isn't writable by the user](#cannot-install-update-because-startup-folder-is-not-writable-by-the-user) - [Can't install update because UI folder isn't writable by the user](#cannot-install-update-because-ui-folder-is-not-writable-by-the-user) - [Updating won't be possible to prevent deleting AppData on Update](#updating-will-not-be-possible-to-prevent-deleting-appdata-on-update) - - [Branch is for a previous version](#branch-is-for-a-previous-version) - [Couldn't connect to signalR](#could-not-connect-to-signalr) - [NGINX](#nginx) - [Apache](#apache) @@ -33,8 +26,6 @@ dateCreated: 2021-06-14T21:36:28.225Z - [Failed to resolve the IP Address for the Configured Proxy Host](#failed-to-resolve-the-ip-address-for-the-configured-proxy-host) - [Proxy Failed Test](#proxy-failed-test) - [System Time is off by more than 1 day](#system-time-is-off-by-more-than-1-day) - - [Mono Legacy TLS enabled](#mono-legacy-tls-enabled) - - [Mono and x86 builds are ending](#mono-and-x86-builds-are-ending) - [FPcalc is missing](#fpcalc-is-missing) - [FPcalc needs updating](#fpcalc-needs-updating) - [API Key is too short](#api-key-is-too-short) @@ -61,7 +52,6 @@ dateCreated: 2021-06-14T21:36:28.225Z - [No indexers available with automatic search enabled, Lidarr won't provide any automatic search results](#no-indexers-available-with-automatic-search-enabled-lidarr-will-not-provide-any-automatic-search-results) - [No indexers available with RSS sync enabled, Lidarr won't grab new releases automatically](#no-indexers-available-with-rss-sync-enabled-lidarr-will-not-grab-new-releases-automatically) - [No indexers are enabled](#no-indexers-are-enabled) - - [Enabled indexers don't support searching](#enabled-indexers-do-not-support-searching) - [No indexers Available with Interactive Search Enabled](#no-indexers-available-with-interactive-search-enabled) - [Indexers are unavailable due to failures](#indexers-are-unavailable-due-to-failures) - [Jackett All Endpoint Used](#jackett-all-endpoint-used) @@ -97,86 +87,6 @@ This page lists health check results. Lidarr runs these checks periodically and ### System Warnings -#### Branch isn't a valid release branch - -The branch you have set isn't a valid release branch. You won't receive updates. Please change to one of the [current release branches](/lidarr/faq#how-do-i-update-lidarr). - -#### Update to .NET version - -{#update-to-net-core-version} - -- Newer versions of Lidarr target .NET6 or newer. Legacy mono builds end after the 1.0 release. You are running one of these legacy builds but your platform supports .NET. - -##### Fixing Docker installs - -- Re-pull your container - -##### Fixing Standalone installs - -- Back-Up your existing configuration before the next step. -- This should only happen on Linux hosts. Don't install .NET runtime or SDK from Microsoft. -- To remedy, download the correct build for your architecture and replace your existing binaries (application) -- In short you will need to delete your existing binaries (contents or folder of /opt/Lidarr) and replace with the contents of the .tar.gz you just downloaded. - -> DON'T JUST EXTRACT THE DOWNLOAD OVER THE TOP OF YOUR EXISTING BINARIES. -> YOU MUST DELETE THE OLD ONES FIRST. -{.is-warning} - -- The below is a community developed script to remove your mono installation and replace it with the .NET installation. Contributions and corrections are welcome. -- This assumes you are on the `master` Lidarr branch update the variable if needed -- This assumes that Lidarr runs as the user `lidarr` update the variables if needed -- This assumes you installed Lidarr at `/opt/Lidarr`; update the variables if needed - -```bash -#!/bin/bash -## User Variables -installdir="/opt/Lidarr" -APPUSER="lidarr" -branch="master" -## /User Variables -app="lidarr" -ARCH=$(dpkg --print-architecture) -# Stop \*arr -sudo systemctl stop $app -# get arch -dlbase="https://$app.servarr.com/v1/update/$branch/updatefile?os=linux&runtime=netcore" -case "$ARCH" in -"amd64") DLURL="${dlbase}&arch=x64" ;; -"armhf") DLURL="${dlbase}&arch=arm" ;; -"arm64") DLURL="${dlbase}&arch=arm64" ;; -*) - echo_error "Arch not supported" - exit 1 - ;; -esac -echo "Downloading..." -wget --content-disposition "$DLURL" -tar -xvzf ${app^}.*.tar.gz -echo "Installation files downloaded and extracted" -echo "Moving existing installation" -sudo mv "$installdir/" "$installdir.old/" -echo "Installing..." -sudo mv "${app^}" "$installdir" -sudo chown $APPUSER:$APPUSER -R $installdir -sudo sed -i "s|ExecStart=/usr/bin/mono --debug /opt/${app^}/${app^}.exe|ExecStart=/opt/${app^}/${app^}|g" /etc/systemd/system/$app.service -sudo sed -i "s|ExecStart=/usr/bin/mono /opt/${app^}/${app^}.exe|ExecStart=/opt/${app^}/${app^}|g" /etc/systemd/system/$app.service -sudo systemctl daemon-reload -echo "App Installed" -sudo rm -rf "$installdir.old/" -rm -rf "${app^}.*.tar.gz" -sudo systemctl start $app -``` - -#### Currently installed mono version is old and unsupported - -- Lidarr uses .NET and requires Mono to run on old ARM processors. Please note that Mono builds are no longer supported after v1.0 -- Lidarr requires at least Mono 5.20. -- The upgrade procedure for Mono varies per platform. - -#### Currently installed SQLite version isn't supported - -- Lidarr stores its data in an SQLite database. The SQLite3 library installed on your system is too old. Lidarr requires at least version 3.9.0. Note that Lidarr uses `libSQLite3.so`, which may not come with a SQLite3 upgrade package. - #### New update is available - A new version of Lidarr is available. If autoupdating is enabled, Lidarr will install it automatically. Otherwise, go to `System => Updates` and press Install. @@ -192,26 +102,30 @@ sudo systemctl start $app #### Can’t install update because startup folder isn’t writable by the user +{#cannot-install-update-because-startup-folder-is-not-writable-by-the-user} + - This means Lidarr will be unable to update itself. You’ll have to update Lidarr manually or set the permissions on Lidarr’s Startup directory (the installation directory) to allow Lidarr to update itself. #### Can’t install update because UI folder isn’t writable by the user +{#cannot-install-update-because-ui-folder-is-not-writable-by-the-user} + - This means Lidarr will be unable to update itself. You’ll have to update Lidarr manually or set the permissions on Lidarr’s UI directory to allow Lidarr to update itself. #### Updating won’t be possible to prevent deleting AppData on Update +{#updating-will-not-be-possible-to-prevent-deleting-appdata-on-update} + - Lidarr detected that the AppData folder sits inside the directory that contains the Lidarr binaries. Normally it would be `C:\ProgramData` for Windows and `~/.config` for Linux. - Please look at `System => Info` to see the current AppData & Startup directories. - This means Lidarr will be unable to update itself without risking data loss. - If you’re on linux, you’ll probably have to change the home directory for the user that's running Lidarr and copy the current contents of the `~/.config/Lidarr` directory to preserve your database. -#### Branch is for a previous version - -- The update branch setup in `Settings => General` is for a previous version of Lidarr, so the instance won't see correct update information in the `System => Updates` feed and may not receive new updates when released. - #### Couldn't connect to signalR +{#could-not-connect-to-signalr} + - signalR drives the dynamic UI updates, so if your browser can't connect to signalR on your server you won’t see any real time updates in the UI. - The most common occurrence of this is use of a reverse proxy or Cloudflare. @@ -273,14 +187,6 @@ RewriteRule /(.*) ws://127.0.0.1:8686/$1 [P,L] - System time is off by more than 1 day. Scheduled tasks may not run correctly until you correct the time - Review your system time and ensure it's synced to an authoritative time server and accurate -#### Mono Legacy TLS enabled - -- Mono 4.x tls workaround still enabled, consider removing `MONO_TLS_PROVIDER=legacy` environment option - -#### Mono and x86 builds are ending - -- The next build of the application won't support Mono or x86. If you are receiving this error then you are running the mono version of the application or the x86 version. Due to increasing difficulty supporting these legacy versions, support and releases for them have ended. Upgrade to a supported operating system that doesn't require x86 or Mono. You may also be able to explore using Docker for your needs. - #### FPcalc is missing {#fpcalc-missing} @@ -358,6 +264,8 @@ chmod +x /opt/Lidarr/fpcalc #### Download clients are unavailable due to failure +{#download-clients-are-unavailable-due-to-failures} + - One or more of your download clients isn't responding to requests made by Lidarr. Lidarr has temporarily stopped querying the download client on its normal 1-minute cycle, which is normally used to track active downloads and import finished ones. Lidarr will still attempt to send downloads to the client, but will likely fail. - You should inspect `System=>Logs` to see what the reason is for the failures. - If you no longer use this download client, disable it in Lidarr to prevent the errors. @@ -414,17 +322,22 @@ chmod +x /opt/Lidarr/fpcalc #### Remote File was removed part way through processing +{#remote-path-file-removed} + - A file accessible via a remote path map appears to have disappeared before processing completed. #### Remote Path is Used and Import Failed +{#remote-path-import-failed} + - Check your logs for more info. Refer to the [Troubleshooting Guides](/lidarr/troubleshooting). #### Download Folder Same as Library Folder {#download-folder-and-library-folder-not-different-folders} -- Your download client is configured to sort completed downloads into a folder that is the same as (or is inside) your Lidarr library/root folder. Sorting completed downloads into your library folder can cause issues. Disable sorting in your download client or choose a download destination that is separate from your library folder. +- This warning is triggered by the download client's own automatic sorting feature (for example TV, Movie, or Date sorting) being enabled for the category Lidarr uses, not by the download folder and library folder being the same path. +- Disable the automatic sorting option in your download client for the category Lidarr uses, and let Lidarr handle organizing completed downloads into your library instead. ### Completed/Failed Download Handling @@ -444,11 +357,15 @@ chmod +x /opt/Lidarr/fpcalc #### No indexers available with automatic search enabled, Lidarr won't provide any automatic search results +{#no-indexers-available-with-automatic-search-enabled-lidarr-will-not-provide-any-automatic-search-results} + - None of your indexers allow automatic searches. - Go into `Settings => Indexers`, select an indexer you'd like to allow Automatic Searches and then click save. #### No indexers available with RSS sync enabled, Lidarr won't grab new releases automatically +{#no-indexers-available-with-rss-sync-enabled-lidarr-will-not-grab-new-releases-automatically} + - Lidarr uses the RSS feed to pick up new releases as they come along. - To correct this issue, go to `Settings => Indexers`, select an indexer, and enable RSS Sync. @@ -456,10 +373,6 @@ chmod +x /opt/Lidarr/fpcalc - Lidarr requires indexers to discover new releases. See [Settings => Indexers](/lidarr/settings#indexers) for instructions on adding them. -### Enabled indexers don't support searching - -- None of the indexers you have enabled support searching. This means Lidarr will only be able to find new releases via the RSS feeds. But searching for releases (either Automatic Search or Manual Search) will never return any results. The only way to fix this is to add another indexer. - #### No indexers Available with Interactive Search Enabled - None of the indexers you have enabled support interactive searching. This means the application will only be able to find new releases via the RSS feeds or an automatic search. @@ -518,7 +431,7 @@ chmod +x /opt/Lidarr/fpcalc #### Artist Mount is Read Only -{#artist-mount-ro} +{#artist-mount-is-read-only} - A mount containing an artist folder is mounted as read-only. Lidarr cannot import files into a read-only mount. Check your mount configuration and ensure that Lidarr has write access to the artist folders listed in the health check message. @@ -656,3 +569,25 @@ The top row has options to control your log files. - Lidarr uses rolling log files limited to 1MB each. The current log file is always lidarr.txt, for the other files lidarr.0.txt is the next newest (higher numbers are older) up to 51 log files total. This log file contains `fatal`, `error`, `warn`, and `info` entries. - With Debug log level enabled, lidarr.debug.txt rolling log files appear, up to 51 files. This log file contains `fatal`, `error`, `warn`, `info`, and `debug` entries. It covers a ~40-hour window. - With Trace log level enabled, lidarr.trace.txt rolling log files appear, up to 51 files. This log file contains `fatal`, `error`, `warn`, `info`, `debug`, and `trace` entries. Due to trace verbosity it only covers a couple of hours at most. + +# Unsupported legacy build health checks + +These health checks only appear on unsupported, end-of-life builds (legacy Mono or x86, before the switch to .NET) and are not present in current releases. If you see one of them, your install is on an unsupported build. [Update to a supported release](/lidarr/faq#how-do-i-update-lidarr). + +## Update to .NET version + +{#update-to-net-core-version} + +Unsupported legacy mono build. [Update to a supported release](/lidarr/faq#how-do-i-update-lidarr). + +## Currently installed mono version is old and unsupported + +Unsupported legacy mono build. [Update to a supported release](/lidarr/faq#how-do-i-update-lidarr). + +## Mono Legacy TLS enabled + +Unsupported legacy mono build. [Update to a supported release](/lidarr/faq#how-do-i-update-lidarr). + +## Mono and x86 builds are ending + +Unsupported legacy mono or x86 build. [Update to a supported release](/lidarr/faq#how-do-i-update-lidarr). diff --git a/prowlarr/environment-variables.md b/prowlarr/environment-variables.md index 277cbc9ad..c9f959624 100644 --- a/prowlarr/environment-variables.md +++ b/prowlarr/environment-variables.md @@ -59,11 +59,13 @@ The config namespaces are shared between all Servarr apps and correspond to the | `PostgresLogDbConnectionString` | `POSTGRES` | `LOGDBCONNECTIONSTRING` | `PROWLARR__POSTGRES__LOGDBCONNECTIONSTRING` | | `UrlBase` | `SERVER` | `URLBASE` | `PROWLARR__SERVER__URLBASE` | | `BindAddress` | `SERVER` | `BINDADDRESS` | `PROWLARR__SERVER__BINDADDRESS` | +| `AllowedHosts` | `SERVER` | `ALLOWEDHOSTS` | `PROWLARR__SERVER__ALLOWEDHOSTS` | | `Port` | `SERVER` | `PORT` | `PROWLARR__SERVER__PORT` | | `EnableSsl` | `SERVER` | `ENABLESSL` | `PROWLARR__SERVER__ENABLESSL` | | `SslPort` | `SERVER` | `SSLPORT` | `PROWLARR__SERVER__SSLPORT` | | `SslCertPath` | `SERVER` | `SSLCERTPATH` | `PROWLARR__SERVER__SSLCERTPATH` | | `SslCertPassword` | `SERVER` | `SSLCERTPASSWORD` | `PROWLARR__SERVER__SSLCERTPASSWORD` | +| `TrustedNetworks` | `SERVER` | `TRUSTEDNETWORKS` | `PROWLARR__SERVER__TRUSTEDNETWORKS` | | `UpdateMechanism` | `UPDATE` | `MECHANISM` | `PROWLARR__UPDATE__MECHANISM` | | `UpdateAutomatically` | `UPDATE` | `AUTOMATICALLY` | `PROWLARR__UPDATE__AUTOMATICALLY` | | `UpdateScriptPath` | `UPDATE` | `SCRIPTPATH` | `PROWLARR__UPDATE__SCRIPTPATH` | diff --git a/prowlarr/faq.md b/prowlarr/faq.md index 415b49ef0..c9fcacecc 100644 --- a/prowlarr/faq.md +++ b/prowlarr/faq.md @@ -65,7 +65,7 @@ As of Prowlarr v1, Authentication is Mandatory. ### Authentication Method -- `Basic` (Browser pop-up) - Basic Auth is not supported as of Prowlarr v1 +- `Basic` (Browser pop-up) - Removed in Prowlarr v2.0.0; a `Basic` value left in the config is rewritten to `Forms` on load - `Forms` (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 `External` in the [config file](/prowlarr/appdata-directory), and restarting the app. **Note that multiple `AuthenticationMethod` entries in the file are not supported and only the topmost value will be used** diff --git a/prowlarr/settings.md b/prowlarr/settings.md index a69e57ff8..3f0990d74 100644 --- a/prowlarr/settings.md +++ b/prowlarr/settings.md @@ -278,16 +278,25 @@ Click on `Settings` => `General`. - Authentication - How would you like to authenticate to access your Prowlarr instance - None - You have no authentication to access your Prowlarr. Typically if you're the only user of your network, do not have anybody on your network that would care to access your Prowlarr or your Prowlarr is not exposed to the web + - Basic (Browser pop-up) - Removed in Prowlarr v2.0.0; an existing `Basic` value in the config is converted to `Forms` on load. Previously a browser username/password pop-up. - Forms (Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Prowlarr - External - External authentication is handled by a reverse proxy. Prowlarr will trust authentication headers passed by the proxy. - Authentication Required - Controls which requests require authentication - Enabled - All requests require authentication - Disabled for Local Addresses - Requests from local network addresses bypass authentication; all remote requests still require authentication + +> With Authentication Required set to `Disabled for Local Addresses`, a request that spoofs the `X-Forwarded-For` header can appear local and skip authentication unless Prowlarr is behind a properly configured reverse proxy whose address is listed under Trusted Networks below. Prowlarr only trusts `X-Forwarded-For` from addresses in that list. If you do not run a trusted reverse proxy, set Authentication Required to `Enabled`, or put Prowlarr behind a VPN or Tailscale rather than exposing it directly. +{.is-warning} + - API Key - API key is used by outside apps accessing Prowlarr. This is secret and should not be shared with anyone. If it gets shared, you should regenerate it and update your apps. - Certificate Validation - Change how strict HTTPS certification validation is - Enabled - Validate all HTTPS certificates (recommended) - Disabled for Local Addresses - Validate all HTTPS certificates except those on localhost and the LAN - Disabled - Do not validate any HTTPS certificates +- Trusted Networks - Comma-separated list of IP addresses or CIDR networks that trusted reverse proxies are on (for example `172.17.0.1`, `10.0.0.0/8`, or `fc00::/7`). Prowlarr only trusts the `X-Forwarded-For` header from these addresses. Only add proxies that are properly configured to send the correct headers. + +> Trust CGNAT IP Addresses - Not exposed in the UI. Set via `config.xml` or the `PROWLARR__AUTH__TRUSTCGNATIPADDRESSES` environment variable (default `false`). When enabled, Prowlarr treats CGNAT addresses (`100.64.0.0/10`, the range Tailscale uses) as local for the Authentication Required `Disabled for Local Addresses` check. It has no effect with any other Authentication Required or Authentication setting. +{.is-info} ## Proxy @@ -343,8 +352,8 @@ The default log level is `Debug`. This is very basic logging. You can change it ![general_backups.png](/assets/prowlarr/general_backups.png) - (Advanced Option) Folder - This allows you to select the backup location. In docker you will be limited to what you allow the container to see. Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder. -- (Advanced Option) Interval - How often would you like Prowlarr to make a backup -- (Advanced Option) Retention - How long would you like Prowlarr to hold on to each backup. After a new backup is made the oldest backup will be removed +- (Advanced Option) Interval - How often would you like Prowlarr to make a backup (default: every 7 days) +- (Advanced Option) Retention - How long would you like Prowlarr to hold on to each backup. After a new backup is made the oldest backup will be removed (default: 28 days) > Manual backups are retained forever, stored in the same folder, and are named differently. {.is-info} diff --git a/prowlarr/system.md b/prowlarr/system.md index 09fe0c0f1..04233e0ed 100644 --- a/prowlarr/system.md +++ b/prowlarr/system.md @@ -15,11 +15,11 @@ dateCreated: 2021-08-03T21:21:08.969Z - [Health](#health) - [System Warnings](#system-warnings) - [Branch is not a valid release branch](#branch-is-not-a-valid-release-branch) - - [Currently installed SQLite version is not supported](#currently-installed-sqlite-version-is-not-supported) - [New update is available](#new-update-is-available) + - [Cannot install update because startup folder is in an App Translocation folder](#cannot-install-update-because-startup-folder-is-in-an-app-translocation-folder) - [Cannot install update because startup folder is not writable by the user](#cannot-install-update-because-startup-folder-is-not-writable-by-the-user) + - [Cannot install update because UI folder is not writable by the user](#cannot-install-update-because-ui-folder-is-not-writable-by-the-user) - [Updating will not be possible to prevent deleting AppData on Update](#updating-will-not-be-possible-to-prevent-deleting-appdata-on-update) - - [Branch is for a previous version](#branch-is-for-a-previous-version) - [Could not connect to signalR](#could-not-connect-to-signalr) - [Failed to resolve the IP Address for the Configured Proxy Host](#failed-to-resolve-the-ip-address-for-the-configured-proxy-host) - [Proxy Failed Test](#proxy-failed-test) @@ -69,10 +69,6 @@ This page contains a list of health checks errors. These health checks are perio - The branch you have set is not a valid release branch. You will not receive updates. Please change to one of the [current release branches](/prowlarr/faq#how-do-i-update-prowlarr). -#### Currently installed SQLite version is not supported - -- Prowlarr stores its data in an SQLite database. The SQLite3 library installed on your system is too old. Prowlarr requires at least version 3.9.0. Note that Prowlarr uses `libSQLite3.so` which may or may not be contained in a SQLite3 upgrade package. - #### New update is available - Rejoice, the developers have released a new update. This generally means awesome new features and squashed piles of bugs (right?). Apparently you don’t have Auto-Updating enabled, so you’ll have to figure out how to update on your platform. Pressing the Install button on the System => Updates page is probably a good starting point. @@ -83,10 +79,18 @@ This page contains a list of health checks errors. These health checks are perio > If your installed version is more than 180 days old, this escalates from a Warning to an Error. {.is-warning} +#### Cannot install update because startup folder is in an App Translocation folder + +- macOS Gatekeeper moved Prowlarr's app bundle into a randomized App Translocation folder because it was launched from an unapproved location. Prowlarr cannot write to its own Startup folder from there, so updates fail. Move the app to a stable location such as /Applications and relaunch it to resolve this. + #### Cannot install update because startup folder is not writable by the user - This means Prowlarr will be unable to update itself. You’ll have to update Prowlarr manually or set the permissions on Prowlarr’s Startup directory (the installation directory) to allow Prowlarr to update itself. +#### Cannot install update because UI folder is not writable by the user + +- This means Prowlarr will be unable to update itself. You’ll have to update Prowlarr manually or set the permissions on Prowlarr’s UI directory (inside the installation directory) to allow Prowlarr to update itself. + #### Updating will not be possible to prevent deleting AppData on Update - Prowlarr detected that AppData folder for your Operating System is located inside the directory that contains the Prowlarr binaries. Normally it would be C:\ProgramData for Windows and, ~/.config for linux. @@ -95,10 +99,6 @@ This page contains a list of health checks errors. These health checks are perio - This means Prowlarr will be unable to update itself without risking data-loss. - If you’re on linux, you’ll probably have to change the home directory for the user that is running Prowlarr and copy the current contents of the ~/.config/Prowlarr directory to preserve your database. -#### Branch is for a previous version - -- The update branch setup in Settings/General is for a previous version of Prowlarr, therefore the instance will not see correct update information in the System/Updates feed and may not receive new updates when released. - #### Could not connect to signalR - signalR drives the dynamic UI updates, so if your browser cannot connect to signalR on your server you won’t see any real time updates in the UI. @@ -146,6 +146,8 @@ If Prowlarr is not running on the same machine as your reverse proxy. Replace 12 #### Failed to resolve the IP Address for the Configured Proxy Host +{#proxy-failed-resolve-ip} + - Review your proxy settings and ensure they are accurate - Ensure your proxy is up, running, and accessible @@ -155,6 +157,8 @@ If Prowlarr is not running on the same machine as your reverse proxy. Replace 12 #### System Time is off by more than 1 day +{#system-time-off} + - System time is off by more than 1 day. Scheduled tasks may not run correctly until the time is corrected - Review your system time and ensure it is synced to an authoritative time server and accurate @@ -232,6 +236,8 @@ If Prowlarr is not running on the same machine as your reverse proxy. Replace 12 #### Indexers with invalid download clients +{#invalid-indexer-download-client-setting} + - One or more of your indexers is configured with a download client that is either disabled or no longer exists. Check Settings => Download Clients and update or remove the download client assignment on the affected indexer(s). ### Indexer Proxies @@ -372,3 +378,15 @@ On the top row there are several options to allow you to control your log files. - Prowlarr uses rolling log files limited to 1MB each. The current log file is always prowlarr.txt, for the the other files prowlarr.0.txt is the next newest (the higher the number the older it is) up to 51 log files total. This log file contains `fatal`, `error`, `warn`, and `info` entries. - When Debug log level is enabled, additional prowlarr.debug.txt rolling log files will be present, up to 51 files. This log files contains `fatal`, `error`, `warn`, `info`, and `debug` entries. It usually covers a ~40h period. - When Trace log level is enabled, additional prowlarr.trace.txt rolling log files will be present, up to 51 files. This log files contains `fatal`, `error`, `warn`, `info`, `debug`, and `trace` entries. Due to trace verbosity it only covers a couple of hours at most. + +# Health checks not present in current releases + +These health checks were removed from current Prowlarr and only appear on older versions. If you see one of them, [update to a supported release](/prowlarr/faq#how-do-i-update-prowlarr). + +## Currently installed SQLite version is not supported + +Not present in current Prowlarr. [Update to a supported release](/prowlarr/faq#how-do-i-update-prowlarr). + +## Branch is for a previous version + +Not present in current Prowlarr. [Update to a supported release](/prowlarr/faq#how-do-i-update-prowlarr). diff --git a/radarr/environment-variables.md b/radarr/environment-variables.md index e9b64a276..cce130131 100644 --- a/radarr/environment-variables.md +++ b/radarr/environment-variables.md @@ -59,11 +59,13 @@ The config namespaces are shared between all Servarr apps and correspond to the | `PostgresLogDbConnectionString` | `POSTGRES` | `LOGDBCONNECTIONSTRING` | `RADARR__POSTGRES__LOGDBCONNECTIONSTRING` | | `UrlBase` | `SERVER` | `URLBASE` | `RADARR__SERVER__URLBASE` | | `BindAddress` | `SERVER` | `BINDADDRESS` | `RADARR__SERVER__BINDADDRESS` | +| `AllowedHosts` | `SERVER` | `ALLOWEDHOSTS` | `RADARR__SERVER__ALLOWEDHOSTS` | | `Port` | `SERVER` | `PORT` | `RADARR__SERVER__PORT` | | `EnableSsl` | `SERVER` | `ENABLESSL` | `RADARR__SERVER__ENABLESSL` | | `SslPort` | `SERVER` | `SSLPORT` | `RADARR__SERVER__SSLPORT` | | `SslCertPath` | `SERVER` | `SSLCERTPATH` | `RADARR__SERVER__SSLCERTPATH` | | `SslCertPassword` | `SERVER` | `SSLCERTPASSWORD` | `RADARR__SERVER__SSLCERTPASSWORD` | +| `TrustedNetworks` | `SERVER` | `TRUSTEDNETWORKS` | `RADARR__SERVER__TRUSTEDNETWORKS` | | `UpdateMechanism` | `UPDATE` | `MECHANISM` | `RADARR__UPDATE__MECHANISM` | | `UpdateAutomatically` | `UPDATE` | `AUTOMATICALLY` | `RADARR__UPDATE__AUTOMATICALLY` | | `UpdateScriptPath` | `UPDATE` | `SCRIPTPATH` | `RADARR__UPDATE__SCRIPTPATH` | diff --git a/radarr/settings.md b/radarr/settings.md index 56e16aa0f..a5f29aa7c 100644 --- a/radarr/settings.md +++ b/radarr/settings.md @@ -217,25 +217,29 @@ Also, note that for each individual settings page, there are some options at the - `{MediaInfo Simple}` = x264 DTS - `{MediaInfo Full}` = x264 DTS \[EN+DE\] +- `{MediaInfo Audio}` = DTS - `{MediaInfo AudioCodec}` = DTS - `{MediaInfo AudioChannels}` = 5.1 - `{MediaInfo AudioLanguages}` = \[EN+DE\] - `{MediaInfo AudioLanguagesAll}` = \[EN+DE\] - `{MediaInfo SubtitleLanguages}` = \[EN\] - `{MediaInfo SubtitleLanguagesAll}` = \[EN\] +- `{MediaInfo Video}` = x264 - `{MediaInfo VideoCodec}` = x264 - `{MediaInfo VideoBitDepth}` = 8 - `{MediaInfo VideoDynamicRange}` = HDR - `{MediaInfo VideoDynamicRangeType}` = DV HDR10 - `{MediaInfo 3D}` = 3D -> `MediaInfo Full`, `AudioLanguages`, and `SubtitleLanguages` do not currently support a `:EN+DE` suffix allowed in Sonarr to filter the languages included in the filename. There is an open [issue](https://github.com/Radarr/Radarr/issues/4710) regarding this. -~~`MediaInfo Full`, `AudioLanguages`, and `SubtitleLanguages` support a `:EN+DE` suffix allowing you to filter the languages included in the filename. Use `-DE` to exclude specific languages. Appending + (e.g.: `:EN+`) will output `[EN]`,`[EN+--]` or `[--]` depending on excluded languages. For example - `{MediaInfo Full:EN+DE}`.~~ +> `MediaInfo Full`, `AudioLanguages`, and `SubtitleLanguages` support a `:EN+DE` suffix allowing you to filter the languages included in the filename. Use `-DE` to exclude specific languages. Appending + (e.g.: `:EN+`) will output `[EN]`,`[EN+--]` or `[--]` depending on excluded languages. For example - `{MediaInfo Full:EN+DE}`. {.is-info} > `MediaInfo VideoDynamicRangeType` will give possible values of: DV, DV HDR10, DV HLG, DV SDR, HDR10, HDR10Plus, HLG, and PQ. {.is-info} +> `MediaInfo Video` and `MediaInfo Audio` are aliases of `MediaInfo VideoCodec` and `MediaInfo AudioCodec` respectively. +{.is-info} + ### Release Group - `{Release Group}` = Rls Grp @@ -488,13 +492,22 @@ The timer period can be different for Usenet and Torrents. Each profile can be a ## Qualities Defined - Unknown - Self Explanatory +- WORKPRINT - A copy of a film before final color correction and visual effects are completed, sometimes missing shots or containing scene numbers/timecodes burned into the frame. The lowest quality pre-release source. +- CAM - Captured in a movie theater with a camcorder, often at an angle, with audio picked up by the camera's built-in microphone. Both picture and sound quality are poor. +- TELESYNC - Similar to a CAM but recorded with a direct external audio feed (e.g. from the theater's audio system), giving cleaner sound despite similar video quality to a CAM. +- TELECINE - Copied from a film print using a telecine machine that transfers film to video. Better video quality than a CAM or TELESYNC, though colors can appear washed out. +- REGIONAL - A retail disc release intended for a specific geographic region that differs from the version released elsewhere, such as an alternate cut or an earlier regional release date. +- DVDSCR - A promotional screener DVD sent to reviewers and industry insiders ahead of retail release, often watermarked or containing an on-screen timer/counter to discourage piracy. - SDTV - Post air rips from an analog source (usually cable television or OTA standard definition). The image quality is generally good (for the resolution) and they are usually encoded in DivX/XviD or MP4. - WEBDL-480p - WEB-DL (P2P) refers to a file losslessly ripped from a streaming service, such as Netflix, Amazon Video, Hulu, Crunchyroll, Discovery GO, BBC iPlayer, etc., or downloaded via an online distribution website such as iTunes. The quality is quite good, since they are not reencoded. The video (H.264 or H.265) and audio (AC3/AAC) streams are usually extracted from the iTunes or Amazon Video and remuxed into a MKV container without sacrificing quality. An advantage with these releases is that, like BD/DVDRips, they usually have no onscreen network logos. These are nearly as good as a Blu-ray source but can suffer from audio lag or visual artifacts from the adaptive bitrate of streaming services. If a ripper's internet connection drops to a point where the bitrate lowers, the source bitrate could change dynamically, causing variations in picture quality. Most releases that suffer from an extreme amount of visual artifacts are NUKED and a PROPER is generally released to fix any wild variations in adaptive bitrate. This will be in 480p (SD) quality. - WEBRip-480p - In a WEB-Rip (P2P), the file is often extracted using the HLS or RTMP/E protocols and remuxed from a TS, MP4 or FLV container to MKV. This will be in 480p (SD) quality. - DVD - A re-encode of the final released DVD9. If possible this is released PRE retail. It should be excellent quality (for the resolution). DVDrips are usually released in DivX/XviD or MP4. +- DVD-R - A remux of a retail DVD, keeping the original DVD video and audio streams intact without re-encoding. - Bluray-480p - A re-encode of the final released Blu-ray, downscaled to 480p resolution (720x480 @ 16:9, any other Aspect Ratio may be a different resolution). If possible this is released PRE retail. It should be excellent quality for the resolution. Bitrates may vary, but these are generally encoded to DivX, XviD, or AVC and offer the tradeoff of a small perceived quality reduction over the original source while drastically reducing filesize. These are generally MKV or MP4, but some DivX/XviD are around as well which use AVI. +- Bluray-576p - A re-encode of the final released Blu-ray, downscaled to 576p resolution (1024x576 @ 16:9, any other aspect ratio may be a different resolution). If possible this is released PRE retail. It should be excellent quality for the resolution. Bitrates may vary, but these are generally encoded to AVC or HEVC and offer the tradeoff of a small perceived quality reduction over the original source while drastically reducing filesize. These are generally MKV or MP4 container. - HDTV-720p - A re-encode of the final released Blu-ray, but broadcast over HD cable or satellite (1280x720 @ 16:9, any other aspect ratio may be a different resolution). It may be modified for runtime or content depending on the network it came from. This is released usually several months after a retail release, but sometimes upscaled versions of a Standard Definition film are released on cable channels such as STARZ or HBO, and they would be the only HD copies of that specific film available. These are generally MKV or MP4. - HDTV-1080p - A re-encode of the final released Blu-ray, but broadcast over HD cable or satellite (1920x1080 @ 16:9, any other aspect ratio may be a different resolution). It may be modified for runtime or content depending on the network it came from. This is released usually several months after a retail release, but sometimes upscaled versions of a Standard Definition film are released on cable channels such as STARZ or HBO, and they would be the only HD copies of that specific film available. These are generally MKV or MP4 container. +- WEBDL-720p - WEB-DL (P2P) refers to a file losslessly ripped from a streaming service, such as Netflix, Amazon Video, Hulu, Crunchyroll, Discovery GO, BBC iPlayer, etc., or downloaded via an online distribution website such as iTunes. The quality is quite good, since they are not reencoded. The video (H.264 or H.265) and audio (AC3/AAC) streams are usually extracted from the iTunes or Amazon Video and remuxed into a MKV container without sacrificing quality. An advantage with these releases is that, like BD/DVDRips, they usually have no onscreen network logos. These are nearly as good as a Blu-ray source but can suffer from audio lag or visual artifacts from the adaptive bitrate of streaming services. If a ripper's internet connection drops to a point where the bitrate lowers, the source bitrate could change dynamically, causing variations in picture quality. Most releases that suffer from an extreme amount of visual artifacts are NUKED and a PROPER is generally released to fix any wild variations in adaptive bitrate. This will be in 720p quality. - WEBRip-720p - In a WEB-Rip (P2P), the file is often extracted using the HLS or RTMP/E protocols and remuxed from a TS, MP4 or FLV container to MKV. This will be in 720p quality. - Bluray-720p - A re-encode of the final released Blu-ray, downscaled to 720p resolution (1280x720 @ 16:9, any other aspect ratio may be a different resolution). If possible this is released PRE retail. It should be excellent quality for the resolution. Bitrates may vary, but these are generally encoded to AVC or HEVC and offer the tradeoff of a small perceived quality reduction over the original source while drastically reducing filesize. These are generally MKV or MP4 container. - WEBDL-1080p - WEB-DL (P2P) refers to a file losslessly ripped from a streaming service, such as Netflix, Amazon Video, Hulu, Crunchyroll, Discovery GO, BBC iPlayer, etc., or downloaded via an online distribution website such as iTunes. The quality is quite good, since they are not reencoded. The video (H.264 or H.265) and audio (AC3/AAC) streams are usually extracted from the iTunes or Amazon Video and remuxed into a MKV container without sacrificing quality. An advantage with these releases is that, like BD/DVDRips, they usually have no onscreen network logos. These are nearly as good as a Blu-ray source but can suffer from audio lag or visual artifacts from the adaptive bitrate of streaming services. If a ripper's internet connection drops to a point where the bitrate lowers, the source bitrate could change dynamically, causing variations in picture quality. Most releases that suffer from an extreme amount of visual artifacts are NUKED and a PROPER is generally released to fix any wild variations in adaptive bitrate. This will be in 1080p quality. @@ -506,6 +519,8 @@ The timer period can be different for Usenet and Torrents. Each profile can be a - WEBRip-2160p - In a WEB-Rip (P2P), the file is often extracted using the HLS or RTMP/E protocols and remuxed from a TS, MP4 or FLV container to MKV. This will be in 2160p (4k) quality. - Bluray-2160p - A re-encode of the final released Blu-ray, at its native 2160p resolution (3840x2160 @ 16:9, any other aspect ratio may be a different resolution). 4K versions of films that are released in generally HEVC codec and could be either 8-bit or 10-bit color reproduction or from an HDR source. slightly reducing filesize. These are generally MKV or MP4 container. - Remux-2160p - A remux is a rip of a Blu-ray or HD DVD disc to another container format or just stripping the disc of menus and bonus material while keeping the contents of its audio and video streams intact (also keeping the current codecs), guaranteeing the exact 1:1 movie quality as on original disc. This is at 2160p (4K) quality. +- BR-DISK - The complete, unmodified Blu-ray disc structure, including the full menu system and extras, rather than an extracted or re-encoded video file. +- Raw-HD - A raw feed of an HD stream. # Custom Formats @@ -556,6 +571,7 @@ Profiles is where Custom Format Scores are configured. - Quality Modifier - Quality Modifier sets things like Telescene, Telesync, Remux, Regional. It disambiguates a given source and resolution pair when there are multiple quality (source) types that can apply. - Size - This is matched against the release size. The release size is converted to gigabytes and compared against the min and max values. - Group - This is matched against the group that Radarr parses based on Radarr's group detection logic. +- Year - This is matched against the release year. The release year is compared against the min and max values. ### Profiling Settings and Ranking @@ -609,6 +625,7 @@ Profiles is where Custom Format Scores are configured. - API Key - The indexer provided key to access the API. - Categories - Default categories will be used unless edited. It is likely these default categories are suboptimal. Upon editing this setting, Radarr queries the indexer for its available categories and displays them in a selectable a list. The stale defaults will clear as soon as a category is toggled. - (Advanced Option) Additional Parameters - Additional Newznab parameters to add to the query link +- (Advanced Option) Fail Downloads - While processing completed downloads Radarr will treat these selected filetypes as failed downloads. Options are Executables and Potentially Dangerous. - Remove year from search string - For text based queries should Radarr remove the year after the movie title when searching this indexer? - (Advanced Option) Indexer Priority - Priority of this indexer to prefer one indexer over another in release tiebreaker scenarios. 1 is highest priority and 50 is lowest priority. - (Advanced Option) Download Client - Select and specify which download client is used for grabs from this indexer @@ -724,7 +741,8 @@ Select the download client you wish to add, and there will be a pop-up box to en - Older Priority - download client priority for media released not recently - (Advanced Option) Client Priority - Priority of the download client. Round-Robin is used for clients of the same type (torrent/usenet) that have the same priority. 1 is highest priority and 50 is lowest priority - Completed Download Handling - - Remove (Per Client Setting) - Remove completed downloads when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) + - Remove Completed (Per Client Setting) - Remove imported downloads from the download client's history when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) + - Remove Failed (Per Client Setting) - Remove failed downloads from the download client's history. ### Torrent Client Settings @@ -743,8 +761,9 @@ Select the download client you wish to add, and there will be a pop-up box to en - Initial State - Initial state for torrents (Qbittorrent Only: Forced bypasses all seed thresholds) - (Advanced Option) Client Priority - Priority of the download client. Round-Robin is used for clients of the same type (torrent/usenet) that have the same priority. 1 is highest priority and 50 is lowest priority - Completed Download Handling - - Remove (Per Client Setting) - Remove completed downloads when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) + - Remove Completed (Per Client Setting) - Remove imported downloads from the download client's history when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) - For torrents this requires your download client to pause upon hitting the seed goals. It also requires the seed goals to be supported by Radarr per the below table. Torrents must also stay in the same category. + - Remove Failed (Per Client Setting) - Remove failed downloads from the download client's history. ### Torrent Client Remove Download Compatibility @@ -772,8 +791,9 @@ Select the download client you wish to add, and there will be a pop-up box to en - (Advanced Global Setting) Enable - Automatically import completed downloads from the download client - (Advanced Option) Check For Finished Downloads Interval - Set how often to query the download clients' queues and refresh monitored downloads, minimum 1 minute -- (Per Client Setting) Remove - Remove completed downloads when finished (usenet) or stopped/complete (torrents) +- (Per Client Setting) Remove Completed - Remove imported downloads from the download client's history when finished (usenet) or stopped/complete (torrents) - For torrents this requires your download client to pause upon hitting the seed goals. It also requires the seed goals to be supported by Radarr per the above table. Torrents must also stay in the same category. +- (Per Client Setting) Remove Failed - Remove failed downloads from the download client's history. ### Remove Completed Downloads @@ -805,7 +825,8 @@ If you download using a BitTorrent client, the process is slightly different: - Blocklisting (fka 'Blacklisting') allows automatic skipping of nzbs when they fail, this means that nzb will not be automatically downloaded by Radarr ever again (You can still force the download via a manual search). - There are 2 advanced options (on 'Download Client' settings page) that control the behavior of failed downloading in Radarr, at this time, they are all on by default. -- Redownload - Controls whether or not Radarr will search for the same file after a failure +- Redownload Failed - Controls whether or not Radarr will search for the same file after a failure +- (Advanced Option) Redownload Failed from Interactive Search - Only shown when Redownload Failed is enabled. Automatically search for and attempt to download a different release when the failed release was grabbed from an interactive search. - (Advanced Option) Remove - Whether or not the download should automatically be removed from Download Client when the failure is detected ## Remote Path Mappings @@ -951,13 +972,25 @@ Kodi will be one of the most commonly used options here if that is the software - Authentication - How would you like to authenticate to access your Radarr instance - As of Radarr v5, Authentication is now mandatory. [See the Mandatory Auth FAQ entry for details.](/radarr/faq#forced-authentication) - ~~None - You have no authentication to access your Radarr. Typically if you're the only user of your network, do not have anybody on your network that would care to access your Radarr or your Radarr is not exposed to the web~~ - - Basic (Browser pop-up) - This option when accessing your Radarr will show a small pop-up allowing you to input a Username and Password + - Basic (Browser pop-up) - Removed in Radarr v6.0.0; an existing `Basic` value in the config is converted to `Forms` on load. Previously a browser username/password pop-up. - Forms (Login Page) - This option will have a familiar looking login screen much like other websites have to allow you to log onto your Radarr + - External - Hands authentication off entirely to a reverse proxy (e.g. Authelia, Organizr) placed in front of Radarr. Not selectable in the UI; set it via `config.xml` or the `RADARR__AUTH__METHOD` environment variable. Radarr performs no authentication of its own in this mode, so Authentication Required and Trust CGNAT IP Addresses have no effect +- Authentication Required - Controls which requests must authenticate. Do not change this unless you understand the risks. + - Enabled - Always require authentication (recommended) + - Disabled for Local Addresses - Skip authentication for requests Radarr identifies as coming from localhost or the LAN + +> With Authentication Required set to `Disabled for Local Addresses`, a request that spoofs the `X-Forwarded-For` header can appear local and skip authentication unless Radarr is behind a properly configured reverse proxy whose address is listed under Trusted Networks below. Radarr only trusts `X-Forwarded-For` from addresses in that list. If you do not run a trusted reverse proxy, set Authentication Required to `Enabled`, or put Radarr behind a VPN or Tailscale rather than exposing it directly. +{.is-warning} + - API Key - This is how other programs would communicate or have Radarr communicate to other programs. This key if given to the wrong person with access could do all kinds of things to your library. This is why in the logs the API key is redacted - Certificate Validation - Change how strict HTTPS certification validation is - Enabled - Validate all HTTPS certificates (recommended) - Disabled for Local Addresses - Validate all HTTPS certificates except those on localhost and the LAN - Disabled - Do not validate any HTTPS certificates +- Trusted Networks - Comma-separated list of IP addresses or CIDR networks that trusted reverse proxies are on (for example `172.17.0.1`, `10.0.0.0/8`, or `fc00::/7`). Radarr only trusts the `X-Forwarded-For` header from these addresses. Only add proxies that are properly configured to send the correct headers. + +> Trust CGNAT IP Addresses - Not exposed in the UI. Set via `config.xml` or the `RADARR__AUTH__TRUSTCGNATIPADDRESSES` environment variable (default `false`). When enabled, Radarr treats CGNAT addresses (`100.64.0.0/10`, the range Tailscale uses) as local for the Authentication Required `Disabled for Local Addresses` check. It has no effect with any other Authentication Required or Authentication setting. +{.is-info} ## Proxy @@ -1002,8 +1035,8 @@ Proxy - This option allows you to run the information your Radarr pulls and sear - The backup section allows you to tell Radarr how you would like for it to handle backups - (Advanced Option) Folder - This allows you to select the backup location. In docker you will be limited to what you allow the container to see. Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder. -- (Advanced Option) Interval - How often would you like Radarr to make a backup -- (Advanced Option) Retention - How long would you like Radarr to hold on to each backup. After a new backup is made the oldest backup will be removed +- (Advanced Option) Interval - How often would you like Radarr to make a backup (default: every 7 days) +- (Advanced Option) Retention - How long would you like Radarr to hold on to each backup. After a new backup is made the oldest backup will be removed (default: 28 days) > Manual backups are retained forever, stored in the same folder, and are named differently. {.is-info} diff --git a/radarr/supported.md b/radarr/supported.md index cafc1546d..1c06c0bd6 100644 --- a/radarr/supported.md +++ b/radarr/supported.md @@ -156,13 +156,8 @@ This page is the disambiguation page for all `supported` wiki links (i.e. typica - CouchPotato {#couchpotatoimport} - Custom Lists {#radarrlistimport} - IMDb Lists {#imdblistimport} - - To add your IMDb Watchlist, go to your list and click edit. Make sure privacy setting is set to public. In the address bar you will find the `lsxxxxxx` number that you will need to enter into Radarr - - 1. Go to your IMDB List Settings - 1. Ensure Privacy is set to `Public` (i.e. `Disabled)` - 1. Use the `ls` number within the URL - - ![imdb-list-ls.png](/assets/radarr/imdb-list-ls.png) + - The List/User ID field accepts `top250` (IMDb Top 250), `popular` (IMDb Most Popular), or an IMDb user ID of the form `ur12345678` (imports that user's public lists). + - Custom IMDb lists and watchlists (the `ls`-number lists) are no longer supported. IMDb changed how those lists are served, so Radarr can no longer read them. - Plex Watchlist {#plex} - Requires: v4.1.0.6176+ - Simply add a Plex watchlist for the authenticated Plex user to Radarr. Note that it's required that your list contain movies on it. diff --git a/radarr/system.md b/radarr/system.md index 6136ca13f..23a90f95c 100644 --- a/radarr/system.md +++ b/radarr/system.md @@ -15,18 +15,17 @@ dateCreated: 2021-05-25T02:28:35.194Z - [Health](#health) - [System Warnings](#system-warnings) - [Branch is not a valid release branch](#branch-is-not-a-valid-release-branch) - - [Update to .NET version](#update-to-net-version) - - [Fixing Docker installs](#fixing-docker-installs) - - [Fixing FreeBSD installs](#fixing-freebsd-installs) - - [Fixing Standalone installs](#fixing-standalone-installs) - - [Currently installed mono version is old and unsupported](#currently-installed-mono-version-is-old-and-unsupported) - [Currently installed SQLite version is not supported](#currently-installed-sqlite-version-is-not-supported) - - [Database Failed Integrity Check](#database-failed-integrity-check) - [New update is available](#new-update-is-available) + - [Cannot install update because startup folder is in an App Translocation folder](#cannot-install-update-because-startup-folder-is-in-an-app-translocation-folder) - [Cannot install update because startup folder is not writable by the user](#cannot-install-update-because-startup-folder-is-not-writable-by-the-user) + - [Cannot install update because UI folder is not writable by the user](#cannot-install-update-because-ui-folder-is-not-writable-by-the-user) - [Updating will not be possible to prevent deleting AppData on Update](#updating-will-not-be-possible-to-prevent-deleting-appdata-on-update) - [Branch is for a previous version](#branch-is-for-a-previous-version) + - [Movie Folder Format uses deprecated tokens](#movie-folder-format-uses-deprecated-tokens) + - [Kometa metadata is deprecated](#kometa-metadata-is-deprecated) - [Could not connect to signalR](#could-not-connect-to-signalr) + - [Reverse Proxy Websocket Configuration](#reverse-proxy-websocket-configuration) - [Nginx](#nginx) - [Apache2](#apache2) - [Caddy](#caddy) @@ -95,98 +94,6 @@ dateCreated: 2021-05-25T02:28:35.194Z - The branch you have set is not a valid release branch. You will not receive updates. Please change to one of the [current release branches](/radarr/faq#how-do-i-update-radarr). -#### Update to .NET version - -{#update-to-net-core-version} - -- Newer versions of Radarr are targeted for .NET6 or newer. Mono builds are not provided nor supported starting with v4. v3.2.2 is the last version of Radarr to support legacy mono builds. You are running one of these legacy mono builds, but your platform supports .NET. - -See the below entries for how to switch from unsupported, end-of-life mono versions to dotnet. - -- [Fixing Docker installs](#fixing-docker-installs) -- [Fixing FreeBSD installs](#fixing-freebsd-installs) -- [Fixing Standalone installs](#fixing-standalone-installs) -{.links-list} - -##### Fixing Docker installs - -- Ensure your branch is correct for your docker maintainer and repull your container - -##### Fixing FreeBSD installs - -- Simply update the Radarr Port with `pkg update && pkg upgrade` -- (Optional) Remove the mono package if you wish - -##### Fixing Standalone installs - -Errors such as: - -```none -Cannot open assembly '/opt/Radarr/Radarr': File does not contain a valid CIL image -``` - -- Back-Up your existing configuration before the next step. -- This should only happen on Linux hosts. Do not install .NET runtime or SDK from Microsoft. -- To remedy, download the correct build for your architecture and replace your existing binaries (application) -- In short you will need to delete your existing binaries (contents or folder of /opt/Radarr) and replace with the contents of the .tar.gz you just downloaded and then update your service file to not use mono. - -> DO NOT JUST EXTRACT THE DOWNLOAD OVER THE TOP OF YOUR EXISTING BINARIES. -> YOU MUST DELETE THE OLD ONES FIRST. -{.is-warning} - -- The below is a community developed script to remove your mono installation and replace it with the .NET installation. Contributions and corrections are welcome. -- This assumes you are on the `master` Radarr branch, so update the variable if needed -- This assumes that Radarr runs as the user `radarr`, so update the variables if needed -- This assumes Radarr is installed at `/opt/Radarr`, so update the variables if needed - -```bash -#!/bin/bash -## User Variables -installdir="/opt/Radarr" -APPUSER="radarr" -branch="master" -## /User Variables -app="radarr" -ARCH=$(dpkg --print-architecture) -# Stop \*arr -sudo systemctl stop $app -# get arch -dlbase="https://$app.servarr.com/v1/update/$branch/updatefile?os=linux&runtime=netcore" -case "$ARCH" in -"amd64") DLURL="${dlbase}&arch=x64" ;; -"armhf") DLURL="${dlbase}&arch=arm" ;; -"arm64") DLURL="${dlbase}&arch=arm64" ;; -*) - echo_error "Arch not supported" - exit 1 - ;; -esac -echo "Downloading..." -wget --content-disposition "$DLURL" -tar -xvzf ${app^}.*.tar.gz -echo "Installation files downloaded and extracted" -echo "Moving existing installation" -sudo mv "$installdir/" "$installdir.old/" -echo "Installing..." -sudo mv "${app^}" "$installdir" -sudo chown $APPUSER:$APPUSER -R $installdir -sudo sed -i "s|ExecStart=/usr/bin/mono --debug /opt/${app^}/${app^}.exe|ExecStart=/opt/${app^}/${app^}|g" /etc/systemd/system/$app.service -sudo sed -i "s|ExecStart=/usr/bin/mono /opt/${app^}/${app^}.exe|ExecStart=/opt/${app^}/${app^}|g" /etc/systemd/system/$app.service -sudo systemctl daemon-reload -echo "App Installed" -sudo rm -rf "$installdir.old/" -rm -rf "${app^}.*.tar.gz" -sudo systemctl start $app -``` - -#### Currently installed mono version is old and unsupported - -- Radarr is written in .NET and required Mono to run on very old ARM processors. Mono 5.20 is the absolute minimum for Radarr. -- The upgrade procedure for Mono varies per platform. - -> Mono is no longer supported starting in Radarr version 4.0 -{.is-warning} - #### Currently installed SQLite version is not supported - Radarr stores its data in an SQLite database. The SQLite3 library installed on your system is too old. Radarr requires at least version 3.9.0. @@ -194,13 +101,6 @@ sudo systemctl start $app > Note that Radarr uses `libSQLite3.so` which may or may not be contained in a SQLite3 upgrade package. {.is-info} -#### Database Failed Integrity Check - -- Your database(s) failed a [SQLite Pragma Integrity Check](https://www.sqlite.org/pragma.html#pragma_integrity_check) and have some corruption. -- If `Radarr.db` is corrupt [please see this FAQ Entry](/radarr/faq#i-am-getting-an-error-database-disk-image-is-malformed) -- If `logs.db` is corrupt: Stop Radarr, delete `logs.db` and any `logs.wal` files. -- If both are corrupt, review the respective processes above. - #### New update is available - Rejoice, the developers have released a new update. This generally means awesome new features and squashed piles of bugs (right?). Apparently you don’t have Auto-Updating enabled, so you’ll have to figure out how to update on your platform. Pressing the Install button on the System => Updates page is probably a good starting point. @@ -208,10 +108,19 @@ sudo systemctl start $app > This warning will not appear if your current version is less than 14 days old {.is-info} +#### Cannot install update because startup folder is in an App Translocation folder + +- macOS Gatekeeper can silently relocate an unopened, un-trusted copy of Radarr into a randomized, read-only App Translocation path. Radarr detects when it is running from that path and refuses to auto-update, since it cannot write to a translocated location. +- Move Radarr to a normal folder (e.g. `/Applications`) and launch it from there so macOS stops translocating it, then retry the update. + #### Cannot install update because startup folder is not writable by the user - This means Radarr will be unable to update itself. You’ll have to update Radarr manually or set the permissions on Radarr’s Startup directory (the installation directory) to allow Radarr to update itself. +#### Cannot install update because UI folder is not writable by the user + +- This means Radarr will be unable to update itself. You’ll have to update Radarr manually or set the permissions on Radarr’s UI directory (inside the installation directory) to allow Radarr to update itself. + #### Updating will not be possible to prevent deleting AppData on Update - Radarr detected that AppData folder for your Operating System is located inside the directory that contains the Radarr binaries. Normally it would be C:\ProgramData for Windows and, ~/.config for linux. @@ -224,10 +133,23 @@ sudo systemctl start $app - The update branch setup in Settings/General is for a previous version of Radarr, therefore the instance will not see correct update information in the System/Updates feed and may not receive new updates when released. -#### Could not connect to signalR +#### Movie Folder Format uses deprecated tokens + +- Your [Movie Folder Format](/radarr/settings#movie-folder-format) includes one or more tokens that are deprecated for folder names, such as `{Original Title}`, `{Release Group}`, `{Edition Tags}`, `{Quality Full}`, or the `{MediaInfo ...}` tokens. These are file-naming tokens, not folder-naming tokens, and Radarr will not save the format until they are removed. +- Edit your Movie Folder Format and remove the deprecated tokens, keeping only the tokens listed under [Movie Naming](/radarr/settings#movie-naming-2). + +#### Kometa metadata is deprecated -- signalR drives the dynamic UI updates, so if your browser cannot connect to signalR on your server you won’t see any real time updates in the UI. -- The most common occurrence of this is use of a reverse proxy or cloudflare +- The [Kometa](/radarr/supported#kometametadata) metadata consumer is deprecated. Radarr will stop creating Kometa metadata files, and support will be removed completely in a future v6 release. +- Disable the Kometa metadata consumer in Settings => Metadata to clear this warning. + +#### Reverse Proxy Websocket Configuration + +{#reverse-proxy-websocket-configuration} +{#could-not-connect-to-signalr} + +- Radarr uses signalR to drive dynamic UI updates in the browser. If your reverse proxy does not pass websocket connections through, the UI will not receive real-time updates. +- The most common occurrence of this is use of a reverse proxy or Cloudflare. - Cloudflare needs websockets enabled. ##### Nginx @@ -276,6 +198,8 @@ Note: you will also need to add the websocket directive to your radarr configura #### Failed to resolve the IP Address for the Configured Proxy Host +{#proxy-failed-resolve-ip} + - Review your proxy settings and ensure they are accurate - Ensure your proxy is up, running, and accessible @@ -285,11 +209,15 @@ Note: you will also need to add the websocket directive to your radarr configura #### System Time is off by more than 1 day +{#system-time-off} + - System time is off by more than 1 day. Scheduled tasks may not run correctly until the time is corrected - Review your system time and ensure it is synced to an authoritative time server and accurate #### PTP Indexer Settings Out of Date +{#ptp-settings-old} + - The following PassThePopcorn indexers have deprecated settings and should be updated. #### Invalid API Key @@ -329,6 +257,8 @@ Note: you will also need to add the websocket directive to your radarr configura #### Download clients are unavailable due to failure +{#download-clients-are-unavailable-due-to-failures} + - One or more of your download clients is not responding to requests made by Radarr. Therefore Radarr has decided to temporarily stop querying the download client on it’s normal 1 minute cycle, which is normally used to track active downloads and import finished ones. However, Radarr will continue to attempt to send downloads to the client, but will in all likeliness fail. - You should inspect System=>Logs to see what the reason is for the failures. - If you no longer use this download client, disable it in Radarr to prevent the errors. @@ -389,10 +319,14 @@ Note: you will also need to add the websocket directive to your radarr configura #### Remote File was removed part way through processing +{#remote-path-file-removed} + - A file accessible via a remote path map appears to have been removed prior to processing completing. #### Remote Path is Used and Import Failed +{#remote-path-import-failed} + - Check your logs for more info; Refer to our Troubleshooting Guides #### Download Client Sorting Enabled @@ -494,7 +428,7 @@ Note: you will also need to add the websocket directive to your radarr configura #### Movie Path Mount is Read Only -{#movie-mount-ro} +{#movies-mount-ro} A mount containing a movie path is read only and is not writable by the user Radarr is running as. @@ -514,6 +448,8 @@ A mount containing a movie path is read only and is not writable by the user Rad #### Lists are unavailable due to failures +{#import-lists-are-unavailable-due-to-failures} + - Typically this simply means that Radarr is no longer able to communicate via API or via logging in to your chosen list provider. Your best bet if the problem persists is to contact them in order to rule them out, as their systems maybe overloaded from time to time. - Review System => Events filtered for Warning (Warning & Errors) to see the historical failures or check logs for details. @@ -648,3 +584,17 @@ A mount containing a movie path is read only and is not writable by the user Rad - Radarr uses rolling log files limited to 1MB each. The current log file is always radarr.txt, for the the other files radarr.0.txt is the next newest (the higher the number the older it is) up to 51 log files total. This log file contains `fatal`, `error`, `warn`, and `info` entries. - When Debug log level is enabled, additional radarr.debug.txt rolling log files will be present, up to 51 files. This log files contains `fatal`, `error`, `warn`, `info`, and `debug` entries. It usually covers a ~40h period. - When Trace log level is enabled, additional radarr.trace.txt rolling log files will be present, up to 51 files. This log files contains `fatal`, `error`, `warn`, `info`, `debug`, and `trace` entries. Due to trace verbosity it only covers a couple of hours at most. + +# Unsupported legacy build health checks + +These health checks only appear on unsupported, end-of-life builds (legacy Mono, before the switch to .NET) and are not present in current releases. If you see one of them, your install is on an unsupported build. [Update to a supported release](/radarr/faq#how-do-i-update-radarr). + +## Update to .NET version + +{#update-to-net-core-version} + +Unsupported legacy mono build. [Update to a supported release](/radarr/faq#how-do-i-update-radarr). + +## Currently installed mono version is old and unsupported + +Unsupported legacy mono build. [Update to a supported release](/radarr/faq#how-do-i-update-radarr). diff --git a/readarr/environment-variables.md b/readarr/environment-variables.md index 38dba5f66..7beca41eb 100644 --- a/readarr/environment-variables.md +++ b/readarr/environment-variables.md @@ -36,24 +36,23 @@ The config namespaces are shared between all Servarr apps and correspond to the | `AuthenticationEnabled` | `AUTH` | `ENABLED` | `READARR__AUTH__ENABLED` | | `AuthenticationMethod` | `AUTH` | `METHOD` | `READARR__AUTH__METHOD` | | `AuthenticationRequired` | `AUTH` | `REQUIRED` | `READARR__AUTH__REQUIRED` | +| `TrustCgnatIpAddresses` | `AUTH` | `TRUSTCGNATIPADDRESSES` | `READARR__AUTH__TRUSTCGNATIPADDRESSES` | | `LogLevel` | `LOG` | `LEVEL` | `READARR__LOG__LEVEL` | | `FilterSentryEvents` | `LOG` | `FILTERSENTRYEVENTS` | `READARR__LOG__FILTERSENTRYEVENTS` | | `LogRotate` | `LOG` | `ROTATE` | `READARR__LOG__ROTATE` | -| `LogSizeLimit` | `LOG` | `SIZELIMIT` | `READARR__LOG__SIZELIMIT` | | `LogSql` | `LOG` | `SQL` | `READARR__LOG__SQL` | | `ConsoleLogLevel` | `LOG` | `CONSOLELEVEL` | `READARR__LOG__CONSOLELEVEL` | -| `ConsoleLogFormat` | `LOG` | `CONSOLEFORMAT` | `READARR__LOG__CONSOLEFORMAT` | | `AnalyticsEnabled` | `LOG` | `ANALYTICSENABLED` | `READARR__LOG__ANALYTICSENABLED` | | `SyslogServer` | `LOG` | `SYSLOGSERVER` | `READARR__LOG__SYSLOGSERVER` | | `SyslogPort` | `LOG` | `SYSLOGPORT` | `READARR__LOG__SYSLOGPORT` | | `SyslogLevel` | `LOG` | `SYSLOGLEVEL` | `READARR__LOG__SYSLOGLEVEL` | -| `DbEnabled` | `LOG` | `DBENABLED` | `READARR__LOG__DBENABLED` | | `PostgresHost` | `POSTGRES` | `HOST` | `READARR__POSTGRES__HOST` | | `PostgresPort` | `POSTGRES` | `PORT` | `READARR__POSTGRES__PORT` | | `PostgresUser` | `POSTGRES` | `USER` | `READARR__POSTGRES__USER` | | `PostgresPassword` | `POSTGRES` | `PASSWORD` | `READARR__POSTGRES__PASSWORD` | | `PostgresMainDb` | `POSTGRES` | `MAINDB` | `READARR__POSTGRES__MAINDB` | | `PostgresLogDb` | `POSTGRES` | `LOGDB` | `READARR__POSTGRES__LOGDB` | +| `PostgresCacheDb` | `POSTGRES` | `CACHEDB` | `READARR__POSTGRES__CACHEDB` | | `UrlBase` | `SERVER` | `URLBASE` | `READARR__SERVER__URLBASE` | | `BindAddress` | `SERVER` | `BINDADDRESS` | `READARR__SERVER__BINDADDRESS` | | `Port` | `SERVER` | `PORT` | `READARR__SERVER__PORT` | diff --git a/sonarr/environment-variables.md b/sonarr/environment-variables.md index 43e17ef0a..ee88e0a32 100644 --- a/sonarr/environment-variables.md +++ b/sonarr/environment-variables.md @@ -57,11 +57,13 @@ The config namespaces are shared between all Servarr apps and correspond to the | `PostgresLogDb` | `POSTGRES` | `LOGDB` | `SONARR__POSTGRES__LOGDB` | | `UrlBase` | `SERVER` | `URLBASE` | `SONARR__SERVER__URLBASE` | | `BindAddress` | `SERVER` | `BINDADDRESS` | `SONARR__SERVER__BINDADDRESS` | +| `AllowedHosts` | `SERVER` | `ALLOWEDHOSTS` | `SONARR__SERVER__ALLOWEDHOSTS` | | `Port` | `SERVER` | `PORT` | `SONARR__SERVER__PORT` | | `EnableSsl` | `SERVER` | `ENABLESSL` | `SONARR__SERVER__ENABLESSL` | | `SslPort` | `SERVER` | `SSLPORT` | `SONARR__SERVER__SSLPORT` | | `SslCertPath` | `SERVER` | `SSLCERTPATH` | `SONARR__SERVER__SSLCERTPATH` | | `SslCertPassword` | `SERVER` | `SSLCERTPASSWORD` | `SONARR__SERVER__SSLCERTPASSWORD` | +| `TrustedNetworks` | `SERVER` | `TRUSTEDNETWORKS` | `SONARR__SERVER__TRUSTEDNETWORKS` | | `UpdateMechanism` | `UPDATE` | `MECHANISM` | `SONARR__UPDATE__MECHANISM` | | `UpdateAutomatically` | `UPDATE` | `AUTOMATICALLY` | `SONARR__UPDATE__AUTOMATICALLY` | | `UpdateScriptPath` | `UPDATE` | `SCRIPTPATH` | `SONARR__UPDATE__SCRIPTPATH` | diff --git a/sonarr/faq.md b/sonarr/faq.md index e7517c01d..cac4be6c1 100644 --- a/sonarr/faq.md +++ b/sonarr/faq.md @@ -38,7 +38,7 @@ Active searching (via the indexer's API) is only done in the below situations. N > Generally Quality Trumps All. If you wish to have Quality not be the main priority - you can merge your qualities together. [See TRaSH's Guide](https://trash-guides.info/merge-quality) {.is-info} -- The current logic [can always be found here](https://github.com/Sonarr/Sonarr/blob/develop/src/NzbDrone.Core/DecisionEngine/DownloadDecisionComparer.cs#L31-L41s). +- The current logic [can always be found here](https://github.com/Sonarr/Sonarr/blob/develop/src/NzbDrone.Core/DecisionEngine/DownloadDecisionComparer.cs). - As of 2024-01-16 the logic is as follows: @@ -496,7 +496,7 @@ There can be multiple reasons why Sonarr is not able to find or import episodes ## Invalid Certificate and other HTTPS or SSL issues -- If you're on non-Windows, most likely your mono's certificates are out of date and need to be synced. [See the section about mono ssl in the installation article for details](/sonarr/installation#mono-ssl-issues) +- If you're on non-Windows and seeing certificate errors, make sure your operating system's CA certificate store is current (for example, run `update-ca-certificates` on Debian/Ubuntu). Sonarr v4 runs on .NET, so the old mono certificate-sync steps no longer apply. - Your download client stopped working and you're getting an error like `Localhost is an invalid certificate`? - Sonarr now 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 Sonarr will refuse to connect. Free properly signed certificates are available from [let's encrypt](https://letsencrypt.org/). - If your download client and Sonarr 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. diff --git a/sonarr/settings.md b/sonarr/settings.md index 0a5fbc65c..6de3c64a2 100644 --- a/sonarr/settings.md +++ b/sonarr/settings.md @@ -225,12 +225,14 @@ Standard Episode Format - Set the naming convention for your Standard Series Typ - `{MediaInfo Simple}` = x264 DTS - `{MediaInfo Full}` = x264 DTS \[EN+DE\] +- `{MediaInfo Audio}` = DTS - `{MediaInfo AudioCodec}` = DTS - `{MediaInfo AudioChannels}` = 5.1 - `{MediaInfo AudioLanguages}` = \[EN+DE\] - `{MediaInfo AudioLanguagesAll}` = \[DE\] - `{MediaInfo SubtitleLanguages}` = \[EN\] - `{MediaInfo SubtitleLanguagesAll}` = \[EN+DE\] +- `{MediaInfo Video}` = x264 - `{MediaInfo VideoCodec}` = x264 - `{MediaInfo VideoBitDepth}` = 8 - `{MediaInfo VideoDynamicRange}` = HDR @@ -239,6 +241,9 @@ Standard Episode Format - Set the naming convention for your Standard Series Typ > `MediaInfo Full`, `AudioLanguages`, and `SubtitleLanguages` support a `:EN+DE` suffix allowing you to filter the languages included in the filename. Use `-DE` to exclude specific languages. Appending + (e.g.: `:EN+`) will output `[EN]`,`[EN+--]` or `[--]` depending on excluded languages. For example `{MediaInfo Full:EN+DE}`. {.is-info} +> `MediaInfo Video` and `MediaInfo Audio` are aliases of `MediaInfo VideoCodec` and `MediaInfo AudioCodec` respectively. +{.is-info} + > `AudioLanguages` will not display a language for audio if only one language exists and it is EN (English). To get the desired behavior and as an example display German and English, use {MediaInfo AudioLanguagesAll:DE+EN} instead. {.is-info} @@ -248,9 +253,13 @@ Standard Episode Format - Set the naming convention for your Standard Series Typ ### Other - `{Release Group}` = Rls Grp +- `{Release Hash}` = 79AFD88 - `{Custom Formats}` = iNTERNAL or NF - `{Custom Format:FormatName}` = AMZN +> `{Release Hash}` outputs the scene release hash when the episode file's release includes one, and produces no output otherwise. +{.is-info} + > `{Custom Formats}` outputs every Custom Format that matched the release and has "Include Custom Format when Renaming" enabled, separated by spaces. Add an optional name filter to narrow it: `{Custom Formats:NameA,NameB}` includes only those formats, while `{Custom Formats:-NameA,NameB}` excludes them. {.is-info} @@ -626,17 +635,18 @@ The timer period can be different for Usenet and Torrents. Each profile can be a - HDTV-720p - A re-encode of the final released Blu-ray, but broadcast over HD cable or satellite (1280x720 @ 16:9, any other aspect ratio may be a different resolution). It may be modified for runtime or content depending on the network it came from. This is released usually several months after a retail release, but sometimes upscaled versions of a Standard Definition film are released on cable channels such as STARZ or HBO, and they would be the only HD copies of that specific film available. These are generally MKV or MP4. - HDTV-1080p - A re-encode of the final released Blu-ray, but broadcast over HD cable or satellite (1920x1080 @ 16:9, any other aspect ratio may be a different resolution). It may be modified for runtime or content depending on the network it came from. This is released usually several months after a retail release, but sometimes upscaled versions of a Standard Definition film are released on cable channels such as STARZ or HBO, and they would be the only HD copies of that specific film available. These are generally MKV or MP4 container. - Raw-HD - A raw feed of an HD stream. +- WEBDL-720p - WEB-DL (P2P) refers to a file losslessly ripped from a streaming service, such as Netflix, Amazon Video, Hulu, Crunchyroll, Discovery GO, BBC iPlayer, etc., or downloaded via an online distribution website such as iTunes. The quality is quite good, since they are not reencoded. The video (H.264 or H.265) and audio (AC3/AAC) streams are usually extracted from the iTunes or Amazon Video and remuxed into a MKV container without sacrificing quality. An advantage with these releases is that, like BD/DVDRips, they usually have no onscreen network logos. These are nearly as good as a Blu-ray source but can suffer from audio lag or visual artifacts from the adaptive bitrate of streaming services. If a ripper's internet connection drops to a point where the bitrate lowers, the source bitrate could change dynamically, causing variations in picture quality. Most releases that suffer from an extreme amount of visual artifacts are NUKED and a PROPER is generally released to fix any wild variations in adaptive bitrate. This will be in 720p quality. - WEBRip-720p - In a WEB-Rip (P2P), the file is often extracted using the HLS or RTMP/E protocols and remuxed from a TS, MP4 or FLV container to MKV. This will be in 720p quality. - Bluray-720p - A re-encode of the final released Blu-ray, downscaled to 720p resolution (1280x720 @ 16:9, any other aspect ratio may be a different resolution). If possible this is released PRE retail. It should be excellent quality for the resolution. Bitrates may vary, but these are generally encoded to AVC or HEVC and offer the tradeoff of a small perceived quality reduction over the original source while drastically reducing filesize. These are generally MKV or MP4 container. - WEBDL-1080p - WEB-DL (P2P) refers to a file losslessly ripped from a streaming service, such as Netflix, Amazon Video, Hulu, Crunchyroll, Discovery GO, BBC iPlayer, etc., or downloaded via an online distribution website such as iTunes. The quality is quite good, since they are not reencoded. The video (H.264 or H.265) and audio (AC3/AAC) streams are usually extracted from the iTunes or Amazon Video and remuxed into a MKV container without sacrificing quality. An advantage with these releases is that, like BD/DVDRips, they usually have no onscreen network logos. These are nearly as good as a Blu-ray source but can suffer from audio lag or visual artifacts from the adaptive bitrate of streaming services. If a ripper's internet connection drops to a point where the bitrate lowers, the source bitrate could change dynamically, causing variations in picture quality. Most releases that suffer from an extreme amount of visual artifacts are NUKED and a PROPER is generally released to fix any wild variations in adaptive bitrate. This will be in 1080p quality. - WEBRip-1080p - In a WEB-Rip (P2P), the file is often extracted using the HLS or RTMP/E protocols and remuxed from a TS, MP4 or FLV container to MKV. This will be in 1080p quality. - Bluray-1080p - A re-encode of the final released Blu-ray, at its native 1080p resolution (1920x1080 @ 16:9, any other aspect ratio may be a different resolution). If possible this is released PRE retail. It should be excellent quality and the same resolution as the source. Bitrates may vary, but these are generally encoded to AVC or HEVC and offer the tradeoff of a small perceived quality reduction over the original source while slightly reducing filesize. These are generally MKV or MP4 container. -- Remux-1080p - A remux is a rip of a Blu-ray or HD DVD disc to another container format or just stripping the disc of menus and bonus material while keeping the contents of its audio and video streams intact (also keeping the current codecs), guaranteeing the exact 1:1 movie quality as on original disc. This is at 1080p quality. +- Bluray-1080p Remux - A remux is a rip of a Blu-ray or HD DVD disc to another container format or just stripping the disc of menus and bonus material while keeping the contents of its audio and video streams intact (also keeping the current codecs), guaranteeing the exact 1:1 video/episode quality as on original disc. This is at 1080p quality. - HDTV-2160p - TVRip is a capture source from an capture card. HDTV stands for captured source from HD television. With an HDTV source, the quality can sometimes even surpass DVD. Movies in this format are starting to grow in popularity. Some advertisement and commercial banner can be seen on some releases during playback. This is at 2160p (4K) quality. - WEBDL-2160p - WEB-DL (P2P) refers to a file losslessly ripped from a streaming service, such as Netflix, Amazon Video, Hulu, Crunchyroll, Discovery GO, BBC iPlayer, etc., or downloaded via an online distribution website such as iTunes. The quality is quite good, since they are not reencoded. The video (H.264 or H.265) and audio (AC3/AAC) streams are usually extracted from the iTunes or Amazon Video and remuxed into a MKV container without sacrificing quality. An advantage with these releases is that, like BD/DVDRips, they usually have no onscreen network logos. These are nearly as good as a Blu-ray source but can suffer from audio lag or visual artifacts from the adaptive bitrate of streaming services. If a ripper's internet connection drops to a point where the bitrate lowers, the source bitrate could change dynamically, causing variations in picture quality. Most releases that suffer from an extreme amount of visual artifacts are NUKED and a PROPER is generally released to fix any wild variations in adaptive bitrate. This will be in 2160p (4K) quality. - WEBRip-2160p - In a WEB-Rip (P2P), the file is often extracted using the HLS or RTMP/E protocols and remuxed from a TS, MP4 or FLV container to MKV. This will be in 2160p (4k) quality. - Bluray-2160p - A re-encode of the final released Blu-ray, at its native 2160p resolution (3840x2160 @ 16:9, any other aspect ratio may be a different resolution). 4K versions of films that are released in generally HEVC codec and could be either 8-bit or 10-bit color reproduction or from an HDR source. slightly reducing filesize. These are generally MKV or MP4 container. -- Remux-2160p - A remux is a rip of a Blu-ray or HD DVD disc to another container format or just stripping the disc of menus and bonus material while keeping the contents of its audio and video streams intact (also keeping the current codecs), guaranteeing the exact 1:1 movie quality as on original disc. This is at 2160p (4K) quality. +- Bluray-2160p Remux - A remux is a rip of a Blu-ray or HD DVD disc to another container format or just stripping the disc of menus and bonus material while keeping the contents of its audio and video streams intact (also keeping the current codecs), guaranteeing the exact 1:1 video/episode quality as on original disc. This is at 2160p (4K) quality. # Indexers @@ -703,6 +713,7 @@ The timer period can be different for Usenet and Torrents. Each profile can be a - (Advanced Option) Minimum Seeders - The minimum number of seeders required for a release from this tracker to be grabbed. - (Advanced Option) Seed Ratio - If empty, use the download client default. Otherwise, the minimum seed ratio required for your download client to meet for releases from this indexer prior to it being paused by your client and removed by Sonarr (Requires Completed Download Handling - Remove enabled) - (Advanced Option) Seed Time - If empty, use the download client default. Otherwise, the minimum seed time in minutes required for your download client to meet for releases from this indexer prior to it being paused by your client and removed by Sonarr (Requires Completed Download Handling - Remove enabled) +- (Advanced Option) Season-Pack Seed Time - If empty, use the Seed Time value above. Otherwise, the minimum seed time in minutes required for season-pack torrents from this indexer, applied instead of the regular Seed Time for those releases. - (Advanced Option) Indexer Priority - Priority of this indexer to prefer one indexer over another in release tiebreaker scenarios. 1 is highest priority and 50 is lowest priority. - (Advanced Option) Download Client - Select and specify which download client is used for grabs from this indexer - (Advanced Option) Fail Downloads - Mark the download are failed if the specified file extensions are encountered. @@ -781,7 +792,8 @@ Select the download client you wish to add, and there will be a pop-up box to en - Older Priority - download client priority for media released not recently - (Advanced Option) Client Priority - Priority of the download client. Round-Robin is used for clients of the same type (torrent/usenet) that have the same priority. 1 is highest priority and 50 is lowest priority - Completed Download Handling - - Remove (Per Client Setting) - Remove completed downloads when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) + - Remove Completed (Per Client Setting) - Remove imported downloads from the download client's history when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) + - Remove Failed (Per Client Setting) - Remove failed downloads from the download client's history. ### Torrent Client Settings @@ -800,8 +812,9 @@ Select the download client you wish to add, and there will be a pop-up box to en - Initial State - Initial state for torrents (Qbittorrent Only: Forced bypasses all seed thresholds) - (Advanced Option) Client Priority - Priority of the download client. Round-Robin is used for clients of the same type (torrent/usenet) that have the same priority. 1 is highest priority and 50 is lowest priority - Completed Download Handling - - Remove (Per Client Setting) - Remove completed downloads when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) + - Remove Completed (Per Client Setting) - Remove imported downloads from the download client's history when finished (usenet) or stopped/complete (torrents). See [Completed Download Handling for more details](#completed-download-handling) - For torrents this requires your download client to pause upon hitting the seed goals. It also requires the seed goals to be supported by Sonarr per the below table. Torrents must also stay in the same category. + - Remove Failed (Per Client Setting) - Remove failed downloads from the download client's history. ### Torrent Client Remove Download Compatibility @@ -828,8 +841,9 @@ Select the download client you wish to add, and there will be a pop-up box to en - Completed Download Handling is how Sonarr imports media from your download client to your series folders. Many common issues are related to bad Docker paths and/or other Docker permissions issues. - (Advanced Global Setting) Enable - Automatically import completed downloads from the download client -- (Per Client Setting) Remove - Remove completed downloads when finished (usenet) or stopped/complete (torrents) +- (Per Client Setting) Remove Completed - Remove imported downloads from the download client's history when finished (usenet) or stopped/complete (torrents) - For torrents this requires your download client to pause upon hitting the seed goals. It also requires the seed goals to be supported by Sonarr per the above table. Torrents must also stay in the same category. +- (Per Client Setting) Remove Failed - Remove failed downloads from the download client's history. ### Remove Completed Downloads @@ -861,7 +875,8 @@ If you download using a BitTorrent client, the process is slightly different: - Blocklisting (fka 'Blacklisting') allows automatic skipping of nzbs when they fail, this means that nzb will not be automatically downloaded by Sonarr ever again (You can still force the download via a manual search). - There are 2 advanced options (on 'Download Client' settings page) that control the behavior of failed downloading in Sonarr, at this time, they are all on by default. -- Redownload - Controls whether or not Sonarr will search for the same file after a failure +- Redownload Failed - Controls whether or not Sonarr will search for the same file after a failure +- (Advanced Option) Redownload Failed from Interactive Search - Only shown when Redownload Failed is enabled. Automatically search for and attempt to download a different release when the failed release was grabbed from an interactive search. - (Advanced Option) Remove - Whether or not the download should automatically be removed from Download Client when the failure is detected ## Remote Path Mappings @@ -1067,8 +1082,8 @@ If you download using a BitTorrent client, the process is slightly different: - The backup section allows you to tell Sonarr how you would like for it to handle backups - Folder - This allows you to select the backup location. In docker you will be limited to what you allow the container to see. Paths are relative to the appdata folder; if necessary, you can set an absolute path to backup outside of the appdata folder. -- Interval - How often would you like Sonarr to make a backup -- Retention - How long would you like Sonarr to hold on to each backup. After a new backup is made the oldest backup will be removed +- Interval - How often would you like Sonarr to make a backup (default: every 7 days) +- Retention - How long would you like Sonarr to hold on to each backup. After a new backup is made the oldest backup will be removed (default: 28 days) # UI diff --git a/sonarr/supported.md b/sonarr/supported.md index 742ee596f..500bbb0ca 100644 --- a/sonarr/supported.md +++ b/sonarr/supported.md @@ -176,6 +176,7 @@ This page is the disambiguation page for all "supported" wiki links (i.e. typica - [Refer to the Settings Page](/sonarr/settings#import-lists) - IMDb Lists {#imdblistimport} - [Refer to the Settings Page](/sonarr/settings#import-lists) + - The IMDb import list was removed from Sonarr (February 2025) because IMDb changed how `ls`-number lists are served and the feature became defunct. Users on older versions may still see this option, but it will not function. - MyAnimeList {#myanimelistimport} - [Refer to the Settings Page](/sonarr/settings#import-lists) - Plex Watchlist {#pleximport} diff --git a/sonarr/system.md b/sonarr/system.md index 2a9d9eeb3..6803dc258 100644 --- a/sonarr/system.md +++ b/sonarr/system.md @@ -43,7 +43,7 @@ dateCreated: 2021-09-08T17:58:43.288Z - [No indexers available with automatic search enabled, Sonarr will not provide any automatic search results](#no-indexers-available-with-automatic-search-enabled-sonarr-will-not-provide-any-automatic-search-results) - [No indexers available with RSS sync enabled, Sonarr will not grab new releases automatically](#no-indexers-available-with-rss-sync-enabled-sonarr-will-not-grab-new-releases-automatically) - [No indexers are enabled](#no-indexers-are-enabled) - - [Enabled indexers do not support searching](#enabled-indexers-do-not-support-searching) + - [All search-capable indexers are temporarily unavailable due to recent indexer errors](#all-search-capable-indexers-are-temporarily-unavailable-due-to-recent-indexer-errors) - [No indexers available with Interactive Search Enabled](#no-indexers-available-with-interactive-search-enabled) - [Indexers are unavailable due to failures](#indexers-are-unavailable-due-to-failures) - [Jackett All Endpoint Used](#jackett-all-endpoint-used) @@ -92,14 +92,14 @@ dateCreated: 2021-09-08T17:58:43.288Z #### New update is available -- Rejoice, the developers have released a new update. This generally means awesome new features and squashed piles of bugs (right?). Apparently you do not have Auto-Updating enabled, so you will have to figure out how to update on your platform. Pressing the Install button on the System => Updates page is probably a good starting point. +- A newer version of Sonarr is available. This warning fires once your installed build is more than 14 days old and a newer release exists, regardless of whether Auto-Updating is enabled. On a native install, go to System => Updates and press Install. On Docker, do not press Install inside the container; instead pull the new image tag and recreate the container. > This warning will not appear if your current version is less than 14 days old {.is-info} #### Cannot install update because startup folder and/or UI folder are not writable by the user -{#cannot-install-update-because-UI-folder-is-not-writable-by-the-user} +{#cannot-install-update-because-ui-folder-is-not-writable-by-the-user} {#cannot-install-update-because-startup-folder-is-not-writable-by-the-user} @@ -281,9 +281,6 @@ Go into Settings > Indexers, select an indexer you'd like to allow Automatic Sea #### No indexers available with RSS sync enabled, Sonarr will not grab new releases automatically -{#no-indexers-available-with-rss-sync-enabled,-sonarr-will-not-grab-new-releases-automatically} -{#all-rss-capable-indexers-are-temporarily-unavailable-due-to-recent-indexer-errors} - - Sonarr uses the RSS feed to pick up new releases as they come along. [See the FAQ for more information](/sonarr/faq#how-does-sonarr-find-episodes) - To correct this issue go to Settings > Indexers, select an indexer you have and enable RSS Sync. @@ -291,15 +288,15 @@ Go into Settings > Indexers, select an indexer you'd like to allow Automatic Sea - Sonarr requires indexers to be able to discover new releases. All your indexers are disabled or you do not have any indexers added. -#### Enabled indexers do not support searching +#### All search-capable indexers are temporarily unavailable due to recent indexer errors {#all-search-capable-indexers-are-temporarily-unavailable-due-to-recent-indexer-errors} -- None of the indexers you have enabled and available support searching. This means Sonarr will only be able to find new releases via the RSS feeds. But searching for series (either Automatic Search or Manual Search) will never return any results. The only way to remedy it is to add another indexer. +{#enabled-indexers-do-not-support-searching} -#### No indexers available with Interactive Search Enabled +- Every indexer capable of searching has recently failed and is in Sonarr's failure backoff, so no indexer is currently available for a search. This is transient, not a sign that your enabled indexers lack search support. Resolve the underlying indexer errors (check System => Logs and the indexer's status) rather than adding another indexer; once an indexer passes its `Test` or the backoff period elapses, it becomes available again. -{#no-indexers-available-with-interactive-search-enabled-sonarr-will-not-provide-any-interactive-search-results} +#### No indexers available with Interactive Search Enabled - None of the indexers you have enabled and available support interactive searching. This means the application will only be able to find new releases via the RSS feeds or an automatic search. @@ -367,8 +364,7 @@ Go into Settings > Indexers, select an indexer you'd like to allow Automatic Sea {#missing-root-folder} - A root folder is added to Sonarr and does not exist or is not accessible. -- This error is typically identified if a Series is looking for a root folder but that root folder is no longer available. -- This error may also be if a list is still pointed at a root folder but that root folder is no longer available. +- This check only evaluates the root folders your existing series use, so it fires when a Series is looking for a root folder but that root folder is no longer available. An import list pointed at a missing root folder is a separate check; see [Import List Missing Root Folder](#import-list-missing-root-folder). - If you would like to remove this warning simply find the series that is still using the old root folder and edit it to the correct root folder. - Easiest way to find the problem series is to: diff --git a/sonarr/troubleshooting.md b/sonarr/troubleshooting.md index ee2cbdaa3..64538f2e1 100644 --- a/sonarr/troubleshooting.md +++ b/sonarr/troubleshooting.md @@ -212,7 +212,7 @@ Sonarr talks to you download client via it's API and accesses it via the client' ### SSL in use and incorrectly configured -Ensure SSL encryption is not turned on if you're using both your instance and your download client on a local network. See [the SSL FAQ entry](/sonarr/faq#invalid-certificate-and-other-HTTPS-or-SSL-issues) for more information. +Ensure SSL encryption is not turned on if you're using both your instance and your download client on a local network. See [the SSL FAQ entry](/sonarr/faq#invalid-certificate-and-other-https-or-ssl-issues) for more information. ### Can’t see share on Windows diff --git a/whisparr/system.md b/whisparr/system.md index 38e6f1bff..d19f823f8 100644 --- a/whisparr/system.md +++ b/whisparr/system.md @@ -30,8 +30,6 @@ dateCreated: 2022-04-03T03:49:55.636Z - [System Time is off by more than 1 day](#system-time-is-off-by-more-than-1-day) - [MediaInfo Library Could not be Loaded](#mediainfo-library-could-not-be-loaded) - [PTP Indexer Settings Out of Date](#ptp-indexer-settings-out-of-date) - - [Mono Legacy TLS enabled](#mono-legacy-tls-enabled) - - [Mono and x86 builds are ending](#mono-and-x86-builds-are-ending) - [Allowed Hosts Not Configured](#allowed-hosts-not-configured) - [Download Clients](#download-clients) - [No download client is available](#no-download-client-is-available) @@ -195,14 +193,6 @@ Note: you will also need to add the websocket directive to your whisparr configu - The following PassThePopcorn indexers have deprecated settings and should be updated. -#### Mono Legacy TLS enabled - -- Mono 4.x tls workaround still enabled, consider removing MONO_TLS_PROVIDER=legacy environment option - -#### Mono and x86 builds are ending - -- Mono and x86 builds will no longer be supported in the next build of the application. If you are receiving this error then you are running the mono version of the application or the x86 version. Unfortunately, due to increasing difficulty in development support for these legacy versions we will be discontinuing their support and thus releases for them going forward. Thus it is advised you upgrade to a supported Operating System that does not require neither x86 nor mono. You may also be able to explore using Docker for your needs. - #### Allowed Hosts Not Configured {#allowed-hosts-not-configured} @@ -491,3 +481,15 @@ Note: you will also need to add the websocket directive to your whisparr configu - Whisparr uses rolling log files limited to 1MB each. The current log file is always whisparr.txt, for the the other files whisparr.0.txt is the next newest (the higher the number the older it is) up to 51 log files total. This log file contains `fatal`, `error`, `warn`, and `info` entries. - When Debug log level is enabled, additional whisparr.debug.txt rolling log files will be present, up to 51 files. This log files contains `fatal`, `error`, `warn`, `info`, and `debug` entries. It usually covers a ~40h period. - When Trace log level is enabled, additional whisparr.trace.txt rolling log files will be present, up to 51 files. This log files contains `fatal`, `error`, `warn`, `info`, `debug`, and `trace` entries. Due to trace verbosity it only covers a couple of hours at most. + +# Unsupported legacy build health checks + +These health checks only appear on unsupported, end-of-life builds (legacy Mono or x86, before the switch to .NET) and are not present in current releases. If you see one of them, your install is on an unsupported build. [Update to a supported release](/whisparr/faq#how-do-i-update-whisparr). + +## Mono Legacy TLS enabled + +Unsupported legacy mono build. [Update to a supported release](/whisparr/faq#how-do-i-update-whisparr). + +## Mono and x86 builds are ending + +Unsupported legacy mono or x86 build. [Update to a supported release](/whisparr/faq#how-do-i-update-whisparr).