public/geek-cookbook
1
0
Fork 0
mirror of https://github.com/funkypenguin/geek-cookbook/ synced 2025-12-13 17:56:26 +00:00
Code Issues Releases Wiki Activity

Update titles

Browse Source 
Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
David Young
2022-07-05 17:04:06 +12:00
parent eb3f12c5a4
commit d1bdbf5e88
21 changed files with 84 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
manuscript/recipes/autopirate/headphones.md
View File

@@ -1,6 +1,3 @@
---
description: Headphones is an automated music downloader for NZB and BitTorrent
---
# Headphones # Headphones
!!! warning !!! warning

7
manuscript/recipes/autopirate/jackett.md
View File

@@ -1,7 +1,8 @@
--- ---
description: Jackett works as a proxy server, standardizing your apps' access to torrent indexers title: How to setup Jackett in Docker alongside Sonarr / Radarr
description: Jackett works as a proxy server, standardizing your apps' (Radarr / Sonarr specifically) access to torrent indexers, and is a useful addition to the Autopirate Docker Swarm stack
--- ---
# Jackett # Jackett in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -14,7 +15,7 @@ This allows for getting recent uploads (like RSS) and performing searches. Jacke
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Jackett in your [AutoPirate](/recipes/autopirate/) stack, include the following in your autopirate.yml stack definition file: To include Jackett in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
```yaml ```yaml
jackett: jackett:

7
manuscript/recipes/autopirate/lazylibrarian.md
View File

@@ -1,8 +1,9 @@
--- ---
description: LazyLibrarian is a tool to follow authors and grab metadata for all your digital reading needs. title: How to install Lazy Librarian in Docker
description: LazyLibrarian is a tool to follow authors and manage your ebook / audiobook collection. It's a handy addition to the Autopirate Docker Swarm stack!
--- ---
# LazyLibrarian # LazyLibrarian in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -19,7 +20,7 @@ description: LazyLibrarian is a tool to follow authors and grab metadata for all
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include LazyLibrarian in your [AutoPirate][autopirate] stack, include the following in your autopirate.yml stack definition file: To include LazyLibrarian in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
```yaml ```yaml
lazylibrarian: lazylibrarian:

14
manuscript/recipes/autopirate/lidarr.md
View File

@@ -1,7 +1,8 @@
--- ---
title: How to install Lidarr (Music arr tool) in Docker
description: Lidarr is an automated music downloader for NZB and Torrent description: Lidarr is an automated music downloader for NZB and Torrent
--- ---
# Lidarr # Lidarr in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -12,7 +13,7 @@ description: Lidarr is an automated music downloader for NZB and Torrent
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Lidarr in your [AutoPirate](/recipes/autopirate/) stack, include the following in your autopirate.yml stack definition file: To include Lidarr in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
````yaml ````yaml
lidarr: lidarr:
@@ -45,4 +46,13 @@ To include Lidarr in your [AutoPirate](/recipes/autopirate/) stack, include the
--8<-- "premix-cta.md" --8<-- "premix-cta.md"
--8<-- "recipe-autopirate-toc.md" --8<-- "recipe-autopirate-toc.md"
## Lidarr vs Headphones
Lidarr and [Headphones][headphones] perform the same basic function. The primary difference, from what I can tell, is that Lidarr is build on the Arr stack, and so plays nicely with [Prowlarr][prowlarr].
## Integrate Lidarr with Beets
I've not tried this yet, but it seems that it's possible to [integrate Lidarr with Beets](https://www.reddit.com/r/Lidarr/comments/rahcer/my_lidarrbeets_automation_setup/)
--8<-- "recipe-footer.md" --8<-- "recipe-footer.md"

7
manuscript/recipes/autopirate/mylar.md
View File

@@ -1,8 +1,9 @@
--- ---
description: Mylar is a tool for downloading and managing digital comic books. title: How to run Mylar3 in Docker
description: Mylar is a tool for downloading and managing digital comic books, and is a valuable addition to the docker-swarm AutoPirate stack
--- ---
# Mylar # Mylar3 in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -13,7 +14,7 @@ description: Mylar is a tool for downloading and managing digital comic books.
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Mylar in your [AutoPirate](/recipes/autopirate/) stack, include the following in your autopirate.yml stack definition file: To include Mylar in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose v3 stack definition file:
```yaml ```yaml
mylar: mylar:

8
manuscript/recipes/autopirate/nzbget.md
View File

@@ -1,8 +1,9 @@
--- ---
description: NZBGet is a tool for downloading "content" from Usenet providers title: How to download from usenet using NZBGet in Docker
description: NZBGet is a tool for downloading "content" from Usenet providers, and is the workhorse of our Autopirate Docker Swarm stack
--- ---
# NZBGet # NZBGet in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -15,8 +16,7 @@ NZBGet performs the same function as [SABnzbd][sabnzbd] (_downloading content fr
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include NZBGet in your [AutoPirate](/recipes/autopirate/) stack To include NZBGet in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
(_The only reason you **wouldn't** use NZBGet, would be if you were using [SABnzbd](/recipes/autopirate/sabnzbd/) instead_), include the following in your autopirate.yml stack definition file:
```yaml ```yaml
nzbget: nzbget:

9
manuscript/recipes/autopirate/nzbhydra.md
View File

@@ -1,13 +1,14 @@
--- ---
description: NZBHydra is a meta search engine for NZB indexers title: Run nzbhydra2 in Docker
description: NZBHydra is a meta search engine for NZB indexers, and can be used to provide aggregated search results to usenet search tools such as Radarr, Sonarr, etc. Here's how to deploy NZBHydra2 in the Docker Swarm Autopirate stack
--- ---
# NZBHydra 2 # NZBHydra 2 in Autopirate Docker Swarm stack
!!! warning !!! 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. 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. [NZBHydra2](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.
![NZBHydra Screenshot](../../images/nzbhydra2.png) ![NZBHydra Screenshot](../../images/nzbhydra2.png)
@@ -30,7 +31,7 @@ Features include:
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include NZBHydra2 in your [AutoPirate][autopirate] stack, include the following in your autopirate.yml stack definition file: To include NZBHydra2 in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
```yaml ```yaml
nzbhydra2: nzbhydra2:

7
manuscript/recipes/autopirate/ombi.md
View File

@@ -1,8 +1,9 @@
--- ---
description: Ombi is like your media butler - it recommends, finds what you want to watch! title: Run Ombi in Docker (protecting the API with SSL)
description: Ombi is like your media butler - it recommends, finds what you want to watch! It includes a rich API, and since it's behind our traefik proxy, it inherits the same automatic SSL certificate generation as the rest of the Autopirate Docker Swarm stack.
--- ---
# Ombi # Ombi in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -21,7 +22,7 @@ User management system (_supports plex.tv, Emby and local accounts_)
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Ombi in your [AutoPirate](/recipes/autopirate/) stack, include the following in your autopirate.yml stack definition file: To include Ombi in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
```yaml ```yaml
ombi: ombi:

16
manuscript/recipes/autopirate/prowlarr.md
View File

@@ -1,8 +1,9 @@
--- ---
description: Prowlarr aggregates nzb/torrent searches. Like NZBHydra, but Arrr. title: Install Prowlarr in Docker
description: Prowlarr aggregates nzb/torrent searches. Imagine NZBHydra and Jackett had a baby, but it came out Arrr. Here's how you install Prowlarr into the Docker Swarm Autopirate stack
--- ---
# Radarr # Prowlarr in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -27,7 +28,7 @@ Fancy features include:
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Prowlarr in your [AutoPirate][autopirate] stack, include the following in your autopirate.yml stack definition file: To include Prowlarr in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
```yaml ```yaml
prowlarr: prowlarr:
@@ -62,6 +63,15 @@ To include Prowlarr in your [AutoPirate][autopirate] stack, include the followin
--8<-- "premix-cta.md" --8<-- "premix-cta.md"
--8<-- "recipe-autopirate-toc.md" --8<-- "recipe-autopirate-toc.md"
## Prowlarr vs Jackett
Prowlarr and [Jackett][jackett] perform similar roles (*they help you aggregate indexers*), but Prowlarr includes the following advantages over Jackett:
1. Prowlarr can search both Usenet **and** Torrent indexers
2. Given app API keys, Prowlarr can auto-configuer your Arr apps, adding its indexers. Prowlarr currently auto-configures [Radarr][radarr], [Sonarr][sonarr], [Lidarr][lidarr], [Mylar][mylar], [Readarr][Readarr], and [LazyLibrarian][lazylibrarian]
3. Prowlarr can integrate with Flaresolverr to make it possible to query indexers behind Cloudflare "are-you-a-robot" protection, which would otherwise not be possible.
--8<-- "recipe-footer.md" --8<-- "recipe-footer.md"
[^1]: Because Prowlarr is so young (*just a little kitten! :cat:*), there is no `:latest` image tag yet, so we're using the `:nightly` tag instead. Don't come crying to me if baby-Prowlarr bites your ass! [^1]: Because Prowlarr is so young (*just a little kitten! :cat:*), there is no `:latest` image tag yet, so we're using the `:nightly` tag instead. Don't come crying to me if baby-Prowlarr bites your ass!

7
manuscript/recipes/autopirate/radarr.md
View File

@@ -1,8 +1,9 @@
--- ---
description: Radarr is a tool for finding, downloading and managing movies title: How to run Radarr in Docker
description: Radarr is a tool for finding, downloading and managing movies, and is a valuable addition to the docker-swarm AutoPirate stack
--- ---
# Radarr # Radarr in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -27,7 +28,7 @@ description: Radarr is a tool for finding, downloading and managing movies
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Radarr in your [AutoPirate][autopirate] stack, include the following in your autopirate.yml stack definition file: To include Radarr in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose v3 stack definition file:
```yaml ```yaml
radarr: radarr:

8
manuscript/recipes/autopirate/readarr.md
View File

@@ -1,9 +1,9 @@
--- ---
description: Readarr is "Sonarr/Radarr for eBooks" title: Run Readarr (Sonarr for books / audiobooks) in Docker
description: Readarr is "Sonarr/Radarr for eBooks and audiobooks, and plays perfectly with the rest of the Autopirate Docker Swarm stack"
--- ---
# Readarr in Autopirate Docker Swarm stack
# Readarr
!!! warning !!! 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. 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.
@@ -26,7 +26,7 @@ Features include:
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Readarr in your [AutoPirate][autopirate] stack, include something like the following in your autopirate.yml stack definition file: To include Readarr in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
```yaml ```yaml
readarr: readarr:

7
manuscript/recipes/autopirate/rtorrent.md
View File

@@ -1,8 +1,9 @@
--- ---
description: A popular tool for managing BitTorrent downloads title: Install rutorrent / rtorrent in Docker
description: ruTorrent (looks like uTorrent) is a popular web UI frontend to rtorrent, the de-facto ncurses-based CLI torrent client. And it's a handy addition to our Autopirate Docker Swarm stack!
--- ---
# RTorrent / ruTorrent # RTorrent / ruTorrent in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -17,7 +18,7 @@ When using a torrent client from behind NAT (_which swarm, by nature, is_), you
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include ruTorrent in your [AutoPirate][autopirate] stack, include the following in your autopirate.yml stack definition file: To include ruTorrent in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
```yaml ```yaml
rtorrent: rtorrent:

8
manuscript/recipes/autopirate/sabnzbd.md
View File

@@ -1,8 +1,9 @@
--- ---
description: SABnzbd downloads and assembles your usenet content title: How to download from usenet using SABnzbd in Docker
description: SABnzbd is a tool for downloading "content" from Usenet providers, and is the (older) workhorse of our Autopirate Docker Swarm stack
--- ---
# SABnzbd # SABnzbd in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -15,8 +16,7 @@ SABnzbd is a workhorse of the stack. It takes .nzb files as input (_manually or
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include SABnzbd in your [AutoPirate](/recipes/autopirate/) stack To include SABnzbd in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose stack definition file:
(_The only reason you **wouldn't** use SABnzbd, would be if you were using [NZBGet](/recipes/autopirate/nzbget/) instead_), include the following in your autopirate.yml stack definition file:
--8<-- "premix-cta.md" --8<-- "premix-cta.md"

7
manuscript/recipes/autopirate/sonarr.md
View File

@@ -1,8 +1,9 @@
--- ---
description: Sonarr is a tool for finding, downloading and managing TV series title: How to setup Sonarr v3 in Docker
description: Sonarr is a tool for finding, downloading and managing TV series*, and is a valuable addition to the docker-swarm AutoPirate stack
--- ---
# Sonarr # Sonarr in Autopirate Docker Swarm stack
!!! warning !!! 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. 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.
@@ -13,7 +14,7 @@ description: Sonarr is a tool for finding, downloading and managing TV series
## Inclusion into AutoPirate ## Inclusion into AutoPirate
To include Sonarr in your [AutoPirate][autopirate] stack, include the following in your autopirate.yml stack definition file: To include Sonarr in your [AutoPirate](/recipes/autopirate/) stack, include something like the following example in your `autopirate.yml` docker-compose v3 stack definition file:
```yaml ```yaml
sonarr: sonarr:

5
manuscript/recipes/bitwarden.md
View File

@@ -1,8 +1,9 @@
--- ---
description: Protecting your secritz from all teh haxzors! title: How to run Bitwarden / bitwardenrs self hosted in Docker
description: Bitwarden / bitwardenrs is a self-hosted internet archiving solution
--- ---
# Bitwarden # Bitwarden, self hosted in Docker Swarm
Heard about the [latest password breach](https://www.databreaches.net) (*since lunch*)? [HaveYouBeenPowned](http://haveibeenpwned.com) yet (*today*)? [Passwords are broken](https://www.theguardian.com/technology/2008/nov/13/internet-passwords), and as the amount of sites for which you need to store credentials grows exponetially, so does the risk of using a common password. Heard about the [latest password breach](https://www.databreaches.net) (*since lunch*)? [HaveYouBeenPowned](http://haveibeenpwned.com) yet (*today*)? [Passwords are broken](https://www.theguardian.com/technology/2008/nov/13/internet-passwords), and as the amount of sites for which you need to store credentials grows exponetially, so does the risk of using a common password.

5
manuscript/recipes/bookstack.md
View File

@@ -1,8 +1,9 @@
--- ---
description: BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information title: Run linuxserver bookstack in Docker
description: BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information. Here's how to integrate linuxserver's bookstack image into your Docker Swarm stack.
--- ---
# BookStack # BookStack in Docker
BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information. BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information.

3
manuscript/recipes/calibre-web.md
View File

@@ -1,8 +1,9 @@
--- ---
title: Run calibre-web in Docker
description: Manage your ebook collection. Like a BOSS. description: Manage your ebook collection. Like a BOSS.
--- ---
# Calibre-Web # Calibre-Web in Docker
The [AutoPirate](/recipes/autopirate/) recipe includes [Lazy Librarian](https://github.com/itsmegb/LazyLibrarian), a tool for tracking, finding, and downloading eBooks. However, after the eBooks are downloaded, Lazy Librarian is not much use for organising, tracking, and actually **reading** them. The [AutoPirate](/recipes/autopirate/) recipe includes [Lazy Librarian](https://github.com/itsmegb/LazyLibrarian), a tool for tracking, finding, and downloading eBooks. However, after the eBooks are downloaded, Lazy Librarian is not much use for organising, tracking, and actually **reading** them.

3
manuscript/recipes/cyberchef.md
View File

@@ -1,5 +1,6 @@
--- ---
description: Be a l33t h@xor with this toolkit from the GHCQ title: Run an online a1z26 decoder with cyberchef (among others)
description: Be a l33t h@xor with this toolkit from the GHCQ. Run your own online instance of cyberchef, and decode / encode those nasty a1z26s!
--- ---
# CyberChef # CyberChef

1
manuscript/recipes/emby.md
View File

@@ -1,4 +1,5 @@
--- ---
title: Run Emby server with docker compose (using swarm)
description: Kick-ass media player! description: Kick-ass media player!
--- ---

1
manuscript/recipes/funkwhale.md
View File

@@ -1,4 +1,5 @@
--- ---
title: Install funkwhale with docker-compose / swarm
description: Funkwhale is a decentralized, federated music streaming platform description: Funkwhale is a decentralized, federated music streaming platform
--- ---

3
manuscript/recipes/jellyfin.md
View File

@@ -1,4 +1,5 @@
--- ---
title: Run Jellyfin in Docker with docker compose / swarm
description: Jellyfin is best described as "like Emby but really FOSS" description: Jellyfin is best described as "like Emby but really FOSS"
--- ---
@@ -8,7 +9,7 @@ description: Jellyfin is best described as "like Emby but really FOSS"
![Jellyfin Screenshot](../images/jellyfin.png) ![Jellyfin Screenshot](../images/jellyfin.png)
If it looks very similar as Emby, is because it started as a fork of it, but it has evolve since them. For a complete explanation of the why, look [here](https://jellyfin.org/docs/general/about.html). If it looks very similar as Emby, is because it started as a fork of it, but it has evolved since them. For a complete explanation of the why, look [here](https://jellyfin.org/docs/general/about.html).
--8<-- "recipe-standard-ingredients.md" --8<-- "recipe-standard-ingredients.md"