Readarr is supported natively on Windows. Readarr can be installed on Windows as Windows Service or system tray application.
Windows versions are limited for support to those currently supported by Microsoft, others may work but this is an unsupported configuration
A Windows Service runs even when the user is not logged in, but special care must be taken since Windows Services cannot access network drives (X:\ mapped drives or \server\share UNC paths) without special configuration steps.
Additionally the Windows Service runs under the 'Local Service' account, by default this account does not have permissions to access your user's home directory unless permissions have been assigned manually. This is particularly relevant when using download clients that are configured to download to your home directory.
It's therefore advisable to install Readarr as a system tray application if the user can remain logged in. The option to do so is provided during the installer.
You may have to run once "As Administrator" after installing in tray mode, if you get an access error -- such as Access to the path
C:\ProgramData\Readarr\config.xmlis denied -- or you use mapped network drives. This gives Readarr the permissions it needs. You should not need to run As Administrator every time.
Warning: If you run Plex as a service via PmsService you will either need to change PMsService's port from
8787or you will need to modify the port Readarr runs on in theconfig.xmlfile.
Readarr is curretly in beta testing and is generally still in a work in progress. Features may be broken, incomplete, or cause spontaneous combustion.
It is possible to install Readarr manually using the x64 .zip download. However in that case you must manually deal with dependencies, installation and permissions.
Readarr not compatible with OSX versions < 10.13 (High Sierra) due to netcore incompatibilities.
Readarr is curretly in beta testing and is generally still in a work in progress. Features may be broken, incomplete, or cause spontaneous combustion.
Readarr is curretly in beta testing and is generally still in a work in progress. Features may be broken, incomplete, or cause spontaneous combustion.
You'll need to install the binaries using the below commands.
The steps below will download Readarr and install it into
/opt
Readarr will run under the userreadarrand groupmedia
Readarr's configuration files will be stored in/var/lib/readarr
sudo apt install curl sqlite3
Warning: Ignoring the below prerequisites will result in a failed installation and non-functional application.
Installation Prerequisites
The below instructions are based on the following prerequisites. Change the instructions as needed to suit your specific needs if necessary.
* The userreadarris created
* The userreadarris part of the groupmedia
* Your download clients and media server run as and are a part of the groupmedia
* Your paths used by your download clients and media server are accessible (read/write) to the groupmedia
* If Calibre will be used, Calibre runs as the groupmediaand the Calibre library has read/write permissions formedia
* You created the directory/var/lib/readarrand ensured the userreadarrhas read/write permissions
By continuing below, you acknowledge that you have read and met the above requirements.
dpkg --print-architecture
arch=x64arch=armarch=arm64wget --content-disposition 'http://readarr.servarr.com/v1/update/nightly/updatefile?os=linux&runtime=netcore&arch=x64'
tar -xvzf Readarr*.linux*.tar.gz
/opt/sudo mv Readarr/ /opt
This assumes you have created the user and will run as the user
readarrand groupmedia. You may change this to fit your usecase. It's important to choose these correctly to avoid permission issues with your media files. We suggest you keep at least the group name identical between your download client(s) and Readarr. Please note that if use wish to use Calibre - Readarr will need permissions for that directory.
sudo chown -R readarr:readarr /opt/Readarr
The below systemd creation script will use a data directory of
/var/lib/readarr. Ensure it exists or modify it as needed. For the default data directory of/home/$USER/.config/Readarrsimply remove the-dataargument. Note: that$USERis the User Readarr runs as and is defined below.
cat << EOF | sudo tee /etc/systemd/system/readarr.service > /dev/null
[Unit]
Description=Readarr Daemon
After=syslog.target network.target
[Service]
User=readarr
Group=media
Type=simple
ExecStart=/opt/Readarr/Readarr -nobrowser -data=/var/lib/readarr/
TimeoutStopSec=20
KillMode=process
Restart=on-failure
[Install]
WantedBy=multi-user.target
EOF
sudo systemctl -q daemon-reload
sudo systemctl enable --now -q readarr
rm Readarr*.linux*.tar.gz
The Readarr team does not offer an official Docker image. However, a number of third parties have created and maintain their own.
These instructions provide generic guidance that should apply to any Readarr Docker image.
There are two common problems with Docker volumes: Paths that differ between the Readarr and download client container and paths that prevent fast moves and hard links.
The first is a problem because the download client will report a download's path as /torrents/My.Book.2018.epub/, but in the Readarr container that might be at /downloads/My.Book.2018.epub/. The second is a performance issue and causes problems for seeding torrents. Both problems can be solved with well planned, consistent paths.
Most Docker images suggest paths like /books and /downloads. This causes slow moves and doesn't allow hard links because they are considered two different file systems inside the container. Some also recommend paths for the download client container that are different from the Readarr container, like /torrents.
The best solution is to use a single, common volume inside the containers, such as /data. Your books would be in /data/Books, torrents in /data/downloads/torrents and/or usenet downloads in /data/downloads/usenet.
If this advice is not followed, you may have to configure a Remote Path Mapping in the Readarr web UI (Settings › Download Clients).
When installing Readarr, you can choose to use Calibre integration or not. This choice can only be made during installation, and if you choose not to utilize Calibre you cannot add it later. If you currently use Calibre to manage your book library, you should choose this option. If you use it, Calibre will name and organize your book files for you.
If you are running Calibre, you must first start the Calibre Content Server (Preferences / Sharing over the net), and also set up a user and password. This will require a Calibre restart.
Please note that Calibre Content Server and Calibre are NOT Calibre Web. Calibre Web is a separate tool unrelated to either of these programs, and is not required nor used by Readarr in any way.
Permissions and ownership of files is one of the most common problems for Readarr users, both inside and outside Docker. Most images have environment variables that can be used to override the default user, group and umask, you should decide this before setting up all of your containers. The recommendation is to use a common group for all related containers so that each container can use the shared group permissions to read and write files on the mounted volumes.
Keep in mind that Readarr will need read and write to the download folders as well as the final folders.
For a more detailed explanation of these issues, see The Best Docker Setup and Docker Guide wiki article.
To install and use these Docker images, you will need to keep the above in mind while following their documentation. There are many ways to manage Docker images and containers too, so installation and maintenance of them will depend on the route you choose.
Temporarily, you will need to use the
:nightlytag with docker images, as there is nomasternordevelopbranch.
Sample config examples for configuring Readarr to be accessible through a reverse proxy.
These examples assumes the default port of
8787and that you set a baseurl ofreadarr. It also assumes your web server i.e nginx and Readarr running on the same server accessible atlocalhost. If not, use the host IP address or a FDQN instead for the proxy pass.
location /readarr {
proxy_pass http://127.0.0.1:8787/readarr;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-Proto https;
proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $http_connection;
}
location /readarr/api { auth_request off;
proxy_pass http://127.0.0.1:8787/readarr/api;
}
location /readarr/Content { auth_request off;
proxy_pass http://127.0.0.1:8787/readarr/Content;
}
This should be added within an existing VirtualHost site. If you wish to use the root of a domain or subdomain, remove readarr from the Location block and simply use / as the location.
Note: Do not remove the baseurl from ProxyPass and ProxyPassReverse if you want to use / as the location.
<Location /readarr>
ProxyPass http://127.0.0.1:8787/readarr connectiontimeout=5 timeout=300
ProxyPassReverse http://127.0.0.1:8787/readarr
</Location>
If you implement any additional authentication through Apache, you should exclude the following paths:
/readarr/api//readarr/Content/The following requirements should be noted:
-data= or /data= argument passedContributions welcome and encouraged.
-data= argument passed.systemctl stop readarrBelow is an example script to create a RadarrAudio instance. The below systemd creation script will use a data directory of
/var/lib/readarraudio/. Ensure it exists or modify it as needed.
cat << EOF | sudo tee /etc/systemd/system/readarraudio.service > /dev/null
[Unit]
Description=ReadarrAudio Daemon
After=syslog.target network.target
[Service]
User=readarr
Group=media
Type=simple
ExecStart=/opt/Readarr/Readarr -nobrowser -data=/var/lib/readarraudio/
TimeoutStopSec=20
KillMode=process
Restart=on-failure
[Install]
WantedBy=multi-user.target
EOF
sudo systemctl -q daemon-reload
sudo systemctl enable --now -q readarraudio