Merge branch 'add-lidarr-and-readarr' into 'master'

Add lidarr and readarr

See merge request rogs/yams.media!3
This commit is contained in:
Roger Gonzalez 2023-01-31 17:20:44 +00:00
commit 909a8a9ef6
37 changed files with 240 additions and 1 deletions

116
content/advanced/lidarr.md Normal file
View File

@ -0,0 +1,116 @@
---
title: "Lidarr"
date: 2023-01-31T11:20:14-03:00
draft: false
weight: 5
summary: Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new albums from your favorite artists and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.
---
# What is Lidarr?
From their [wiki](https://lidarr.audio/):
> Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new albums from your favorite artists and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.
In YAMS, Lidarr is going to manage all our music: download, sort, etc.
## Initial configuration
In your browser, go to [http://{your-ip-address}:8686/]() and you'll see Lidarr's empty page. You'll also notice you have 3 messages on the system tab, but we'll deal with them later.
[![lidarr-1](/pics/lidarr-1.png)](/pics/lidarr-1.png)
### Media management
First, go to "Settings" and then "Media management". On this screen, click on the big sign.
[![lidarr-2](/pics/lidarr-2.png)](/pics/lidarr-2.png)
On the "Add root folder" modal, add the following information:
- On "Name", set it to "Music"
- On "Path", set it to "/music/"
Finally, click on "Save".
[![lidarr-3](/pics/lidarr-3.png)](/pics/lidarr-3.png)
You should see your new "Music" root folder.
[![lidarr-4](/pics/lidarr-4.png)](/pics/lidarr-4.png)
### Download Clients
Here, you'll add the download clients for Lidarr. That's where you'll tie in Lidarr with [qBittorrent](/config/qbittorrent).
In "Settings", go to "Download Clients" and click on the button.
[![lidarr-5](/pics/lidarr-5.png)](/pics/lidarr-5.png)
On the "Add Download Client" screen, scroll down and click on "qBittorrent".
[![lidarr-6](/pics/lidarr-6.png)](/pics/lidarr-6.png)
- In Name, add the name of your download client (qBittorrent).
- On Host, add your server IP address (in my case, `192.168.0.169`).
- On Username, add `admin`.
- On Password, add `adminadmin`.
[![lidarr-7](/pics/lidarr-7.png)](/pics/lidarr-7.png)
At the bottom, you can click on "Test" and if everything is OK you should see a ✅
[![radarr-10](/pics/radarr-10.png)](/pics/radarr-10.png)
[![radarr-11](/pics/radarr-11.png)](/pics/radarr-11.png)
If everything is fine, click on "Save". You should see your download client added to the "Download Clients" page now!
[![lidarr-8](/pics/lidarr-8.png)](/pics/lidarr-8.png)
### Prowlarr config
First, you are going to need your Lidarr API Key.
You can get your Lidarr API Key in Lidarr. Go to [http://{your-ip-address}:8686/settings/general]() to open Lidarr's settings, and you'll find the API Key under the "Security" section.
[![lidarr-11](/pics/lidarr-11.png)](/pics/lidarr-11.png)
For now, just copy it and keep it in a safe location.
In "Settings", go to "Apps" and click on the button.
[![lidarr-9](/pics/lidarr-9.png)](/pics/lidarr-9.png)
On the "Add Application" modal, click on "Lidarr"
[![lidarr-10](/pics/lidarr-10.png)](/pics/lidarr-10.png)
- In "Prowlarr Server", add `http://prowlarr:9696`
- In "Lidarr Server", add `http://lidarr:8686`
- In "ApiKey", add your Lidarr API key.
[![lidarr-12](/pics/lidarr-12.png)](/pics/lidarr-12.png)
At the bottom, you can click on "Test" and if everything is OK you should see a ✅
[![sonarr-10](/pics/sonarr-10.png)](/pics/sonarr-10.png)
[![sonarr-11](/pics/sonarr-11.png)](/pics/sonarr-11.png)
To finish, click on "Save". You should see Lidarr added to the "Apps" list!
[![lidarr-13](/pics/lidarr-13.png)](/pics/lidarr-13.png)
**Remeber to add Music indexers!**. You won't be able to download if you don't add Music indexers in Prowlarr. To add indexers, go to [Prowlarr's Indexer configuration](/config/prowlarr/#indexers).
## Usage
Back in Lidarr, go to "Library/Add New" and search for a band. Select it to add it to Lidarr.
[![lidarr-14](/pics/lidarr-14.png)](/pics/lidarr-14.png)
On the "Add new Artist" modal, select the Quality Profile, click on "Start search for missing albums" anf finally, click on "Add".
[![lidarr-15](/pics/lidarr-15.png)](/pics/lidarr-15.png)
And that should be it! You should see your band added and it will start downloading soon.
[![lidarr-16](/pics/lidarr-16.png)](/pics/lidarr-16.png)

116
content/advanced/readarr.md Normal file
View File

@ -0,0 +1,116 @@
---
title: "Readarr"
date: 2023-01-31T13:52:34-03:00
draft: false
weight: 6
summary: Readarr is a ebook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will interface with clients and indexers to grab, sort, and rename them.
---
# What is Readarr?
From their [wiki](https://readarr.com/):
> Readarr is a ebook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will interface with clients and indexers to grab, sort, and rename them.
In YAMS, Readarr is going to manage all our books: download, sort, etc.
## Initial configuration
In your browser, go to [http://{your-ip-address}:8787/]() and you'll see Readarr's empty page. You'll also notice you have 3 messages on the system tab, but we'll deal with them later.
[![readarr-1](/pics/readarr-1.png)](/pics/readarr-1.png)
### Media management
First, go to "Settings" and then "Media management". On this screen, click on the big sign.
[![readarr-2](/pics/readarr-2.png)](/pics/readarr-2.png)
On the "Add root folder" modal, add the following information:
- On "Name", set it to "Books"
- On "Path", set it to "/books/"
Finally, click on "Save".
[![readarr-3](/pics/readarr-3.png)](/pics/readarr-3.png)
You should see your new "Books" root folder.
[![readarr-4](/pics/readarr-4.png)](/pics/readarr-4.png)
### Download Clients
Here, you'll add the download clients for Readarr. That's where you'll tie in Readarr with [qBittorrent](/config/qbittorrent).
In "Settings", go to "Download Clients" and click on the button.
[![readarr-5](/pics/readarr-5.png)](/pics/readarr-5.png)
On the "Add Download Client" screen, scroll down and click on "qBittorrent".
[![readarr-6](/pics/readarr-6.png)](/pics/readarr-6.png)
- In Name, add the name of your download client (qBittorrent).
- On Host, add your server IP address (in my case, `192.168.0.169`).
- On Username, add `admin`.
- On Password, add `adminadmin`.
[![readarr-7](/pics/readarr-7.png)](/pics/readarr-7.png)
At the bottom, you can click on "Test" and if everything is OK you should see a ✅
[![radarr-10](/pics/radarr-10.png)](/pics/radarr-10.png)
[![radarr-11](/pics/radarr-11.png)](/pics/radarr-11.png)
If everything is fine, click on "Save". You should see your download client added to the "Download Clients" page now!
[![readarr-8](/pics/readarr-8.png)](/pics/readarr-8.png)
### Prowlarr config
First, you are going to need your Readarr API Key.
You can get your Readarr API Key in Readarr. Go to [http://{your-ip-address}:8787/settings/general]() to open Readarr's settings, and you'll find the API Key under the "Security" section.
[![readarr-9](/pics/readarr-9.png)](/pics/readarr-9.png)
For now, just copy it and keep it in a safe location.
In "Settings", go to "Apps" and click on the button.
[![readarr-10](/pics/readarr-10.png)](/pics/readarr-10.png)
On the "Add Application" modal, click on "Readarr"
[![readarr-11](/pics/readarr-11.png)](/pics/readarr-11.png)
- In "Prowlarr Server", add `http://prowlarr:9696`
- In "Readarr Server", add `http://readarr:8787`
- In "ApiKey", add your Readarr API key.
[![readarr-12](/pics/readarr-12.png)](/pics/readarr-12.png)
At the bottom, you can click on "Test" and if everything is OK you should see a ✅
[![sonarr-10](/pics/sonarr-10.png)](/pics/sonarr-10.png)
[![sonarr-11](/pics/sonarr-11.png)](/pics/sonarr-11.png)
To finish, click on "Save". You should see Readarr added to the "Apps" list!
[![readarr-13](/pics/readarr-13.png)](/pics/readarr-13.png)
**Remeber to add Books indexers!**. You won't be able to download if you don't add Books indexers in Prowlarr. To add indexers, go to [Prowlarr's Indexer configuration](/config/prowlarr/#indexers).
## Usage
Back in Readarr, go to "Library/Add New" and search for an author. Select it to add it to Readarr.
[![readarr-14](/pics/readarr-14.png)](/pics/readarr-14.png)
On the "Add new Author" modal, click on "Start search for missing books" anf finally, click on "Add".
[![readarr-15](/pics/readarr-15.png)](/pics/readarr-15.png)
And that should be it! You should see your author added and it will start downloading soon.
[![readarr-16](/pics/readarr-16.png)](/pics/readarr-16.png)

View File

@ -18,8 +18,10 @@ Second, I would prefer you donate to any of the projects used in this script. Th
- [Plex pass page](https://www.plex.tv/plex-pass/).
- [qBittorrent donations page](https://www.qbittorrent.org/donate).
- [Bazarr donations page](https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=XHHRWXT9YB7WE&source=url).
- [Prowlarr donations page](https://opencollective.com/Prowlarr#sponsor)
- [Prowlarr donations page](https://prowlarr.com/donate)
- [gluetun donations page](https://www.paypal.me/qmcgaw).
- [Lidarr donations page](https://lidarr.audio/donate).
- [Readarr donations page](https://readarr.com/donate).
Just let them know YAMS sent you there 😎
@ -43,6 +45,8 @@ I'm not doing this for the money, and thank God I don't need donations to keep t
- [Prowlarr](https://github.com/Prowlarr/Prowlarr)
- [gluetun](https://github.com/qdm12/gluetun).
- [Portainer](https://www.portainer.io/).
- [Lidarr](https://lidarr.audio/).
- [Readarr](https://readarr.com/).
- [The entire /r/selfhosted subreddit](https://www.reddit.com/r/selfhosted/).
- My friends:
+ [xploshioOn](https://github.com/xploshioOn).

View File

@ -42,6 +42,8 @@ In no particular order:
- [Plex](https://www.plex.tv/).
- [gluetun](https://github.com/qdm12/gluetun).
- [Portainer](https://www.portainer.io/).
- [Lidarr](https://lidarr.audio/).
- [Readarr](https://readarr.com/).
With this combination, you can create a fully functional media server that is going to download, categorize, subtitle, and serve your favorite shows and movies.

View File

@ -215,6 +215,7 @@ Sonarr: http://192.168.0.169:8989/
Bazarr: http://192.168.0.169:6767/
Emby: http://192.168.0.169:8096/
Portainer: http://192.168.0.169:9000/
Lidarr: http://192.168.0.169:8686/
You might need to wait for a couple of minutes while everything gets up and running

BIN
static/pics/lidarr-1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

BIN
static/pics/lidarr-10.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

BIN
static/pics/lidarr-11.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
static/pics/lidarr-12.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

BIN
static/pics/lidarr-13.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

BIN
static/pics/lidarr-14.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 219 KiB

BIN
static/pics/lidarr-15.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 254 KiB

BIN
static/pics/lidarr-16.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

BIN
static/pics/lidarr-2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

BIN
static/pics/lidarr-3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

BIN
static/pics/lidarr-4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

BIN
static/pics/lidarr-5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
static/pics/lidarr-6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

BIN
static/pics/lidarr-7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

BIN
static/pics/lidarr-8.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
static/pics/lidarr-9.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

BIN
static/pics/readarr-1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

BIN
static/pics/readarr-10.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
static/pics/readarr-11.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
static/pics/readarr-12.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

BIN
static/pics/readarr-13.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
static/pics/readarr-14.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 132 KiB

BIN
static/pics/readarr-15.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

BIN
static/pics/readarr-16.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

BIN
static/pics/readarr-2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

BIN
static/pics/readarr-3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

BIN
static/pics/readarr-4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

BIN
static/pics/readarr-5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

BIN
static/pics/readarr-6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

BIN
static/pics/readarr-7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
static/pics/readarr-8.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

BIN
static/pics/readarr-9.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB