Add Lidarr to Autopirate

2025-12-13 17:56:26 +00:00 · 2018-09-19 21:54:20 +12:00
parent 745006567f
commit 59c31cd66d
16 changed files with 103 additions and 7 deletions
--- a/manuscript/CHANGELOG.md
+++ b/manuscript/CHANGELOG.md
@@ -20,6 +20,7 @@

 ## Recent improvements

+* [Autopirate](/recipies/autopirate/start/) uber-recipe updated for [Lidarr](/recipies/autopirate/lidarr/) (like Sonarr/Radarr for music, an alternative to Headphones)
 * [GitLab](/recipies/gitlab/) recipe updated with missing env variables, brought up to scratch with more recent design conventions (_14 Jun 2018_)
 * [SABnzbd](/recipies/autopirate/sabnzbd/) component of [autopirate](/recipies/autopirate/start/) recipe updated for new hostname validation check in recent version (_10 Jun 2018_)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/) component of [autopirate](/recipies/autopirate/start/) recipe updated to include calibre-server, so that downloaded ebooks can be automatically added to a calibre library, to then be independently managed using [Calibre-Web](/recipies/calibre-web/) (_27 May 2018_)
--- a/manuscript/images/lidarr.png
+++ b/manuscript/images/lidarr.png
--- a/manuscript/recipies/autopirate/headphones.md
+++ b/manuscript/recipies/autopirate/headphones.md
@@ -61,6 +61,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](https://github.com/evilhero/mylar)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * Headphones (this page)
+* [Lidarr](/recipies/autopirate/lidarr/)
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/jackett.md
+++ b/manuscript/recipies/autopirate/jackett.md
@@ -60,7 +60,8 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Radarr](/recipies/autopirate/radarr/)
 * [Mylar](/recipies/autopirate/mylarr/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
-* [Headphones](/recipies/autopirate/headphones/)
+* [Headphones](/recipies/autopirate/headphones)
+* [Lidarr](/recipies/autopirate/lidarr/)
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/lazylibrarian.md
+++ b/manuscript/recipies/autopirate/lazylibrarian.md
@@ -72,7 +72,8 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Radarr](/recipies/autopirate/radarr/)
 * [Mylar](https://github.com/evilhero/mylar)
 * Lazy Librarian (this page)
-* [Headphones](https://github.com/rembo10/headphones)
+* [Headphones](/recipies/autopirate/headphones)
+* [Lidarr](/recipies/autopirate/lidarr/)
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/lidarr.md
+++ b/manuscript/recipies/autopirate/lidarr.md
@@ -0,0 +1,82 @@
+hero: AutoPirate - A fully-featured recipe to automate finding, downloading, and organising your media 📺 🎥 🎵 📖
+
+!!! warning
+    This is not a complete recipe - it's a component of the [autopirate](/recipies/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
+
+# Lidarr
+
+[Lidarr](https://lidarr.audio/) is an automated music downloader for NZB and Torrent. It performs the same function as [Headphones](/recipies/autopirate/headphones), but is written using the same(ish) codebase as [Radarr](/recipies/autopirate/radarr/) and [Sonarr](/recipies/autopirate/sonarr). It's blazingly fast, and includes beautiful album/artist art. Lidarr supports [SABnzbd](/recipies/autopirate/sabnzbd/), [NZBGet](/recipies/autopirate/nzbget/), Transmission, µTorrent, Deluge and Blackhole (_just like Sonarr / Radarr_)
+
+![Lidarr Screenshot](../../images/lidarr.png)
+
+## Inclusion into AutoPirate
+
+To include Lidarr in your [AutoPirate](/recipies/autopirate/) stack, include the following in your autopirate.yml stack definition file:
+
+````
+lidarr:
+  image: linuxserver/lidarr:latest
+  env_file : /var/data/config/autopirate/lidarr.env
+  volumes:
+   - /var/data/autopirate/lidarr:/config
+   - /var/data/media:/media
+  networks:
+  - internal
+
+lidarr_proxy:
+  image: a5huynh/oauth2_proxy
+  env_file : /var/data/config/autopirate/lidarr.env
+  networks:
+    - internal
+    - traefik_public
+  deploy:
+    labels:
+      - traefik.frontend.rule=Host:lidarr.example.com
+      - traefik.docker.network=traefik_public
+      - traefik.port=4180
+  volumes:
+    - /var/data/config/autopirate/authenticated-emails.txt:/authenticated-emails.txt
+  command: |
+    -cookie-secure=false
+    -upstream=http://lidarr:8181
+    -redirect-url=https://lidarr.example.com
+    -http-address=http://0.0.0.0:4180
+    -email-domain=example.com
+    -provider=github
+    -authenticated-emails-file=/authenticated-emails.txt
+````
+
+!!! tip
+    I share (_with my [patreon patrons](https://www.patreon.com/funkypenguin)_) a private "_premix_" git repository, which includes necessary docker-compose and env files for all published recipes. This means that patrons can launch any recipe with just a ```git pull``` and a ```docker stack deploy``` 👍
+
+## Assemble more tools..
+
+Continue through the list of tools below, adding whichever tools your want to use, and finishing with the **[end](/recipies/autopirate/end/)** section:
+
+* [SABnzbd](/recipies/autopirate/sabnzbd.md)
+* [NZBGet](/recipies/autopirate/nzbget.md)
+* [RTorrent](/recipies/autopirate/rtorrent/)
+* [Sonarr](/recipies/autopirate/sonarr/)
+* [Radarr](/recipies/autopirate/radarr/)
+* [Mylar](https://github.com/evilhero/mylar)
+* [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
+* [Headphones](/recipies/autopirate/headphones/)
+* Lidarr (this page)
+* [NZBHydra](/recipies/autopirate/nzbhydra/)
+* [NZBHydra](/recipies/autopirate/nzbhydra/)
+* [NZBHydra2](/recipies/autopirate/nzbhydra2/)
+* [Ombi](/recipies/autopirate/ombi/)
+* [Jackett](/recipies/autopirate/jackett/)
+* [End](/recipies/autopirate/end/) (launch the stack)
+
+
+## Chef's Notes 📓
+
+1. In many cases, tools will integrate with each other. I.e., Radarr needs to talk to SABnzbd and NZBHydra, Ombi needs to talk to Radarr, etc. Since each tool runs within the stack under its own name, just refer to each tool by name (i.e. "radarr"), and docker swarm will resolve the name to the appropriate container. You can identify the tool-specific port by looking at the docker-compose service definition.
+2. The addition of the Lidarr recipe was contributed by our very own @gpulido in Discord (http://chat.funkypenguin.co.nz) - Thanks Gabriel!
+
+### Tip your waiter (donate) 👏
+
+Did you receive excellent service? Want to make your waiter happy? (_..and support development of current and future recipes!_) See the [support](/support/) page for (_free or paid)_ ways to say thank you! 👏
+
+### Your comments? 💬
--- a/manuscript/recipies/autopirate/mylar.md
+++ b/manuscript/recipies/autopirate/mylar.md
@@ -58,7 +58,8 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Radarr](/recipies/autopirate/radarr/)
 * Mylar (this page)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
-* [Headphones](/recipies/autopirate/headphones/)
+* [Headphones](/recipies/autopirate/headphones)
+* [Lidarr](/recipies/autopirate/lidarr/)
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/nzbget.md
+++ b/manuscript/recipies/autopirate/nzbget.md
@@ -65,7 +65,8 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Radarr](/recipies/autopirate/radarr/)
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
-* [Headphones](/recipies/autopirate/headphones/)
+* [Headphones](/recipies/autopirate/headphones)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/nzbhydra.md
+++ b/manuscript/recipies/autopirate/nzbhydra.md
@@ -65,6 +65,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * [Headphones](/recipies/autopirate/headphones/)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * NZBHydra (this page)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/nzbhydra2.md
+++ b/manuscript/recipies/autopirate/nzbhydra2.md
@@ -80,6 +80,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * [Headphones](/recipies/autopirate/headphones/)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * NZBHydra2 (this page)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/ombi.md
+++ b/manuscript/recipies/autopirate/ombi.md
@@ -66,6 +66,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * [Headphones](/recipies/autopirate/headphones/)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * Ombi (this page)
--- a/manuscript/recipies/autopirate/radarr.md
+++ b/manuscript/recipies/autopirate/radarr.md
@@ -77,6 +77,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * [Headphones](/recipies/autopirate/headphones/)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/rtorrent.md
+++ b/manuscript/recipies/autopirate/rtorrent.md
@@ -66,6 +66,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * [Headphones](/recipies/autopirate/headphones/)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/sabnzbd.md
+++ b/manuscript/recipies/autopirate/sabnzbd.md
@@ -73,6 +73,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * [Headphones](/recipies/autopirate/headphones/)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/manuscript/recipies/autopirate/sonarr.md
+++ b/manuscript/recipies/autopirate/sonarr.md
@@ -63,6 +63,7 @@ Continue through the list of tools below, adding whichever tools your want to us
 * [Mylar](/recipies/autopirate/mylar/)
 * [Lazy Librarian](/recipies/autopirate/lazylibrarian/)
 * [Headphones](/recipies/autopirate/headphones/)
+* [Lidarr](/recipies/autopirate/lidarr/) 
 * [NZBHydra](/recipies/autopirate/nzbhydra/)
 * [NZBHydra2](/recipies/autopirate/nzbhydra2/)
 * [Ombi](/recipies/autopirate/ombi/)
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -50,6 +50,7 @@ pages:
        - Mylar: recipies/autopirate/mylar.md
        - Lazy Librarian: recipies/autopirate/lazylibrarian.md
        - Headphones: recipies/autopirate/headphones.md
+        - Lidarr: recipies/autopirate/lidarr.md        
        - NZBHydra: recipies/autopirate/nzbhydra.md
        - NZBHydra 2: recipies/autopirate/nzbhydra2.md
        - Ombi: recipies/autopirate/ombi.md