diff --git a/_includes/try-in-elfhosted.md b/_includes/try-in-elfhosted.md new file mode 100644 index 0000000..2e4dce7 --- /dev/null +++ b/_includes/try-in-elfhosted.md @@ -0,0 +1,4 @@ +!!! tip "Get your FREE "elfhosted" {{ page.meta.slug }} instance for demo / trial :partying_face: " + Want to see a live demo, or "kick the tyres" :blue_car: before you commit to self-hosting {{ page.meta.slug }}? + + Try out an "[ElfHosted][elfhosted]" :elf: instance of [{{ page.meta.slug }}](https://elfhosted.com/app/{{ page.meta.slug | lower }}) for **FREE**! diff --git a/docs/recipes/audiobookshelf.md b/docs/recipes/audiobookshelf.md index 5ffe37a..7ac4640 100644 --- a/docs/recipes/audiobookshelf.md +++ b/docs/recipes/audiobookshelf.md @@ -1,10 +1,13 @@ --- title: Run Audiobookshelf app in Docker description: Audiobookshelf is a self-hosted audiobook and podcast server, with native Android and iOS (Testflight) apps, supporting offline syncing +slug: Audiobookshelf --- # Audiobookshelf in Docker Swarm +{% include 'try-in-elfhosted.md' %} + [Audiobookshelf](https://www.audiobookshelf.org/) is a powerful audiobook / podcast streaming server, whose strength lies in its native app support on [Android](https://play.google.com/store/apps/details?id=com.audiobookshelf.app) / [iOS](https://testflight.apple.com/join/wiic7QIW) (*Testflight required*). ![Audiobookshelf Screenshot](/images/audiobookshelf.png){ loading=lazy } diff --git a/docs/recipes/autopirate/lazylibrarian.md b/docs/recipes/autopirate/lazylibrarian.md index 0e42971..127dd54 100644 --- a/docs/recipes/autopirate/lazylibrarian.md +++ b/docs/recipes/autopirate/lazylibrarian.md @@ -1,10 +1,13 @@ --- 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! +slug: LazyLibrarian --- # LazyLibrarian in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/lidarr.md b/docs/recipes/autopirate/lidarr.md index 45f72e5..d6f5113 100644 --- a/docs/recipes/autopirate/lidarr.md +++ b/docs/recipes/autopirate/lidarr.md @@ -1,9 +1,13 @@ --- title: How to install Lidarr (Music arr tool) in Docker description: Lidarr is an automated music downloader for NZB and Torrent +slug: Lidarr --- + # Lidarr in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/mylar.md b/docs/recipes/autopirate/mylar.md index 33bb7dc..811334f 100644 --- a/docs/recipes/autopirate/mylar.md +++ b/docs/recipes/autopirate/mylar.md @@ -1,10 +1,13 @@ --- 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 +slug: Mylar --- # Mylar3 in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/nzbget.md b/docs/recipes/autopirate/nzbget.md index a40f881..7abcd8e 100644 --- a/docs/recipes/autopirate/nzbget.md +++ b/docs/recipes/autopirate/nzbget.md @@ -1,10 +1,13 @@ --- 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 +slug: NZBGet --- # NZBGet in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/nzbhydra.md b/docs/recipes/autopirate/nzbhydra.md index b4162ce..0b93b46 100644 --- a/docs/recipes/autopirate/nzbhydra.md +++ b/docs/recipes/autopirate/nzbhydra.md @@ -1,10 +1,13 @@ --- 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 +slug: NZBHydra --- # NZBHydra 2 in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/ombi.md b/docs/recipes/autopirate/ombi.md index 3b6a27a..c0a6768 100644 --- a/docs/recipes/autopirate/ombi.md +++ b/docs/recipes/autopirate/ombi.md @@ -1,10 +1,13 @@ --- 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. +slug: Ombi --- # Ombi in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/prowlarr.md b/docs/recipes/autopirate/prowlarr.md index aa0fa70..87ac95c 100644 --- a/docs/recipes/autopirate/prowlarr.md +++ b/docs/recipes/autopirate/prowlarr.md @@ -1,10 +1,13 @@ --- 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 +slug: Prowlarr --- # Prowlarr in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/radarr.md b/docs/recipes/autopirate/radarr.md index 240690b..eb75689 100644 --- a/docs/recipes/autopirate/radarr.md +++ b/docs/recipes/autopirate/radarr.md @@ -1,10 +1,13 @@ --- 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 +slug: Radarr --- # Radarr in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. @@ -62,3 +65,4 @@ radarr: --8<-- "premix-cta.md" --8<-- "recipe-autopirate-toc.md" --8<-- "recipe-footer.md" +--8<-- "common-links.md" \ No newline at end of file diff --git a/docs/recipes/autopirate/readarr.md b/docs/recipes/autopirate/readarr.md index ef52d4e..b4c893c 100644 --- a/docs/recipes/autopirate/readarr.md +++ b/docs/recipes/autopirate/readarr.md @@ -1,10 +1,13 @@ --- 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" +slug: Readarr --- # Readarr in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/rtorrent.md b/docs/recipes/autopirate/rtorrent.md index 53181f4..6a77b41 100644 --- a/docs/recipes/autopirate/rtorrent.md +++ b/docs/recipes/autopirate/rtorrent.md @@ -1,10 +1,13 @@ --- 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! +slug: ruTorrent --- # RTorrent / ruTorrent in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/sabnzbd.md b/docs/recipes/autopirate/sabnzbd.md index 2795fd3..22f268d 100644 --- a/docs/recipes/autopirate/sabnzbd.md +++ b/docs/recipes/autopirate/sabnzbd.md @@ -1,10 +1,13 @@ --- 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 +slug: SABnzbd --- # SABnzbd in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/autopirate/sonarr.md b/docs/recipes/autopirate/sonarr.md index 633d950..8af61be 100644 --- a/docs/recipes/autopirate/sonarr.md +++ b/docs/recipes/autopirate/sonarr.md @@ -1,10 +1,13 @@ --- 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 +slug: Sonarr --- # Sonarr in Autopirate Docker Swarm stack +{% include 'try-in-elfhosted.md' %} + !!! 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. diff --git a/docs/recipes/bitwarden.md b/docs/recipes/bitwarden.md index a430d75..4748a5a 100644 --- a/docs/recipes/bitwarden.md +++ b/docs/recipes/bitwarden.md @@ -2,10 +2,13 @@ title: How to run Bitwarden / bitwardenrs self hosted in Docker description: Bitwarden / bitwardenrs is a self-hosted internet archiving solution recipe: Bitwarden +slug: Vaultwarden --- # Bitwarden, self hosted in Docker Swarm +{% include 'try-in-elfhosted.md' %} + 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. "*Duh, use a password manager*", you say. Sure, but be aware that [even password managers have security flaws](https://www.securityevaluators.com/casestudies/password-manager-hacking/). diff --git a/docs/recipes/calibre-web.md b/docs/recipes/calibre-web.md index c0cf9fd..c3c9f06 100644 --- a/docs/recipes/calibre-web.md +++ b/docs/recipes/calibre-web.md @@ -2,10 +2,13 @@ title: Run calibre-web in Docker description: Manage your ebook collection. Like a BOSS. recipe: Calibre-Web +slug: CalibreWeb --- # Calibre-Web in Docker +{% include 'try-in-elfhosted.md' %} + 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. [Calibre-Web](https://github.com/janeczku/calibre-web) could be described as "_[Plex](/recipes/plex/) (or [Emby](/recipes/emby/)) for eBooks_" - it's a web-based interface to manage your eBook library, screenshot below: diff --git a/docs/recipes/emby.md b/docs/recipes/emby.md index 7a017b1..506c6cd 100644 --- a/docs/recipes/emby.md +++ b/docs/recipes/emby.md @@ -2,10 +2,13 @@ title: Run Emby server with docker compose (using swarm) description: Kick-ass media player! recipe: Emby +slug: Emby --- # Emby +{% include 'try-in-elfhosted.md' %} + [Emby](https://emby.media/) (_think "M.B." or "Media Browser"_) is best described as "_like [Plex](/recipes/plex/) but different_" 😁 - It's a bit geekier and less polished than Plex, but it allows for more flexibility and customization. ![Emby Screenshot](../images/emby.png){ loading=lazy } diff --git a/docs/recipes/jellyfin.md b/docs/recipes/jellyfin.md index f51863d..bac40b5 100644 --- a/docs/recipes/jellyfin.md +++ b/docs/recipes/jellyfin.md @@ -2,10 +2,13 @@ title: Run Jellyfin in Docker with docker compose / swarm description: Jellyfin is best described as "like Emby but really FOSS" recipe: Jellyfin +slug: Jellyfin --- # Jellyfin +{% include 'try-in-elfhosted.md' %} + [Jellyfin](https://jellyfin.org/) is best described as "_like [Emby][emby] but really [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software)_". ![Jellyfin Screenshot](../images/jellyfin.png){ loading=lazy } diff --git a/docs/recipes/kavita.md b/docs/recipes/kavita.md index c667f3e..25f25e4 100644 --- a/docs/recipes/kavita.md +++ b/docs/recipes/kavita.md @@ -2,10 +2,13 @@ title: Kavita Reader in Docker - Read ebooks / Manga / Comics description: Here's a recipe to run Kavita under Docker Swarm to read your comics / manga / ebooks recipe: Kavita +slug: Kavita --- # Kavita Reader in Docker Swarm +{% include 'try-in-elfhosted.md' %} + So you've just watched a bunch of superhero movies, and you're suddenly inspired to deep-dive into the weird world of comic books? You're already rocking [AutoPirate](/recipes/autopirate/) with [Mylar](/recipes/autopirate/mylar/) and [NZBGet](/recipes/autopirate/nzbget/) to grab content, but how to manage and enjoy your growing collection? ![Kavita Screenshot](/images/kavita.png){ loading=lazy } diff --git a/docs/recipes/komga.md b/docs/recipes/komga.md index 0fd6b6a..83d834c 100644 --- a/docs/recipes/komga.md +++ b/docs/recipes/komga.md @@ -2,10 +2,13 @@ title: How to run Komga with Docker description: Run Komga under Docker Swarm in docker-compose syntax recipe: Komga +slug: Komga --- # Komga in Docker Swarm +{% include 'try-in-elfhosted.md' %} + So you've just watched a bunch of superhero movies, and you're suddenly inspired to deep-dive into the weird world of comic books? You're already rocking [AutoPirate](/recipes/autopirate/) with [Mylar](/recipes/autopirate/mylar/) and [NZBGet](/recipes/autopirate/nzbget/) to grab content, but how to manage and enjoy your growing collection? ![Komga Screenshot](../images/komga.png){ loading=lazy } diff --git a/docs/recipes/plex.md b/docs/recipes/plex.md index e16f325..99e705a 100644 --- a/docs/recipes/plex.md +++ b/docs/recipes/plex.md @@ -2,10 +2,13 @@ title: Run Plex in Docker description: Play back all your media on all your devices recipe: Plex +slug: Plex --- # Plex in Docker +{% include 'try-in-elfhosted.md' %} + [Plex](https://www.plex.tv/) is a client-server media player system and software suite comprising two main components (a media server and client applications) ![Plex Screenshot](../images/plex.jpg) diff --git a/docs/recipes/privatebin.md b/docs/recipes/privatebin.md index c4f7116..fb8b5eb 100644 --- a/docs/recipes/privatebin.md +++ b/docs/recipes/privatebin.md @@ -2,10 +2,13 @@ title: Run PrivateBin on Docker description: A private imgur/pastebin, running on Docker recipe: PrivateBin +slug: PrivateBin --- # PrivateBin +{% include 'try-in-elfhosted.md' %} + PrivateBin is a minimalist, open source online pastebin where the server (can) has zero knowledge of pasted data. We all need to paste data / log files somewhere when it doesn't make sense to paste it inline. With PrivateBin, you can own the hosting, access, and eventual deletion of this data. ![PrivateBin Screenshot](../images/privatebin.png){ loading=lazy } diff --git a/mkdocs-insiders.yml b/mkdocs-insiders.yml index 8f9f68b..81f61c5 100644 --- a/mkdocs-insiders.yml +++ b/mkdocs-insiders.yml @@ -3,7 +3,6 @@ INHERIT: mkdocs.yml plugins: extra-sass: - meta: blog: # post_excerpt: required post_url_format: "{date}/{file}" # this allows us to change the post title in future without breaking URLs diff --git a/mkdocs.yml b/mkdocs.yml index f109ffe..b01fa1e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,8 +25,9 @@ plugins: fallback_to_build_date: true macros: verbose: true + include_dir: _includes meta-descriptions: # If not provided, auto-generate a description (https://pypi.org/project/mkdocs-meta-descriptions-plugin/) - + meta: #theme_dir: mkdocs-material nav: @@ -195,6 +196,10 @@ nav: - Operator: kubernetes/persistence/rook-ceph/operator.md - Cluster: kubernetes/persistence/rook-ceph/cluster.md # - LongHorn: kubernetes/persistence/longhorn.md + - OIDC Authentication: + - kubernetes/oidc/index.md + - Authentik: kubernetes/oidc/authentik.md + # - Keycloak: kubernetes/oidc/authentik.md # - Backup: # - kubernetes/backup/index.md # - kubernetes/wip.md @@ -289,6 +294,7 @@ theme: - navigation.indexes - navigation.top - navigation.pruning + - navigation.path - search.suggest - search.share - content.code.annotate diff --git a/scripts/serve-insiders.sh b/scripts/serve-insiders.sh index e75f750..bb46fbe 100755 --- a/scripts/serve-insiders.sh +++ b/scripts/serve-insiders.sh @@ -1,7 +1,7 @@ #!/bin/bash docker pull ghcr.io/geek-cookbook/mkdocs-material-insiders docker build --build-arg FROM_SOURCE=ghcr.io/geek-cookbook/mkdocs-material-insiders . -t funkypenguin/mkdocs-material-insiders -docker run --rm --name mkdocs-material -it -p 8123:8000 -v ${PWD}:/docs -e PROD_BUILD=false funkypenguin/mkdocs-material-insiders serve \ +docker run --rm --name mkdocs-material-geek-cookbook -it -p 8123:8000 -v ${PWD}:/docs -e PROD_BUILD=false funkypenguin/mkdocs-material-insiders serve \ --dev-addr 0.0.0.0:8000 \ --dirtyreload \ --config-file mkdocs-insiders.yml \ No newline at end of file