mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-13 01:36:23 +00:00
Add readarr to autopirate
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
David Young
3
.github/pull_request_template.md
vendored
3
.github/pull_request_template.md
vendored
@@ -28,9 +28,10 @@
|
||||
<!--
|
||||
delete these next checks if not adding a new recipe
|
||||
-->
|
||||
- [ ] I've updated `common_links.md` in the `_snippets` directory and sorted alphabetically
|
||||
- [ ] I've updated the navigation in `mkdocs.yaml` in alphabetical order
|
||||
- [ ] I've updated `CHANGELOG.md` in reverse chronological order order
|
||||
- [ ] I'm using the [oldest-possible version](https://docs.docker.com/compose/compose-file/compose-versioning/#version-3) of Docker-compose syntax for the feature my recipe needs
|
||||
- [ ] I'm using the [oldest-possible version](https://docs.docker.com/compose/compose-file/compose-versioning/#version-3) of Docker-compose syntax for the feature my recipe needs (*v3.2 unless there's a specific need for a later version*)
|
||||
- [ ] If traefik integration is required, I've included both v1 and v2 labels (*see [template](/manuscript/recipes/template.md)*)
|
||||
- [ ] If a recipe-specific overlay network is required, I've used a unique subnet and recorded it in [networks.md](manuscript/reference/networks.md)
|
||||
- [ ] I've considered updating `.github/CODEOWNERS` so that I'll be automatically included as a reviewer on future changes to this recipe
|
||||
@@ -2,10 +2,7 @@
|
||||
"MD046": {
|
||||
"style": "fenced"
|
||||
},
|
||||
"MD013": {
|
||||
"code_block_line_length": 200,
|
||||
"line_length": 200
|
||||
},
|
||||
"MD013": false,
|
||||
"MD024": {
|
||||
"siblings_only": true
|
||||
}
|
||||
|
||||
@@ -1,18 +1,21 @@
|
||||
[autopirate]: /recipes/autopirate/
|
||||
[bazarr]: /recipes/autopirate/bazarr/
|
||||
[calibre-web]: /recipes/calibre-web/
|
||||
[cyberchef]: /recipes/cyberchef/
|
||||
[emby]: /recipes/emby/
|
||||
[funkwhale]: /recipes/autopirate/funkwhale/
|
||||
[github_sponsor]: https://github.com/sponsors/funkypenguin
|
||||
[headphones]: /recipes/autopirate/headphones/
|
||||
[jackett]: /recipes/autopirate/jackett/
|
||||
[jellyfin]: /recipes/jellyfin/
|
||||
[keycloak]: /recipes/keycloak/
|
||||
[komga]: /recipes/komga/
|
||||
[lazylibrarian]: /recipes/autopirate/lazylibrarian/
|
||||
[lidarr]: /recipes/autopirate/lidarr/
|
||||
[linx]: /recipes/linx/
|
||||
[mealie]: /recipes/mealie/
|
||||
[mylar]: /recipes/autopirate/mylar/
|
||||
[miniflux]: /recipes/miniflux/
|
||||
[mylar]: /recipes/autopirate/mylar/
|
||||
[nightscout]: /recipes/nightscout/
|
||||
[nzbget]: /recipes/autopirate/nzbget/
|
||||
[nzbhydra]: /recipes/autopirate/nzbhydra/
|
||||
@@ -21,10 +24,12 @@
|
||||
[oscarr]: /recipes/autopirate/oscarr/
|
||||
[patreon]: https://www.patreon.com/bePatron?u=6982506
|
||||
[photoprism]: /recipes/photoprism/
|
||||
[plex]: /recipes/plex/
|
||||
[portainer]: /recipes/portainer/
|
||||
[radarr]: /recipes/autopirate/radarr/
|
||||
[rtorrent]: /recipes/autopirate/rtorrent/
|
||||
[readarr]: /recipes/autopirate/readarr/
|
||||
[rss-bridge]: /recipes/rss-bridge/
|
||||
[rtorrent]: /recipes/autopirate/rtorrent/
|
||||
[sabnzbd]: /recipes/autopirate/sabnzbd/
|
||||
[sonarr]: /recipes/autopirate/sonarr/
|
||||
[tfa-dex-static]: /ha-docker-swarm/traefik-forward-auth/dex-static/
|
||||
|
||||
@@ -12,6 +12,7 @@ Continue through the list of tools below, adding whichever tools your want to us
|
||||
* [NZBHydra](/recipes/autopirate/nzbhydra/)
|
||||
* [Ombi](/recipes/autopirate/ombi/)
|
||||
* [Radarr](/recipes/autopirate/radarr/)
|
||||
* [Readarr](/recipes/autopirate/readarr/)
|
||||
* [RTorrent](/recipes/autopirate/rtorrent/)
|
||||
* [SABnzbd](/recipes/autopirate/sabnzbd/)
|
||||
* [Sonarr](/recipes/autopirate/sonarr/)
|
||||
|
||||
BIN
manuscript/images/readarr.png
Normal file
BIN
manuscript/images/readarr.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 188 KiB |
@@ -1,9 +1,11 @@
|
||||
---
|
||||
description: Headphones 🎧 is an automated music downloader for NZB and BitTorrent
|
||||
---
|
||||
# Headphones
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
# Headphones
|
||||
|
||||
[Headphones](https://github.com/rembo10/headphones) is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent, Deluge and Blackhole.
|
||||
[Headphones](https://github.com/rembo10/headphones) is an automated music downloader for NZB and Torrent, written in Python. It supports [SABnzbd][sabnzbd], [NZBget][nzbget], Transmission, µTorrent, Deluge and Blackhole.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
---
|
||||
description: Heimdall is a beautiful dashboard for all your web applications
|
||||
---
|
||||
# Heimdall
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
# Heimdall
|
||||
|
||||
[Heimdall Application Dashboard](https://heimdall.site/) is a dashboard for all your web applications. It doesn't need to be limited to applications though, you can add links to anything you like.
|
||||
|
||||
Heimdall is an elegant solution to organise all your web applications. It’s dedicated to this purpose so you won’t lose your links in a sea of bookmarks.
|
||||
|
||||
Heimdall provides a single URL to manage access to all of your autopirate tools, and includes "enhanced" (_i.e., display stats within Heimdall without launching the app_) access to [NZBGet](/recipes/autopirate/nzbget.md), [SABnzbd](/recipes/autopirate/sabnzbd/), and friends.
|
||||
Heimdall provides a single URL to manage access to all of your autopirate tools, and includes "enhanced" (_i.e., display stats within Heimdall without launching the app_) access to [NZBGet][nzbge], [SABnzbd][nzbget], and friends.
|
||||
|
||||
|
||||
|
||||
|
||||
128
manuscript/recipes/autopirate/index.md
Normal file
128
manuscript/recipes/autopirate/index.md
Normal file
@@ -0,0 +1,128 @@
|
||||
hero: AutoPirate - A fully-featured recipe to automate finding, downloading, and organising your media 📺 🎥 🎵 📖
|
||||
|
||||
# AutoPirate
|
||||
|
||||
Once the cutting edge of the "internet" (_pre-world-wide-web and mosiac days_), Usenet is now a murky, geeky alternative to torrents for file-sharing. However, it's **cool** geeky, especially if you're into having a fully automated media platform.
|
||||
|
||||
A good starter for the usenet scene is https://www.reddit.com/r/usenet/. Because it's so damn complicated, a host of automated tools exist to automate the process of finding, downloading, and managing content. The tools included in this recipe are as follows:
|
||||
|
||||
|
||||
|
||||
This recipe presents a method to combine these tools into a single swarm deployment, and make them available securely.
|
||||
|
||||
## Menu
|
||||
|
||||
Tools included in the AutoPirate stack are:
|
||||
|
||||
* [SABnzbd][sabnzbd] is the workhorse. It takes `.nzb` files as input (_manually or from [Sonarr](/recipes/autopirate/sonarr/), [Radarr](/recipes/autopirate/radarr/), etc_), then connects to your chosen Usenet provider, downloads all the individual binaries referenced by the .nzb, and then tests/repairs/combines/uncompresses them all into the final result - media files, to be consumed by [Plex](/recipes/plex), [Emby](/recipes/emby/), [Komga](/recipes/komga/), [Calibre-Web](/recipes/calibre-web/), etc.
|
||||
|
||||
* [NZBGet][nzbget] downloads data from usenet servers based on .nzb definitions. Like [SABnzbd][sabnzbd], but written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources (_this is a popular alternative to SABnzbd_)
|
||||
|
||||
* [RTorrent][rtorrent] is a popular CLI-based bittorrent client, and [ruTorrent](https://github.com/Novik/ruTorrent) is a powerful web interface for rtorrent. (_Yes, it's not Usenet, but Sonarr/Radarr will let fulfill your watchlist using either Usenet **or** torrents, so it's worth including_)
|
||||
|
||||
* [NZBHydra][nzbhydra] is a meta search for NZB indexers. It provides easy access to a number of raw and newznab based indexers. You can search all your indexers from one place and use it as indexer source for tools like [Sonarr][sonarr] or [Radarr][radarr].
|
||||
|
||||
* [Sonarr][sonarr] finds, downloads and manages TV shows
|
||||
|
||||
* [Radarr][radarr] finds, downloads and manages movies
|
||||
|
||||
* [Readarr][readarr] finds, downloads, and manages eBooks
|
||||
|
||||
* [Lidarr][lidarr] is an automated music downloader for NZB and Torrent. It performs the same function as [Headphones][headphones], but is written using the same(ish) codebase as [Radarr][radarr] and [Sonarr](/recipes/autopirate/sonarr). It's blazingly fast, and includes beautiful album/artist art. Lidarr supports [SABnzbd](/recipes/autopirate/sabnzbd/), [NZBGet](/recipes/autopirate/nzbget/), Transmission, µTorrent, Deluge and Blackhole (_just like Sonarr / Radarr_)
|
||||
|
||||
* [Mylar][mylar] is a tool for downloading and managing digital comic books / "graphic novels"
|
||||
|
||||
* [Headphones][headphones] is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent, Deluge and Blackhole.
|
||||
|
||||
* [Lazy Librarian][lazylibrarian] is a tool to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info.
|
||||
|
||||
* [Ombi][ombi] provides an interface to request additions to a [Plex][plex]/[Emby][emby]/[Jellyfin][jellyfin] library using the above tools
|
||||
|
||||
* [Jackett][jackett] works as a proxy server: it translates queries from apps (*[Sonarr][sonarr], [Radarr][radarr], [Mylar][mylar], etc*) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software.
|
||||
|
||||
Since this recipe is so long, and so many of the tools are optional to the final result (_i.e., if you're not interested in comics, you won't want Mylar_), I've described each individual tool on its own sub-recipe page (_below_), even though most of them are deployed very similarly.
|
||||
|
||||
|
||||
## Ingredients
|
||||
|
||||
!!! summary "Ingredients"
|
||||
Already deployed:
|
||||
|
||||
* [X] [Docker swarm cluster](/ha-docker-swarm/design/) with [persistent shared storage](/ha-docker-swarm/shared-storage-ceph.md)
|
||||
* [X] [Traefik](/ha-docker-swarm/traefik) configured per design
|
||||
* [X] DNS entry for the hostname you intend to use (*or a wildcard*), pointed to your [keepalived](/ha-docker-swarm/keepalived/) IP
|
||||
|
||||
Related:
|
||||
|
||||
* [X] [Traefik Forward Auth](ha-docker-swarm/traefik-forward-auth/) to secure your Traefik-exposed services with an additional layer of authentication
|
||||
|
||||
## Preparation
|
||||
|
||||
### Setup data locations
|
||||
|
||||
We'll need a unique directories for each tool in the stack, bind-mounted into our containers, so create them upfront, in /var/data/autopirate:
|
||||
|
||||
```bash
|
||||
mkdir /var/data/autopirate
|
||||
cd /var/data/autopirate
|
||||
mkdir -p {lazylibrarian,mylar,ombi,sonarr,radarr,headphones,plexpy,nzbhydra,sabnzbd,nzbget,rtorrent,jackett}
|
||||
```
|
||||
|
||||
Create a directory for the storage of your downloaded media, i.e., something like:
|
||||
|
||||
```bash
|
||||
mkdir /var/data/media
|
||||
```
|
||||
|
||||
Create a user to "own" the above directories, and note the uid and gid of the created user. You'll need to specify the UID/GID in the environment variables passed to the container (in the example below, I used 4242 - twice the meaning of life).
|
||||
|
||||
### Secure public access
|
||||
|
||||
What you'll quickly notice about this recipe is that __every__ web interface is protected by an [OAuth proxy](/reference/oauth_proxy/).
|
||||
|
||||
Why? Because these tools are developed by a handful of volunteer developers who are focused on adding features, not necessarily implementing robust security. Most users wouldn't expose these tools directly to the internet, so the tools have rudimentary (if any) access control.
|
||||
|
||||
To mitigate the risk associated with public exposure of these tools (_you're on your smartphone and you want to add a movie to your watchlist, what do you do, hotshot?_), in order to gain access to each tool you'll first need to authenticate against your given OAuth provider.
|
||||
|
||||
This is tedious, but you only have to do it once. Each tool (Sonarr, Radarr, etc) to be protected by an OAuth proxy, requires unique configuration. I use github to provide my oauth, giving each tool a unique logo while I'm at it (make up your own random string for OAUTH2PROXYCOOKIE_SECRET)
|
||||
|
||||
For each tool, create /var/data/autopirate/<tool>.env, and set the following:
|
||||
|
||||
```
|
||||
OAUTH2_PROXY_CLIENT_ID=
|
||||
OAUTH2_PROXY_CLIENT_SECRET=
|
||||
OAUTH2_PROXY_COOKIE_SECRET=
|
||||
PUID=4242
|
||||
PGID=4242
|
||||
```
|
||||
|
||||
Create at least /var/data/autopirate/authenticated-emails.txt, containing at least your own email address with your OAuth provider. If you wanted to grant access to a specific tool to other users, you'd need a unique authenticated-emails-<tool>.txt which included both normal email address as well as any addresses to be granted tool-specific access.
|
||||
|
||||
### Setup components
|
||||
|
||||
#### Stack basics
|
||||
|
||||
**Start** with a swarm config file in docker-compose syntax, like this:
|
||||
|
||||
````
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
````
|
||||
|
||||
And **end** with a stanza like this:
|
||||
|
||||
````
|
||||
networks:
|
||||
traefik_public:
|
||||
external: true
|
||||
internal:
|
||||
driver: overlay
|
||||
ipam:
|
||||
config:
|
||||
- subnet: 172.16.11.0/24
|
||||
````
|
||||
|
||||
--8<-- "reference-networks.md"
|
||||
--8<-- "recipe-autopirate-toc.md"
|
||||
--8<-- "recipe-footer.md"
|
||||
@@ -1,9 +1,12 @@
|
||||
---
|
||||
description: Jackett 🧥 works as a proxy server, standardizing your apps' access to torrent indexers
|
||||
---
|
||||
# Jackett
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
# Jackett
|
||||
|
||||
[Jackett](https://github.com/Jackett/Jackett) works as a proxy server: it translates queries from apps (*[Sonarr][sonarr], [Radarr][radarr], [Mylar][mylarr], etc*) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software.
|
||||
[Jackett](https://github.com/Jackett/Jackett) works as a proxy server: it translates queries from apps (*[Sonarr][sonarr], [Radarr][radarr], [Mylar][mylar], etc*) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software.
|
||||
|
||||
This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.
|
||||
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: LazyLibrarian 📚 is a tool to follow authors and grab metadata for all your digital reading needs.
|
||||
---
|
||||
|
||||
# LazyLibrarian
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[LazyLibrarian](https://github.com/DobyTang/LazyLibrarian) is a tool to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. Features include:
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
hero: AutoPirate - A fully-featured recipe to automate finding, downloading, and organising your media 📺 🎥 🎵 📖
|
||||
|
||||
---
|
||||
description: Lidarr 🎵 is an automated music downloader for NZB and Torrent
|
||||
---
|
||||
# Lidarr
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/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](/recipes/autopirate/headphones), but is written using the same(ish) codebase as [Radarr](/recipes/autopirate/radarr/) and [Sonarr](/recipes/autopirate/sonarr). It's blazingly fast, and includes beautiful album/artist art. Lidarr supports [SABnzbd](/recipes/autopirate/sabnzbd/), [NZBGet](/recipes/autopirate/nzbget/), Transmission, µTorrent, Deluge and Blackhole (_just like Sonarr / Radarr_)
|
||||
[Lidarr](https://lidarr.audio/) is an automated music downloader for NZB and Torrent. It performs the same function as [Headphones](/recipes/autopirate/headphones), but is written using the same(ish) codebase as [Radarr][radarr] and [Sonarr][sonarr]. It's blazingly fast, and includes beautiful album/artist art. Lidarr supports [SABnzbd][sabnzbd], [NZBGet][nzbget], Transmission, µTorrent, Deluge and Blackhole (_just like Sonarr / Radarr_)
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: Mylar 🦹♀️ is a tool for downloading and managing digital comic books.
|
||||
---
|
||||
|
||||
# Mylar
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [autopirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[Mylar](https://github.com/mylar3/mylar3) is a tool for downloading and managing digital comic books.
|
||||
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: NZBGet 💾 is a tool for downloading "content" from Usenet providers
|
||||
---
|
||||
|
||||
# NZBGet
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
## Introduction
|
||||
|
||||
NZBGet performs the same function as [SABnzbd][sabnzbd] (_downloading content from Usenet servers_), but it's lightweight and fast(er), written in C++ (_as opposed to Python_).
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: NZBHydra 🐍 is a meta search engine for NZB indexers
|
||||
---
|
||||
|
||||
# NZBHydra 2
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[NZBHydra 2](https://github.com/theotherp/nzbhydra2) is a meta search for NZB indexers. It provides easy access to a number of raw and newznab based indexers. You can search all your indexers from one place and use it as an indexer source for tools like Sonarr, Radarr or CouchPotato.
|
||||
|
||||
|
||||
|
||||
@@ -1,17 +1,21 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: Ombi is like your media butler 🍽 - it recommends, finds what you want to watch!
|
||||
---
|
||||
|
||||
# Ombi
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[Ombi](https://github.com/tidusjar/Ombi) is a useful addition to the [autopirate][autopirate]stack. Features include:
|
||||
|
||||
* Lets users request Movies and TV Shows (_whether it being the entire series, an entire season, or even single episodes._)
|
||||
* Easily manage your requests
|
||||
User management system (_supports plex.tv, Emby and local accounts_)
|
||||
* A landing page that will give you the availability of your Plex/Emby/Jellyfin server and also add custom notification text to inform your users of downtime.
|
||||
* A landing page that will give you the availability of your [Plex][plex]/[Emby][emby]/[Jellyfin][jellyfin] server and also add custom notification text to inform your users of downtime.
|
||||
* Allows your users to get custom notifications!
|
||||
* Will show if the request is already on plex or even if it's already monitored.
|
||||
Automatically updates the status of requests when they are available on Plex/Emby/Jellyfin
|
||||
* Automatically updates the status of requests when they are available on Plex/Emby/Jellyfin
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: Radarr 🎬 is a tool for finding, downloading and managing movies
|
||||
---
|
||||
|
||||
# Radarr
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[Radarr](https://radarr.video/) is a tool for finding, downloading and managing movies. Features include:
|
||||
|
||||
|
||||
62
manuscript/recipes/autopirate/readarr.md
Normal file
62
manuscript/recipes/autopirate/readarr.md
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
description: Readarr 📚 is "Sonarr/Radarr for eBooks"
|
||||
---
|
||||
|
||||
|
||||
# Readarr
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[Readarr](https://github.com/Readarr/Readarr), in the fine tradition of [Radarr][radarr] and [Sonarr][sonarr], is a tool for "sourcing" eBooks, using usenet or bittorrent indexers.
|
||||
|
||||
|
||||
|
||||
Features include:
|
||||
|
||||
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
|
||||
* Automatically detects new books
|
||||
* Can scan your existing library and download any missing books
|
||||
* Automatic failed download handling will try another release if one fails
|
||||
* Manual search so you can pick any release or to see why a release was not downloaded automatically
|
||||
* Fully configurable book renaming
|
||||
* Full integration with [SABnzbd][sabnzbd] and [NZBGet][sabnzbd]
|
||||
* Full integration with [Calibre][calibre-web] (add to library, conversion)
|
||||
* And a beautiful UI!
|
||||
|
||||
|
||||
## Inclusion into AutoPirate
|
||||
|
||||
To include Readarr in your [AutoPirate][autopirate] stack, include something like the following in your autopirate.yml stack definition file:
|
||||
|
||||
```yaml
|
||||
radarr:
|
||||
image: linuxserver/readarr:latest
|
||||
env_file : /var/data/config/autopirate/readarr.env
|
||||
volumes:
|
||||
- /var/data/autopirate/readarr:/config
|
||||
- /var/data/media/books:/books
|
||||
networks:
|
||||
- internal
|
||||
deploy:
|
||||
labels:
|
||||
# traefik
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network=traefik_public
|
||||
|
||||
# traefikv1
|
||||
- traefik.frontend.rule=Host:readarr.example.com
|
||||
- traefik.port=8787
|
||||
- traefik.frontend.auth.forward.address=http://traefik-forward-auth:4181
|
||||
- traefik.frontend.auth.forward.authResponseHeaders=X-Forwarded-User
|
||||
- traefik.frontend.auth.forward.trustForwardHeader=true
|
||||
|
||||
# traefikv2
|
||||
- "traefik.http.routers.readarr.rule=Host(`readarr.example.com`)"
|
||||
- "traefik.http.routers.readarr.entrypoints=https"
|
||||
- "traefik.http.services.readarr.loadbalancer.server.port=8787"
|
||||
- "traefik.http.routers.readarr.middlewares=forward-auth"
|
||||
```
|
||||
|
||||
--8<-- "premix-cta.md"
|
||||
--8<-- "recipe-autopirate-toc.md"
|
||||
--8<-- "recipe-footer.md"
|
||||
@@ -1,8 +1,12 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: A popular tool for managing BitTorrent 💾 downloads
|
||||
---
|
||||
|
||||
# RTorrent / ruTorrent
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[RTorrent](http://rakshasa.github.io/rtorrent) is a popular CLI-based bittorrent client, and [ruTorrent](https://github.com/Novik/ruTorrent) is a powerful web interface for rtorrent.
|
||||
|
||||
|
||||
|
||||
@@ -1,11 +1,15 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
---
|
||||
description: SABnzbd 💾 downloads and assembles your usenet content
|
||||
---
|
||||
|
||||
# SABnzbd
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
## Introduction
|
||||
|
||||
SABnzbd is the workhorse of the stack. It takes .nzb files as input (_manually or from other [autopirate](/recipes/autopirate/) stack tools_), then connects to your chosen Usenet provider, downloads all the individual binaries referenced by the .nzb, and then tests/repairs/combines/uncompresses them all into the final result - media files.
|
||||
SABnzbd is a workhorse of the stack. It takes .nzb files as input (_manually or from other [autopirate](/recipes/autopirate/) stack tools_), then connects to your chosen Usenet provider, downloads all the individual binaries referenced by the .nzb, and then tests/repairs/combines/uncompresses them all into the final result - media files.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,9 +1,12 @@
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
---
|
||||
description: Sonarr 📺 is a tool for finding, downloading and managing TV series
|
||||
---
|
||||
|
||||
# Sonarr
|
||||
|
||||
!!! warning
|
||||
This is not a complete recipe - it's a component of the [AutoPirate](/recipes/autopirate/) "_uber-recipe_", but has been split into its own page to reduce complexity.
|
||||
|
||||
[Sonarr](https://sonarr.tv/) is a tool for finding, downloading and managing your TV series.
|
||||
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
description: Neat 😘 one-sentence description of recipe for social media previews
|
||||
---
|
||||
|
||||
# <///RECIPE NAME>
|
||||
|
||||
Ever wanted to quickly share a screenshot, but don't want to use imgur, sign up for a service, or have your image tracked across the internet for all time?
|
||||
|
||||
Want to privately share some log output with a password, or a self-destructing cat picture?
|
||||
|
||||
|
||||
|
||||
[Linx](https://github.com/andreimarcu/linx-server) is self-hosted file/media-sharing service, which features:
|
||||
@@ -22,7 +22,7 @@ Want to privately share some log output with a password, or a self-destructing c
|
||||
|
||||
First we create a directory to hold the data which linx will serve:
|
||||
|
||||
```
|
||||
```bash
|
||||
mkdir /var/data/linx
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ mkdir /var/data/linx
|
||||
|
||||
Linx is configured using a flat text file, so create this on the Docker host, and then we'll mount it (*read-only*) into the container, below.
|
||||
|
||||
```
|
||||
```bash
|
||||
mkdir /var/data/config/linx
|
||||
cat << EOF > /var/data/config/linx/linx.conf
|
||||
# Refer to https://github.com/andreimarcu/linx-server for details
|
||||
|
||||
27
mkdocs.yml
27
mkdocs.yml
@@ -54,20 +54,22 @@ nav:
|
||||
- Duplicity: recipes/duplicity.md
|
||||
- Chef's Favorites:
|
||||
- Auto Pirate:
|
||||
- Start: recipes/autopirate.md
|
||||
- SABnzbd: recipes/autopirate/sabnzbd.md
|
||||
- NZBGet: recipes/autopirate/nzbget.md
|
||||
- Rtorrent: recipes/autopirate/rtorrent.md
|
||||
- Sonarr: recipes/autopirate/sonarr.md
|
||||
- Radarr: recipes/autopirate/radarr.md
|
||||
- Mylar: recipes/autopirate/mylar.md
|
||||
- Lazy Librarian: recipes/autopirate/lazylibrarian.md
|
||||
- recipes/autopirate/index.md
|
||||
# - Start: recipes/autopirate.md
|
||||
- Headphones: recipes/autopirate/headphones.md
|
||||
- Heimdall: recipes/autopirate/heimdall.md
|
||||
- Jackett: recipes/autopirate/jackett.md
|
||||
- Lazy Librarian: recipes/autopirate/lazylibrarian.md
|
||||
- Lidarr: recipes/autopirate/lidarr.md
|
||||
- Mylar: recipes/autopirate/mylar.md
|
||||
- NZBGet: recipes/autopirate/nzbget.md
|
||||
- NZBHydra: recipes/autopirate/nzbhydra.md
|
||||
- Ombi: recipes/autopirate/ombi.md
|
||||
- Jackett: recipes/autopirate/jackett.md
|
||||
- Heimdall: recipes/autopirate/heimdall.md
|
||||
- Radarr: recipes/autopirate/radarr.md
|
||||
- Readarr: recipes/autopirate/readarr.md
|
||||
- Rtorrent: recipes/autopirate/rtorrent.md
|
||||
- SABnzbd: recipes/autopirate/sabnzbd.md
|
||||
- Sonarr: recipes/autopirate/sonarr.md
|
||||
- End: recipes/autopirate/end.md
|
||||
- Emby: recipes/emby.md
|
||||
- Home Assistant:
|
||||
@@ -189,9 +191,12 @@ theme:
|
||||
favicon: 'images/site-logo.svg'
|
||||
features:
|
||||
- navigation.tabs
|
||||
- navigation.instant
|
||||
- navigation.tabs.sticky
|
||||
- navigation.instant
|
||||
- navigation.sections
|
||||
- navigation.tracking
|
||||
- navigation.indexes
|
||||
- navigation.top
|
||||
- search.suggest
|
||||
- search.highlight
|
||||
- search.share
|
||||
|
||||
Reference in New Issue
Block a user