Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| sailing:readarr [2023/12/05 08:27] – willy | sailing:readarr [2024/02/27 12:20] (current) – removed willy | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | Prev to: [[sailing: | ||
| - | Next to: [[sailing: | ||
| - | ---- | ||
| - | ====== Readarr: the books and audiobooks organizer ====== | ||
| - | |||
| - | [[https:// | ||
| - | On the good side, Readarr feels and behaves like the other *Arr' | ||
| - | * Currently all (or most of) metadata searches are broken. Upstream devs are aware and working on it, but currently it's basically unusable. | ||
| - | * To supporto both e-books and audio-books you need to install two instances of Readarr (like for Radarr and 4K / 1080p movies) | ||
| - | |||
| - | I will show you how to run two instances here, as i assume that the first point will be fixed sooner or later, but for the moment you might want to skip to the next page and install [[sailing: | ||
| - | |||
| - | |||
| - | ===== Installation ===== | ||
| - | |||
| - | Readarr is easily installed and managed within Gentoo linux since there is an ebuild for it. All you need to do is unmask it (at the time of writing this it's are masked for AMD64 at least): | ||
| - | <code bash> | ||
| - | > echo www-apps/ | ||
| - | </ | ||
| - | |||
| - | then install it: | ||
| - | <code bash> | ||
| - | > emerge -v readarr | ||
| - | </ | ||
| - | |||
| - | This step will create a dedicated //readarr// user but you will want to add it to the group //media//, that you have created before, so that the it will be able to access and manage your media collection: | ||
| - | <code bash> | ||
| - | > usermod -a -G media readarr | ||
| - | </ | ||
| - | |||
| - | Also, you want to move Readarr home folder under **/ | ||
| - | <code bash> | ||
| - | > usermod -m -d / | ||
| - | </ | ||
| - | |||
| - | You will need only one installation of Readarr to run two instances of the service, but you need to duplicate the start script. Create the following file in **/ | ||
| - | <file txt readarr-audiobooks> | ||
| - | pidfile="/ | ||
| - | command="/ | ||
| - | command_user=" | ||
| - | command_args=" | ||
| - | command_background=true | ||
| - | </ | ||
| - | |||
| - | You can, if you want, rename the **/ | ||
| - | |||
| - | |||
| - | ===== Reverse-Proxy configuration ===== | ||
| - | |||
| - | Before you proceed, you should make Readarr accessible via the reverse-proxy, | ||
| - | <file txt readarr-books.conf> | ||
| - | # Readarr - Books | ||
| - | location ^~ / | ||
| - | proxy_pass http:// | ||
| - | 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 $scheme; | ||
| - | proxy_redirect off; | ||
| - | proxy_http_version 1.1; | ||
| - | proxy_set_header Upgrade $http_upgrade; | ||
| - | proxy_set_header Connection $http_connection; | ||
| - | } | ||
| - | # Allow the API External Access via NGINX | ||
| - | location ^~ / | ||
| - | auth_basic off; | ||
| - | proxy_pass http:// | ||
| - | } | ||
| - | </ | ||
| - | <file txt readarr-audiobooks.conf> | ||
| - | # Readarr - audiolibri | ||
| - | location ^~ / | ||
| - | proxy_pass http:// | ||
| - | 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 $scheme; | ||
| - | proxy_redirect off; | ||
| - | proxy_http_version 1.1; | ||
| - | proxy_set_header Upgrade $http_upgrade; | ||
| - | proxy_set_header Connection $http_connection; | ||
| - | } | ||
| - | # Allow the API External Access via NGINX | ||
| - | location ^~ / | ||
| - | auth_basic off; | ||
| - | proxy_pass http:// | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | Add them to your **/ | ||
| - | < | ||
| - | include " | ||
| - | include " | ||
| - | </ | ||
| - | |||
| - | and restart nginx: | ||
| - | <code bash> | ||
| - | > / | ||
| - | </ | ||
| - | |||
| - | ===== Startup ===== | ||
| - | |||
| - | There are some configuration that must be perform before actually starting the two services. You need to briefly start and stop it to let it create the main configuration file, this is required because you need to generate a new API key: | ||
| - | <code bash> | ||
| - | > / | ||
| - | > / | ||
| - | > / | ||
| - | > / | ||
| - | </ | ||
| - | |||
| - | Now edit the newly created xml config files: | ||
| - | * / | ||
| - | * / | ||
| - | |||
| - | Only change the following lines in the Sonarr books file, do not edit anything else (unless you know what you are doing): | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | |||
| - | Only change the following lines in the Sonarr audiobooks file, do not edit anything else (unless you know what you are doing): | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | |||
| - | Please note in the audiobooks instance you ALSO need to edit the **Port** field to avoid collision with the books instance. | ||
| - | |||
| - | Add both Readars to default runlevel, for autostart on reboot, and start it manually now: | ||
| - | <code bash> | ||
| - | > rc-update add readarr default | ||
| - | > / | ||
| - | > rc-update add readarr-audiobooks default | ||
| - | > / | ||
| - | </ | ||
| - | |||
| - | Readarr will now be accessible as **http:// | ||
| - | |||
| - | All set! Both Readarr instances are running. | ||
| - | |||
| - | ===== Prowlarr link ===== | ||
| - | |||
| - | In order for Readarr to benefit from Prowlarr automatic indexers management you need to open **http:// | ||
| - | * Readarr-books server: http:// | ||
| - | * API Key: grab it from Readarr-books // | ||
| - | |||
| - | Now add a second Readarr (you will need to specify a different name, like Readarr-audiobooks): | ||
| - | * Readarr-audiobooks server: http:// | ||
| - | * API Key: grab it from Readarr-audiobooks // | ||
| - | |||
| - | Then go to the Prowlarr indexers page and click on the // | ||
| - | |||
| - | ===== Usage ===== | ||
| - | |||
| - | Before you can actually use Readarr you need to perform some initial setup in // | ||
| - | * Add a new Root Folder. Use **/ | ||
| - | |||
| - | Now, in each Readarr, enable " | ||
| - | * Thick "Set permissions" | ||
| - | * Set "chmod folder" | ||
| - | * set "chmod Group" to " | ||
| - | * save and restart the daemon (from the user icon on top-right corner) | ||
| - | |||
| - | you can fine tune and configure many other aspects of Readarr as you wish. A very common guide is [[https:// | ||
| - | |||
| - | Please note that you will not yet be able to use Readarr fully as you have not yet installed any downloader. | ||
| - | |||
| - | |||
| - | Now, head on to install the other services... | ||
| - | |||
| - | |||
| - | ---- | ||
| - | |||
| - | Next to: [[sailing: | ||
| - | |||
| - | Prev to: [[sailing: | ||