Note: Raspberry Pi OS and Raspbian are both flavors of Debian
For the Debian / Ubuntu / Raspbian beginners there isn't an Apt Repository or Deb package.
If you want an easy life, follow this community provided and maintained Easy Install script for a base Debian (Raspbian / Raspberry Pi OS) / Ubuntu install.
For the official installation instructions that are 'Hands on' follow the Debian / Ubuntu Hands on Install steps further below.
Please see the *Arr Community Installation Script
It is assumed you have a basic knowledge of linux or the ability to google / learn as necessary. Otherwise it is suggested to use an OS you know and understand
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;mediais the commonly suggested group to run the *Arrs, download clients, and media server under.
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 for it
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/develop/updatefile?os=linux&runtime=netcore&arch=x64'
tar -xvzf Readarr*.linux*.tar.gz
/opt/sudo mv Readarr /opt/
Note: 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 readarr:readarr -R /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
Typically to access the Readarr web GUI browse to http://{Your server IP Address}:8787
If Readarr did not appear to start, then check the status of the service:
sudo journalctl --since today -u readarr
To uninstall and purge:
Warning: This will destroy your application data.
sudo systemctl stop readarr
sudo rm -rf /opt/Readarr
sudo rm -rf /var/lib/readarr
sudo rm -rf /etc/systemd/system/readarr.service
sudo systemctl -q daemon-reload
To uninstall and keep your application data:
sudo systemctl stop readarr
sudo rm -rf /opt/Readarr
sudo rm -rf /etc/systemd/system/readarr.service
sudo systemctl -q daemon-reload