Readarr System

From Servarr

Please note that this information is only for readarr V3.

Status

Health

This page contains a list of health checks errors. These health checks are periodically performed performed by Readarr and on certain events. The resulting warnings and errors are listed here to give advice on how to resolve them.

System Warnings
  • Update to .NET Core version
    • Newer versions of Readarr are targeted for .NET. We will soon no longer provide legacy mono builds for those platforms that cannot use .NET. You are running one of these legacy builds but your platform supports .NET Core.
    • 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. Do not install .net core runtime or SDK from microsoft. To remedy, download the correct build for your architecture. Please note that the links are for the master branch. If you are on develop or nightly you'll need to adjust /master/ in the URL.
      • Delete your existing binaries (contents or folder of /opt/Readarr) and replace with the contents of the .tar.gz you just downloaded.
      • DO NOT JUST EXTRACT THE DOWNLOAD OVER THE TOP OF YOUR EXISTING BINARIES.
        YOU MUST DELETE THE OLD ONES FIRST
        .
        • wget --content-disposition 'http://readarr.servarr.com/v1/update/master/updatefile?os=linux&runtime=netcore&arch=x64' Download the .net binaries. The example is for a x64 (AMD64) installation.
          • For most users, this would be .linux-core-x64.tar.gz selected via arch=x64 in the url. For ARM use arch=arm and for ARM64 use arch=arm64
        • sudo systemctl stop readarr Stop Readarr
        • sudo mv /opt/Readarr /opt/Readarr.old Backup the old Binaries
        • tar -xvzf Readarr*.linux-core-x64.tar.gz Extract the Readarr Tarball
        • sudo mv Readarr/ /opt Move the new Readarr Binaries
        • sudo chown -R readarr:readarr /opt/Readarr Ensure Readarr has permissions to its directory, this assumes it runs as the user readarr
        • sudo rm -rf /opt/Readarr.old Remove the old binaries
        • sudo rm -rf Readarr*.linux-core-x64.tar.gz Remove the Tarball
        • Update your startup script ( sudo nano -e /etc/systemd/system/readarr.service) to call Readarr instead of calling it with mono like mono --debug Readarr.exe. In other words you want, as an example, /opt/Readarr/Readarr and not mono --debug /opt/Readarr/Readarr.
        • systemctl daemon-reload Reload the Systemd Files
        • sudo systemctl start readarr.service Restart Readarr
  • 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.
    • (This warning will not appear if your current version is less than 14 days old)
  • Branch is for a previous version
    • The update branch setup in Settings/General is for a previous version of Lidarr, 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.
    • The most common occurrence of this is use of a reverse proxy or cloudflare
    • Cloudflare needs websockets enabled.
    • Nginx requires the following addition to the location block for the app:
 proxy_http_version 1.1;
 proxy_set_header Upgrade $http_upgrade;
 proxy_set_header Connection $http_connection;
    • Make sure you do not include proxy_set_header Connection "Upgrade"; as suggested by the nginx documentation. THIS WILL NOT WORK
    • See https://github.com/aspnet/AspNetCore/issues/17081
    • For Apache2 reverse proxy, you need to enable the following modules: proxy, proxy_http, and proxy_wstunnel. Then, add this websocket tunnel directive to your vhost configuration:
RewriteEngine On
RewriteCond %{HTTP:Upgrade} =websocket [NC]
RewriteRule /(.*) ws://127.0.0.1:8787/$1 [P,L]
  • Proxy Failed Test
    • Your configured proxy failed to test successfully, review the HTTP error provided and/or check logs for more details.
  • System Time is off by more than 1 day
    • 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
  • Mono Legacy TLS enabled
    • Mono 4.x tls workaround still enabled, consider removing MONO_TLS_PROVIDER=legacy environment option


Download Clients
  • No download client is available
    • A properly configured and enabled download client is required for Readarr to be able to download media. Since Readarr supports different download clients, you should determine which best matches your requirements. If you already have a download client installed, you should configure Lidarr to use it and create a category. See Settings -> Download Client.
  • Unable to communicate with download client
    • Readarr was unable to communicate with the configured download client. Please verify if the download client is operational and double check the url. This could also indicate an authentication error.
    • This is typically due to improperly configured download client. Things you can typically check:
      • Your download clients IP Address if its on the same bare metal machine this is typically 127.0.0.1
      • The Port number of that your download client is using these are filled out with the default port number but if you've changed it you'll need to have the same one entered into Readarr.
      • Ensure SSL encryption is not turned on if you're using both your Readarr instance and your download client on a local network. See the SSL FAQ entry for more information.
  • Download clients are unavailable due to failure
    • One or more of your download clients is not responding to requests made by Readarr. Therefore Readarr 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, Readarr 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 Readarr to prevent the errors.
  • Enable Completed Download Handling
    • Readarr requires Completed Download Handling to be able to import files that were downloaded by the download client. It is recommended to enable Completed Download Handling.
    • (Completed Download Handling is enabled by default for new users.)
  • Docker bad remote path mapping
    • This error is typically associated with bad docker paths within either your download client or Readarr
      • An example of this would be:
        • Download client: Download Path: /downloads:/mnt/user/downloads
        • Readarr: Download Path: /data:/mnt/user/downloads
        • Within this example the download client places its downloads into /downloads and therefore tells Radarr when its complete that the finished book is in /downloads. Readarr then comes along and says "Okay, cool, let me check in /downloads" Well, inside Readarr you did not allocate a /downloads path you allocated a /data path so it throws this error.
        • The easiest fix for this is CONSISTENCY if you use one scheme in your download client, use it across the board.
        • Team Readarr is a big fan of simply using /data.
          • Download client: /data:/mnt/user/data
          • Readarr: /data:/mnt/user/data
          • Now within the download client you can specify where in /data you'd like to place your downloads, now this varies depending on the client but you should be able to tell it "Yeah download client place my files into." /data/torrents (or usenet)/books and since you used /data in Readarr when the download client tells Readarr it's done Readarr will come along and say "Sweet, I have a /data and I also can see /torrents (or usenet)/books all is right in the world."
      • There are many great write ups by some very talented people one on our wiki Docker Guide and the other by TRaSH with his How To Set Up Hardlinks and Atomic-Moves Now these guides place heavy emphasis on Hardlinks and Atomic moves, but the general concept of containers and how path mapping works is the core of these discussions.
  • Downloading into Root Folder
    • You're downloading directly into your root folder. This frequently causes issues and is not advised. To fix this change your download client so it is not placing downloads within your root folder. Please note that this check looks at all defined/configured root folders added not only root folders currently in use.
  • Bad Download Client Settings
    • The location your download client is downloading files to is causing problems. Check the logs for further information. This may be permissions or attempting to go from windows to linux or linux to windows without a remote path map.
  • Permissions Error
    • Readarr or the user readarr is running as cannot access the location your download client is downloading files to. This is typically a permission issue.


Completed/Failed Download Handling
  • Completed Download Handling is disabled
    • (This warning is only generated for existing users before when the Completed Download Handling feature was implemented. This feature is disabled by default to ensure the system continued to operate as expected for current configurations.)
    • It’s recommended to use Completed Download Handling since it provides better compatibility for the unpacking and post-processing logic of various download clients. With it, Readarr will only import a download once the download client reports it as ready.
    • If you wish to enable Completed Download Handling you should verify the following: * Warning: Completed Download Handling only works properly if the download client and Readarr are on the same machine since it gets the path to be imported directly from the download client otherwise a remote map is needed.


Indexers
Author Folders
  • Missing root folder
    • This error is typically identified if an author is looking for a root folder but that root folder is no longer available.
      • If you would like to remove this warning simply find the author that is still using the old root folder and edit it to the correct root folder
        1. Go to the Library > Mass Editor Tab
        2. Create a custom filter with the old root folder path
        3. Once the series have been found find the Root Paths drop down and select the new root path that you want these authors to be moved to.
        4. Next you'll receive a pop-up that states Would you like to move the author folders to '<root path>'? Simply select No if the you do not want Readarr to move your files


Media

Text


Disk Space

  • This section will show you available disk space
    • In docker this can be tricky as it will typically show you the available space within your Docker image


About

This will tell you about your current install of Readarr

More Info


Tasks

Scheduled

This page lists all scheduled tasks that Readarr runs

  • Application Check Update - This will run on the displayed schedule in the UI, checking to see if Readarr is on the most current version then triggering the update script to update Readarr. More Info
    • Note: If on Docker this will not update your container as a new image will need to be downloaded.
  • Backup - This will run a backup of your Readarr's database on a set schedule more details on this can be found here. More information about backups can be found here.
  • Check Health - Check Health will run on the displayed schedule in the UI, checking the overall health of your Readarr. To see a list of possible health related issues click here.
  • Clean Up Recycle Bin - The recycling bin will be cleared out every day. This will only be used if the recycling bin is set in File Management
  • Housekeeping - On the displayed schedule in the UI, this will dust out all the cobwebs, sweeps and vacuums the floors, mops, shines, and even makes nice neat little folded notes just for you. But does not take out the trash. That it just was not paid enough for.
  • Import List Sync - On the displayed schedule in the UI, this will run your Lists and import any possible new authors. More info about lists can be found here.
  • Messaging Cleanup - On the displayed schedule in the UI, this cleans up those messages that appear in the bottom left corner of Readarr
  • Refresh Monitored Downloads - This goes through and refreshes the downloads queue located under Activity. Essentially pinging your download client to check for finished downloads.
  • Refresh Author- This goes through and refreshes all the metadata for all monitored and unmonitored authors
  • Rss Sync - This will run the RSS Sync. This can be changed here. More information on the RSS function can be found here
  • Note: All these tasks can be ran manually outside their scheduled times by hitting the icon to the far right of each of the tasks.


Queue

The queue will show you upcoming tasks as well as a history of recently ran tasks as well as how long those tasks took.


Backup

  • Note: This section will be more tailored to the buttons and overall point of the page.

However, if you're looking for how to back/restore your Readarr instance click here.

  • Within the Backup section you'll be presented with previous backups (unless you have a fresh install that hasn't made any backups).
  • Here you'll have two options at the top of the screen
    • Backup Now - This option will trigger a manual backup of your Readarr's database
    • Restore Backup - This will open a new screen to restore from a previous backup
      • By selecting Choose File this will prompt your browser to open a dialog box to restore from a Readarr Zip backup
  • Finally if you have any previous backups and would like to download them from Readarr to be placed in a non standard location you simply can select one of these files to download them
    • Off to the right of each of the previous download you have two options.
      • One - To restore from a previous backup - This will open a new window to confirm you want to restore from this backup
      • Two - To delete a previous backup


Updates

  • The update screen will show the past 5 updates that have been made as well as the current version you are on.
    • This page will also display the update notes from the Devs telling you what has been fixed or added to Readarr (Rejoice!)
    • A Maintenance Release contains bug fixes and other various improvements. Take a look at the commit history for specifics.


Events

The events tab will show you what has been happening within your Readarr. This can be used to diagnose some light issues. However, this does not replace Trace Logs discussed in Logging. Events are the equivalent of INFO Logs.

  • Components - This column will tell you what component within Readarr has been triggered
  • Message - This column will tell you what message as been sent from the component from the previous column.
  • Gear Icon - This option will allow you to change how many Components/Messages are displayed per page (Default is 50)
  • Options at the top of the page
    • Refresh - This option will refresh the current page, pulling a new events log
    • Clear - This will clear the current events log allowing you to start from fresh


Log Files

This page will allow you to download and see what current log files are available for Readarr

  • On the top row there are several options to allow you to control your log files.
    • The top row on the far left there is a dropdown that will allow you to switch from Log files and Updater Log Files
      • Log Files - The bread and butter of any support issue more on log files can be found here.
      • Updater Log Files - This will show the log files associated with Readarr's updater script
        • Note: If you're on docker this will be empty as you should be updating by downloading a new docker image
    • Refresh - This will refresh the current page and display any newly created logs
    • Delete - This will clear all logs allowing you to start from fresh
    • File Name - This will display the file name associated with the log
    • Last Written - This is the local time that this particular log file was written to.
      • Readarr uses rolling log files limited to 1MB each. The current log file is always readarr.txt, for the the other files readarr.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 readarr.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 readarr.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.