mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2026-10-23 09:13:21 +00:00
Add Linx, apply formatting fixes (#145)
* Add Linx, apply formatting fixes Fixes #143 Signed-off-by: David Young <davidy@funkypenguin.co.nz> * Add macros plugin Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
David Young authored and GitHub committed
1 parent
5bf1acc403
commit
1e5cd5df29
16 files changed
+210
-134
No files matched your search
@@ -1,4 +1,5 @@
|
|||||||
mkdocs-material
|
mkdocs-material
|
||||||
mkdocs-autolinks-plugin
|
mkdocs-autolinks-plugin
|
||||||
mkdocs-htmlproofer-plugin
|
mkdocs-htmlproofer-plugin
|
||||||
mkdocs-git-revision-date-localized-plugin
|
mkdocs-git-revision-date-localized-plugin
|
||||||
|
mkdocs-macros-plugin
|
||||||
+2
-1
@@ -3,4 +3,5 @@ FROM ghcr.io/squidfunk/mkdocs-material-insiders
|
|||||||
RUN pip install \
|
RUN pip install \
|
||||||
mkdocs-autolinks-plugin \
|
mkdocs-autolinks-plugin \
|
||||||
mkdocs-htmlproofer-plugin \
|
mkdocs-htmlproofer-plugin \
|
||||||
mkdocs-git-revision-date-localized-plugin
|
mkdocs-git-revision-date-localized-plugin \
|
||||||
|
mkdocs-macros-plugin
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<form action="https://app.convertkit.com/forms/1413027/subscriptions" class="seva-form formkit-form" method="post" data-sv-form="1413027" data-uid="20249aa846" data-format="inline" data-version="5" data-options="{"settings":{"after_subscribe":{"action":"message","success_message":"Success! Now check your email to confirm your subscription.","redirect_url":""},"analytics":{"google":null,"facebook":null,"segment":null,"pinterest":null},"modal":{"trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15},"powered_by":{"show":true,"url":"https://convertkit.com?utm_source=dynamic&utm_medium=referral&utm_campaign=poweredby&utm_content=form"},"recaptcha":{"enabled":true},"return_visitor":{"action":"custom_content","custom_content":"You're subscribed!"},"slide_in":{"display_in":"bottom_right","trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15},"sticky_bar":{"display_in":"top","trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15}},"version":"5"}" min-width="400 500 600 700 800" style="background-color: rgb(249, 250, 251); border-radius: 4px;"><div class="formkit-background" style="opacity: 0.2;"></div><div data-style="minimal"><div class="formkit-header" data-element="header" style="color: rgb(77, 77, 77); font-size: 27px; font-weight: 700;"><h1><span style="color:rgb(74, 74, 74)"><strong>Notify me 🔔</strong></span></h1></div><div class="formkit-subheader" data-element="subheader" style="color: rgb(104, 104, 104); font-size: 18px;"><p><span style="color:rgb(74, 74, 74)">Be the first to know when recipes are added / improved!</span></p></div><ul class="formkit-alert formkit-alert-error" data-element="errors" data-group="alert"></ul><div data-element="fields" data-stacked="true" class="seva-fields formkit-fields"><div class="formkit-field"><input class="formkit-input" aria-label="Your first name" name="fields[first_name]" placeholder="Your first name" type="text" style="color: rgb(0, 0, 0); border-color: rgb(227, 227, 227); border-radius: 4px; font-weight: 400;"></div><div class="formkit-field"><input class="formkit-input" name="email_address" placeholder="Your email address" required="" type="email" style="color: rgb(0, 0, 0); border-color: rgb(227, 227, 227); border-radius: 4px; font-weight: 400;"></div><button data-element="submit" class="formkit-submit formkit-submit" style="color: rgb(255, 255, 255); background-color: rgb(0, 0, 0); border-radius: 4px; font-weight: 400;"><div class="formkit-spinner"><div></div><div></div><div></div></div><span>Send me new recipes!</span></button></div><div class="formkit-guarantee" data-element="guarantee" style="color: rgb(77, 77, 77); font-size: 13px; font-weight: 400;"><p>We won't send you spam. Unsubscribe at any time. No monkey-business.</p></div><a href="https://convertkit.com?utm_source=dynamic&utm_medium=referral&utm_campaign=poweredby&utm_content=form" class="formkit-powered-by" data-element="powered-by" target="_blank" rel="noopener noreferrer">Powered By ConvertKit</a></div><style>.formkit-form[data-uid="20249aa846"] *{box-sizing:border-box;}.formkit-form[data-uid="20249aa846"]{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;}.formkit-form[data-uid="20249aa846"] legend{border:none;font-size:inherit;margin-bottom:10px;padding:0;position:relative;display:table;}.formkit-form[data-uid="20249aa846"] fieldset{border:0;padding:0.01em 0 0 0;margin:0;min-width:0;}.formkit-form[data-uid="20249aa846"] body:not(:-moz-handler-blocked) fieldset{display:table-cell;}.formkit-form[data-uid="20249aa846"] h1,.formkit-form[data-uid="20249aa846"] h2,.formkit-form[data-uid="20249aa846"] h3,.formkit-form[data-uid="20249aa846"] h4,.formkit-form[data-uid="20249aa846"] h5,.formkit-form[data-uid="20249aa846"] h6{color:inherit;font-size:inherit;font-weight:inherit;}.formkit-form[data-uid="20249aa846"] p{color:inherit;font-size:inherit;font-weight:inherit;}.formkit-form[data-uid="20249aa846"] ol:not([template-default]),.formkit-form[data-uid="20249aa846"] ul:not([template-default]),.formkit-form[data-uid="20249aa846"] blockquote:not([template-default]){text-align:left;}.formkit-form[data-uid="20249aa846"] p:not([template-default]),.formkit-form[data-uid="20249aa846"] hr:not([template-default]),.formkit-form[data-uid="20249aa846"] blockquote:not([template-default]),.formkit-form[data-uid="20249aa846"] ol:not([templaLine truncated
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
!!! tip
|
!!! tip inline end
|
||||||
I share (_with my [sponsors](https://github.com/sponsors/funkypenguin)_) a private "[_premix_](https://geek-cookbook.funkypenguin.co.nz/premix/)" git repository, which includes necessary docker-compose and env files for all published recipes. This means that sponsors can launch any recipe with just a `git pull` and a `docker stack deploy` 👍.
|
I share (_with my [sponsors](https://github.com/sponsors/funkypenguin)_) a private "[_premix_](https://geek-cookbook.funkypenguin.co.nz/premix/)" git repository, which includes necessary docker-compose and env files for all published recipes. This means that sponsors can launch any recipe with just a `git pull` and a `docker stack deploy` 👍.
|
||||||
|
|
||||||
🚀 **Update**: Premix now includes an ansible playbook, so that sponsors can deploy an entire stack + recipes, with a single ansible command! (more [here](https://geek-cookbook.funkypenguin.co.nz/premix/ansible/operation/))
|
🚀 **Update**: Premix now includes an ansible playbook, so that sponsors can deploy an entire stack + recipes, with a single ansible command! (*more [here](https://geek-cookbook.funkypenguin.co.nz/premix/ansible/operation/)*)
|
||||||
@@ -10,7 +10,7 @@ Did you receive excellent service? Want to make your waiter happy? (_..and suppo
|
|||||||
|
|
||||||
Want to know now when this recipe gets updated, or when future recipes are added? Subscribe to the [RSS feed](https://mastodon.social/@geekcookbook_changes.atom), or leave your email address below, and we'll keep you updated. (*double-opt-in, no monkey business, no spam)
|
Want to know now when this recipe gets updated, or when future recipes are added? Subscribe to the [RSS feed](https://mastodon.social/@geekcookbook_changes.atom), or leave your email address below, and we'll keep you updated. (*double-opt-in, no monkey business, no spam)
|
||||||
|
|
||||||
<form action="https://app.convertkit.com/forms/1413027/subscriptions" class="seva-form formkit-form" method="post" data-sv-form="1413027" data-uid="20249aa846" data-format="inline" data-version="5" data-options="{"settings":{"after_subscribe":{"action":"message","success_message":"Success! Now check your email to confirm your subscription.","redirect_url":""},"analytics":{"google":null,"facebook":null,"segment":null,"pinterest":null},"modal":{"trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15},"powered_by":{"show":true,"url":"https://convertkit.com?utm_source=dynamic&utm_medium=referral&utm_campaign=poweredby&utm_content=form"},"recaptcha":{"enabled":true},"return_visitor":{"action":"custom_content","custom_content":"You're subscribed!"},"slide_in":{"display_in":"bottom_right","trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15},"sticky_bar":{"display_in":"top","trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15}},"version":"5"}" min-width="400 500 600 700 800" style="background-color: rgb(249, 250, 251); border-radius: 4px;"><div class="formkit-background" style="opacity: 0.2;"></div><div data-style="minimal"><div class="formkit-header" data-element="header" style="color: rgb(77, 77, 77); font-size: 27px; font-weight: 700;"><h1><span style="color:rgb(74, 74, 74)"><strong>Notify me 🔔</strong></span></h1></div><div class="formkit-subheader" data-element="subheader" style="color: rgb(104, 104, 104); font-size: 18px;"><p><span style="color:rgb(74, 74, 74)">Be the first to know when recipes are added / improved!</span></p></div><ul class="formkit-alert formkit-alert-error" data-element="errors" data-group="alert"></ul><div data-element="fields" data-stacked="true" class="seva-fields formkit-fields"><div class="formkit-field"><input class="formkit-input" aria-label="Your first name" name="fields[first_name]" placeholder="Your first name" type="text" style="color: rgb(0, 0, 0); border-color: rgb(227, 227, 227); border-radius: 4px; font-weight: 400;"></div><div class="formkit-field"><input class="formkit-input" name="email_address" placeholder="Your email address" required="" type="email" style="color: rgb(0, 0, 0); border-color: rgb(227, 227, 227); border-radius: 4px; font-weight: 400;"></div><button data-element="submit" class="formkit-submit formkit-submit" style="color: rgb(255, 255, 255); background-color: rgb(0, 0, 0); border-radius: 4px; font-weight: 400;"><div class="formkit-spinner"><div></div><div></div><div></div></div><span>Send me new recipes!</span></button></div><div class="formkit-guarantee" data-element="guarantee" style="color: rgb(77, 77, 77); font-size: 13px; font-weight: 400;"><p>We won't send you spam. Unsubscribe at any time. No monkey-business.</p></div><a href="https://convertkit.com?utm_source=dynamic&utm_medium=referral&utm_campaign=poweredby&utm_content=form" class="formkit-powered-by" data-element="powered-by" target="_blank" rel="noopener noreferrer">Powered By ConvertKit</a></div><style>.formkit-form[data-uid="20249aa846"] *{box-sizing:border-box;}.formkit-form[data-uid="20249aa846"]{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;}.formkit-form[data-uid="20249aa846"] legend{border:none;font-size:inherit;margin-bottom:10px;padding:0;position:relative;display:table;}.formkit-form[data-uid="20249aa846"] fieldset{border:0;padding:0.01em 0 0 0;margin:0;min-width:0;}.formkit-form[data-uid="20249aa846"] body:not(:-moz-handler-blocked) fieldset{display:table-cell;}.formkit-form[data-uid="20249aa846"] h1,.formkit-form[data-uid="20249aa846"] h2,.formkit-form[data-uid="20249aa846"] h3,.formkit-form[data-uid="20249aa846"] h4,.formkit-form[data-uid="20249aa846"] h5,.formkit-form[data-uid="20249aa846"] h6{color:inherit;font-size:inherit;font-weight:inherit;}.formkit-form[data-uid="20249aa846"] p{color:inherit;font-size:inherit;font-weight:inherit;}.formkit-form[data-uid="20249aa846"] ol:not([template-default]),.formkit-form[data-uid="20249aa846"] ul:not([template-default]),.formkit-form[data-uid="20249aa846"] blockquote:not([template-default]){text-align:left;}.formkit-form[data-uid="20249aa846"] p:not([template-default]),.formkit-form[data-uid="20249aa846"] hr:not([template-default]),.formkit-form[data-uid="20249aa846"] blockquote:not([template-default]),.formkit-form[data-uid="20249aa846"] ol:not([templaLine truncated
|
--8<-- "convertkit-subscribe-form.html"
|
||||||
|
|
||||||
## Your comments? 💬
|
## Your comments? 💬
|
||||||
|
|
||||||
|
|||||||
+21
-18
@@ -1,28 +1,31 @@
|
|||||||
|
---
|
||||||
|
hide:
|
||||||
|
- navigation # Hide navigation
|
||||||
|
---
|
||||||
# CHANGELOG
|
# CHANGELOG
|
||||||
|
|
||||||
|
## Recent additions
|
||||||
|
|
||||||
|
Recipe | Description | Date
|
||||||
|
-----------------------------------|-------------------------------------------------------------------------------------|--------------
|
||||||
|
[Linx](/recipes/linx/) | Quickly and securely share media/files with optional password-protection and expiry | _13 Jan 2021_
|
||||||
|
[Komga](/recipes/komga/) | Beautiful interface to manage and enjoy your comics / graphic novels | _5 Jan 2021_
|
||||||
|
[Photoprism](/recipes/photoprism/) | Self-hosted photo-management app incorporating automated tagging using Tensorflow | _6 Aug 2020_
|
||||||
|
|
||||||
|
|
||||||
|
## Recent updates
|
||||||
|
|
||||||
|
Recipe | Description | Date
|
||||||
|
---------------------------------------------------------------|---------------------------------------|--------------
|
||||||
|
[Traefik Forward Auth](/ha-docker-swarm/traefik-forward-auth/) | Now uses for latest @thomseddon image | _11 Jun 2020_
|
||||||
|
|
||||||
|
|
||||||
## Subscribe to updates
|
## Subscribe to updates
|
||||||
|
|
||||||
<script src="https://f.convertkit.com/ckjs/ck.5.js"></script>
|
--8<-- "convertkit-subscribe-form.html"
|
||||||
<form action="https://app.convertkit.com/forms/1413027/subscriptions" class="seva-form formkit-form" method="post" data-sv-form="1413027" data-uid="20249aa846" data-format="inline" data-version="5" data-options="{"settings":{"after_subscribe":{"action":"message","success_message":"Success! Now check your email to confirm your subscription.","redirect_url":""},"analytics":{"google":null,"facebook":null,"segment":null,"pinterest":null},"modal":{"trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15},"powered_by":{"show":true,"url":"https://convertkit.com?utm_source=dynamic&utm_medium=referral&utm_campaign=poweredby&utm_content=form"},"recaptcha":{"enabled":true},"return_visitor":{"action":"custom_content","custom_content":"You're subscribed!"},"slide_in":{"display_in":"bottom_right","trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15},"sticky_bar":{"display_in":"top","trigger":"timer","scroll_percentage":null,"timer":5,"devices":"all","show_once_every":15}},"version":"5"}" min-width="400 500 600 700 800" style="background-color: rgb(249, 250, 251); border-radius: 4px;"><div class="formkit-background" style="opacity: 0.2;"></div><div data-style="minimal"><div class="formkit-header" data-element="header" style="color: rgb(77, 77, 77); font-size: 27px; font-weight: 700;"><h1><span style="color:rgb(74, 74, 74)"><strong>Notify me 🔔</strong></span></h1></div><div class="formkit-subheader" data-element="subheader" style="color: rgb(104, 104, 104); font-size: 18px;"><p><span style="color:rgb(74, 74, 74)">Be the first to know when recipes are added / improved!</span></p></div><ul class="formkit-alert formkit-alert-error" data-element="errors" data-group="alert"></ul><div data-element="fields" data-stacked="true" class="seva-fields formkit-fields"><div class="formkit-field"><input class="formkit-input" aria-label="Your first name" name="fields[first_name]" placeholder="Your first name" type="text" style="color: rgb(0, 0, 0); border-color: rgb(227, 227, 227); border-radius: 4px; font-weight: 400;"></div><div class="formkit-field"><input class="formkit-input" name="email_address" placeholder="Your email address" required="" type="email" style="color: rgb(0, 0, 0); border-color: rgb(227, 227, 227); border-radius: 4px; font-weight: 400;"></div><button data-element="submit" class="formkit-submit formkit-submit" style="color: rgb(255, 255, 255); background-color: rgb(0, 0, 0); border-radius: 4px; font-weight: 400;"><div class="formkit-spinner"><div></div><div></div><div></div></div><span>Send me new recipes!</span></button></div><div class="formkit-guarantee" data-element="guarantee" style="color: rgb(77, 77, 77); font-size: 13px; font-weight: 400;"><p>We won't send you spam. Unsubscribe at any time. No monkey-business.</p></div><a href="https://convertkit.com?utm_source=dynamic&utm_medium=referral&utm_campaign=poweredby&utm_content=form" class="formkit-powered-by" data-element="powered-by" target="_blank" rel="noopener noreferrer">Powered By ConvertKit</a></div><style>.formkit-form[data-uid="20249aa846"] *{box-sizing:border-box;}.formkit-form[data-uid="20249aa846"]{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;}.formkit-form[data-uid="20249aa846"] legend{border:none;font-size:inherit;margin-bottom:10px;padding:0;position:relative;display:table;}.formkit-form[data-uid="20249aa846"] fieldset{border:0;padding:0.01em 0 0 0;margin:0;min-width:0;}.formkit-form[data-uid="20249aa846"] body:not(:-moz-handler-blocked) fieldset{display:table-cell;}.formkit-form[data-uid="20249aa846"] h1,.formkit-form[data-uid="20249aa846"] h2,.formkit-form[data-uid="20249aa846"] h3,.formkit-form[data-uid="20249aa846"] h4,.formkit-form[data-uid="20249aa846"] h5,.formkit-form[data-uid="20249aa846"] h6{color:inherit;font-size:inherit;font-weight:inherit;}.formkit-form[data-uid="20249aa846"] p{color:inherit;font-size:inherit;font-weight:inherit;}.formkit-form[data-uid="20249aa846"] ol:not([template-default]),.formkit-form[data-uid="20249aa846"] ul:not([template-default]),.formkit-form[data-uid="20249aa846"] blockquote:not([template-default]){text-align:left;}.formkit-form[data-uid="20249aa846"] p:not([template-default]),.formkit-form[data-uid="20249aa846"] hr:not([template-default]),.formkit-form[data-uid="20249aa846"] blockquote:not([template-default]),.formkit-form[data-uid="20249aa846"] ol:not([templaLine truncated
|
|
||||||
|
|
||||||
Also available via:
|
Also available via:
|
||||||
|
|
||||||
* Mastodon: https://mastodon.social/@geekcookbook_changes
|
* Mastodon: https://mastodon.social/@geekcookbook_changes
|
||||||
* RSS: https://mastodon.social/@geekcookbook_changes.rss
|
* RSS: https://mastodon.social/@geekcookbook_changes.rss
|
||||||
* The #changelog channel in our [Discord server](http://chat.funkypenguin.co.nz)
|
* The #changelog channel in our [Discord server](http://chat.funkypenguin.co.nz)
|
||||||
|
|
||||||
## Recently added recipes
|
|
||||||
|
|
||||||
* Added recipe for [Komga](/recipes/komga/), a beautiful interface to manage and enjoy your comics / graphic novels (_5 Jan 2021_)
|
|
||||||
* Added recipe for [Photoprism](/recipes/photoprism/), self-hosted photo app incorporating automated tagging using Tensorflow (_6 Aug 2020_)
|
|
||||||
* Added recipe for [JellyFin](/recipes/jellyfin/), the [FOSS fork](https://www.linuxuprising.com/2018/12/jellyfin-free-software-emby-media.html#:~:text=The%20free%20software%20Emby%20fork,differences%20with%20the%20core%20developers.) of [Emby](/recipes/emby/) (_6 Aug 2020_)
|
|
||||||
* Added recipe for [Restic](/recipes/restic/), simple and secure backup solution with **huge** range of target platforms via rclone (_25 June 2020_)
|
|
||||||
* Added recipe for [Duplicati](/recipes/duplicati/), all-in-one backup solution with a handy GUI (_18 June 2020_)
|
|
||||||
* Overhauled [Ceph (Shared Storage)](/ha-docker-swarm/shared-storage-ceph/) recipe for Ceph Octopus (v15) (_25 May 2020_)
|
|
||||||
|
|
||||||
|
|
||||||
## Recent improvements
|
|
||||||
|
|
||||||
* Updated [Traefik Forward Auth](/ha-docker-swarm/traefik-forward-auth/) for latest @thomseddon image (_11 Jun 2020_)
|
|
||||||
* Added recipe for [automated snapshots of Kubernetes Persistent Volumes](/kubernetes/snapshots/), instructions for using [Helm](/kubernetes/helm/), and recipe for deploying [Traefik](/kubernetes/traefik/), which completes the Kubernetes cluster design! (_9 Feb 2019_)
|
|
||||||
* Added detailed description (_and diagram_) of our [Kubernetes design](/kubernetes/design/), plus a [simple load-balancer design](kubernetes/loadbalancer/) to avoid the complexities/costs of permitting ingress access to a cluster (_7 Feb 2019_)
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
document.addEventListener("DOMContentLoaded", function() {
|
|
||||||
load_navpane();
|
|
||||||
});
|
|
||||||
|
|
||||||
function load_navpane() {
|
|
||||||
var width = window.innerWidth;
|
|
||||||
if (width <= 1200) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
var nav = document.getElementsByClassName("md-nav");
|
|
||||||
for(var i = 0; i < nav.length; i++) {
|
|
||||||
if (typeof nav.item(i).style === "undefined") {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (nav.item(i).getAttribute("data-md-level") && nav.item(i).getAttribute("data-md-component")) {
|
|
||||||
nav.item(i).style.display = 'block';
|
|
||||||
nav.item(i).style.overflow = 'visible';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var nav = document.getElementsByClassName("md-nav__toggle");
|
|
||||||
for(var i = 0; i < nav.length; i++) {
|
|
||||||
nav.item(i).checked = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
app.document$.subscribe(function() {
|
||||||
|
var tables = document.querySelectorAll("article table")
|
||||||
|
tables.forEach(function(table) {
|
||||||
|
new Tablesort(table)
|
||||||
|
})
|
||||||
|
})
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
@@ -6,8 +6,13 @@ hide:
|
|||||||
|
|
||||||
# Welcome, fellow geek :wave:
|
# Welcome, fellow geek :wave:
|
||||||
|
|
||||||
|
## What is this?
|
||||||
|
|
||||||
Funky Penguin's "**[Geek Cookbook](https://geek-cookbook.funkypenguin.co.nz)**" is a collection of how-to guides for establishing your own container-based self-hosting platform, using either [Docker Swarm](/ha-docker-swarm/design/) or [Kubernetes](/kubernetes/).
|
Funky Penguin's "**[Geek Cookbook](https://geek-cookbook.funkypenguin.co.nz)**" is a collection of how-to guides for establishing your own container-based self-hosting platform, using either [Docker Swarm](/ha-docker-swarm/design/) or [Kubernetes](/kubernetes/).
|
||||||
|
|
||||||
|
[Dive into Docker Swarm](/ha-docker-swarm/design/){: .md-button .md-button--primary}
|
||||||
|
[Kick it with Kubernetes](/kubernetes/){: .md-button}
|
||||||
|
|
||||||
Running such a platform enables you to run self-hosted tools such as [AutoPirate](/recipes/autopirate/) (*Radarr, Sonarr, NZBGet and friends*), [Plex](https://www.plex.tv/), [NextCloud](https://nextcloud.com/), and includes elements such as:
|
Running such a platform enables you to run self-hosted tools such as [AutoPirate](/recipes/autopirate/) (*Radarr, Sonarr, NZBGet and friends*), [Plex](https://www.plex.tv/), [NextCloud](https://nextcloud.com/), and includes elements such as:
|
||||||
|
|
||||||
* [Automatic SSL-secured access](/ha-docker-swarm/traefik/) to all services (*with LetsEncrypt*)
|
* [Automatic SSL-secured access](/ha-docker-swarm/traefik/) to all services (*with LetsEncrypt*)
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ config:
|
|||||||
# cloudflare_api_key:
|
# cloudflare_api_key:
|
||||||
|
|
||||||
# if you're using route53
|
# if you're using route53
|
||||||
AWS_ACCESS_KEY_ID: "{{ vault_config.traefik.aws_access_key_id }}"
|
AWS_ACCESS_KEY_ID: {{ "{{ vault_config.traefik.aws_access_key_id }}" }}
|
||||||
AWS_SECRET_ACCESS_KEY: "{{ vault_config.traefik.aws_secret_access_key }}"
|
AWS_SECRET_ACCESS_KEY: {{ "{{ vault_config.traefik.aws_secret_access_key }}" }}
|
||||||
AWS_REGION: ""
|
AWS_REGION: ""
|
||||||
```
|
```
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
# Linx
|
||||||
|
|
||||||
|
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?
|
||||||
|
|
||||||
|
{: loading=lazy }
|
||||||
|
|
||||||
|
[Linx](https://github.com/andreimarcu/linx-server) is self-hosted file/media-sharing service, which features:
|
||||||
|
|
||||||
|
- :white_check_mark: Display common filetypes (*image, video, audio, markdown, pdf*)
|
||||||
|
- :white_check_mark: Display syntax-highlighted code with in-place editing
|
||||||
|
- :white_check_mark: Documented API with keys for restricting uploads
|
||||||
|
- :white_check_mark: Torrent download of files using web seeding
|
||||||
|
- :white_check_mark: File expiry, deletion key, file access key, and random filename options
|
||||||
|
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
|
||||||
|
## Preparation
|
||||||
|
|
||||||
|
### Setup data locations
|
||||||
|
|
||||||
|
First we create a directory to hold the data which linx will serve:
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir /var/data/linx
|
||||||
|
```
|
||||||
|
|
||||||
|
### Create config file
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir /var/data/config/linx
|
||||||
|
cat << EOF > /var/data/config/linx/linx.conf
|
||||||
|
# Refer to https://github.com/andreimarcu/linx-server for details
|
||||||
|
cleanup-every-minutes = 5
|
||||||
|
EOF
|
||||||
|
```
|
||||||
|
|
||||||
|
### Setup Docker Swarm
|
||||||
|
|
||||||
|
Create a docker swarm config file in docker-compose syntax (v3), something like this:
|
||||||
|
|
||||||
|
--8<-- "premix-cta.md"
|
||||||
|
|
||||||
|
```
|
||||||
|
version: "3.2" # https://docs.docker.com/compose/compose-file/compose-versioning/#version-3
|
||||||
|
|
||||||
|
services:
|
||||||
|
linx:
|
||||||
|
image: andreimarcu/linx-server
|
||||||
|
env_file: /var/data/config/linx/linx.env
|
||||||
|
command: -config /linx.conf
|
||||||
|
volumes:
|
||||||
|
- /var/data/linx/:/files/
|
||||||
|
- /var/data/config/linx/linx.conf:/linx.conf:ro
|
||||||
|
deploy:
|
||||||
|
labels:
|
||||||
|
# traefik common
|
||||||
|
- traefik.enable=true
|
||||||
|
- traefik.docker.network=traefik_public
|
||||||
|
|
||||||
|
# traefikv1
|
||||||
|
- traefik.frontend.rule=Host:linx.example.com
|
||||||
|
- traefik.port=8080
|
||||||
|
|
||||||
|
# traefikv2
|
||||||
|
- "traefik.http.routers.linx.rule=Host(`linx.example.com`)"
|
||||||
|
- "traefik.http.routers.linx.entrypoints=https"
|
||||||
|
- "traefik.http.services.linx.loadbalancer.server.port=8080"
|
||||||
|
|
||||||
|
networks:
|
||||||
|
- traefik_public
|
||||||
|
|
||||||
|
networks:
|
||||||
|
traefik_public:
|
||||||
|
external: true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Serving
|
||||||
|
|
||||||
|
### Launch the Linx!
|
||||||
|
|
||||||
|
Launch the Linx stack by running ```docker stack deploy linx -c <path -to-docker-compose.yml>```
|
||||||
|
|
||||||
|
|
||||||
|
[^1]: Since the whole purpose of media/file sharing is to share stuff with **strangers**, this recipe doesn't take into account any sort of authentication using [Traefik Forward Auth](/ha-docker-swarm/traefik-forward-auth/).
|
||||||
|
|
||||||
|
--8<-- "recipe-footer.md"
|
||||||
@@ -97,6 +97,7 @@ Create a docker swarm config file in docker-compose syntax (v3), based on the or
|
|||||||
|
|
||||||
--8<-- "premix-cta.md"
|
--8<-- "premix-cta.md"
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
???+ note "This example is 274 lines long. Click here to collapse it for better readability"
|
???+ note "This example is 274 lines long. Click here to collapse it for better readability"
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -379,7 +380,7 @@ Create a docker swarm config file in docker-compose syntax (v3), based on the or
|
|||||||
!!! note
|
!!! note
|
||||||
Setup unique static subnets for every stack you deploy. This avoids IP/gateway conflicts which can otherwise occur when you're creating/removing stacks a lot. See [my list](/reference/networks/) here.
|
Setup unique static subnets for every stack you deploy. This avoids IP/gateway conflicts which can otherwise occur when you're creating/removing stacks a lot. See [my list](/reference/networks/) here.
|
||||||
|
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
## Serving
|
## Serving
|
||||||
|
|
||||||
|
|||||||
@@ -1,47 +1,50 @@
|
|||||||
hero: Not all heroes wear capes
|
# <///RECIPE NAME>
|
||||||
|
|
||||||
!!! danger "This recipe is a work in progress"
|
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?
|
||||||
This recipe is **incomplete**, and is featured to align the [sponsors](https://github.com/sponsors/funkypenguin)'s "premix" repository with the cookbook. "_premix_" is a private git repository available to [GitHub sponsors](https://github.com/sponsors/funkypenguin), which includes necessary docker-compose and env files for all published recipes. This means that sponsors can launch any recipe with just a ```git pull``` and a ```docker stack deploy``` 👍
|
|
||||||
|
|
||||||
So... There may be errors and inaccuracies. Jump into [Discord](http://chat.funkypenguin.co.nz) if you're encountering issues 😁
|
Want to privately share some log output with a password, or a self-destructing cat picture?
|
||||||
|
|
||||||
# NAME
|
|
||||||
|
|
||||||
Intro
|
[Linx](https://github.com/andreimarcu/linx-server) is self-hosted file/media-sharing service, which features:
|
||||||
|
|
||||||
|
- :white_check_mark: Display common filetypes (*image, video, audio, markdown, pdf*)
|
||||||
|
- :white_check_mark: Display syntax-highlighted code with in-place editing
|
||||||
|
- :white_check_mark: Documented API with keys for restricting uploads
|
||||||
|
- :white_check_mark: Torrent download of files using web seeding
|
||||||
|
- :white_check_mark: File expiry, deletion key, file access key, and random filename options
|
||||||
|
|
||||||
Details
|
|
||||||
|
|
||||||
## Ingredients
|
## Ingredients
|
||||||
|
|
||||||
1. [Docker swarm cluster](/ha-docker-swarm/design/) with [persistent shared storage](/ha-docker-swarm/shared-storage-ceph.md)
|
!!! summary "Ingredients"
|
||||||
2. [Traefik](/ha-docker-swarm/traefik) configured per design
|
Already deployed:
|
||||||
3. DNS entry for the hostname you intend to use, pointed to your [keepalived](/ha-docker-swarm/keepalived/) IP
|
|
||||||
|
* [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
|
||||||
|
|
||||||
|
|
||||||
## Preparation
|
## Preparation
|
||||||
|
|
||||||
### Setup data locations
|
### Setup data locations
|
||||||
|
|
||||||
We'll need several directories to bind-mount into our container, so create them in /var/data/wekan:
|
First we create a directory to hold the data which linx will serve:
|
||||||
|
|
||||||
```
|
```
|
||||||
mkdir /var/data/wekan
|
mkdir /var/data/linx
|
||||||
cd /var/data/wekan
|
|
||||||
mkdir -p {wekan-db,wekan-db-dump}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Prepare environment
|
### Create config file
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
Create wekan.env, and populate with the following variables
|
|
||||||
```
|
```
|
||||||
OAUTH2_PROXY_CLIENT_ID=
|
mkdir /var/data/config/linx
|
||||||
OAUTH2_PROXY_CLIENT_SECRET=
|
cat << EOF > /var/data/config/linx/linx.conf
|
||||||
OAUTH2_PROXY_COOKIE_SECRET=
|
# Refer to https://github.com/andreimarcu/linx-server for details
|
||||||
MONGO_URL=mongodb://wekandb:27017/wekan
|
cleanup-every-minutes = 5
|
||||||
ROOT_URL=https://wekan.example.com
|
EOF
|
||||||
MAIL_URL=smtp://wekan@wekan.example.com:password@mail.example.com:587/
|
|
||||||
MAIL_FROM="Wekan <wekan@wekan.example.com>"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Setup Docker Swarm
|
### Setup Docker Swarm
|
||||||
@@ -51,67 +54,46 @@ Create a docker swarm config file in docker-compose syntax (v3), something like
|
|||||||
--8<-- "premix-cta.md"
|
--8<-- "premix-cta.md"
|
||||||
|
|
||||||
```
|
```
|
||||||
version: '3'
|
version: "3.2" # https://docs.docker.com/compose/compose-file/compose-versioning/#version-3
|
||||||
|
|
||||||
services:
|
services:
|
||||||
|
linx:
|
||||||
wekandb:
|
image: andreimarcu/linx-server
|
||||||
image: mongo:3.2.15
|
env_file: /var/data/config/linx/linx.env
|
||||||
command: mongod --smallfiles --oplogSize 128
|
command: -config /linx.conf
|
||||||
networks:
|
|
||||||
- internal
|
|
||||||
volumes:
|
volumes:
|
||||||
- /var/data/wekan/wekan-db:/data/db
|
- /var/data/linx/:/files/
|
||||||
- /var/data/wekan/wekan-db-dump:/dump
|
- /var/data/config/linx/linx.conf:/linx.conf:ro
|
||||||
|
|
||||||
proxy:
|
|
||||||
image: a5huynh/oauth2_proxy
|
|
||||||
env_file: /var/data/wekan/wekan.env
|
|
||||||
networks:
|
|
||||||
- traefik_public
|
|
||||||
- internal
|
|
||||||
deploy:
|
deploy:
|
||||||
labels:
|
labels:
|
||||||
- traefik_public.frontend.rule=Host:wekan.example.com
|
# traefik common
|
||||||
- traefik_public.docker.network=traefik_public
|
- traefik.enable=true
|
||||||
- traefik_public.port=4180
|
- traefik.docker.network=traefik_public
|
||||||
command: |
|
|
||||||
-cookie-secure=false
|
# traefikv1
|
||||||
-upstream=http://wekan:80
|
- traefik.frontend.rule=Host:linx.example.com
|
||||||
-redirect-url=https://wekan.example.com
|
- traefik.port=8080
|
||||||
-http-address=http://0.0.0.0:4180
|
|
||||||
-email-domain=example.com
|
# traefikv2
|
||||||
-provider=github
|
- "traefik.http.routers.linx.rule=Host(`linx.example.com`)"
|
||||||
|
- "traefik.http.routers.linx.entrypoints=https"
|
||||||
|
- "traefik.http.services.linx.loadbalancer.server.port=8080"
|
||||||
|
|
||||||
wekan:
|
|
||||||
image: wekanteam/wekan:latest
|
|
||||||
networks:
|
networks:
|
||||||
- internal
|
- traefik_public
|
||||||
env_file: /var/data/wekan/wekan.env
|
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
traefik_public:
|
traefik_public:
|
||||||
external: true
|
external: true
|
||||||
internal:
|
|
||||||
driver: overlay
|
|
||||||
ipam:
|
|
||||||
config:
|
|
||||||
- subnet: 172.16.3.0/24
|
|
||||||
```
|
```
|
||||||
|
|
||||||
!!! note
|
|
||||||
Setup unique static subnets for every stack you deploy. This avoids IP/gateway conflicts which can otherwise occur when you're creating/removing stacks a lot. See [my list](/reference/networks/) here.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Serving
|
## Serving
|
||||||
|
|
||||||
### Launch Wekan stack
|
### Launch the Linx!
|
||||||
|
|
||||||
Launch the Wekan stack by running ```docker stack deploy wekan -c <path -to-docker-compose.yml>```
|
Launch the Linx stack by running ```docker stack deploy linx -c <path -to-docker-compose.yml>```
|
||||||
|
|
||||||
Log into your new instance at https://**YOUR-FQDN**, with user "root" and the password you specified in gitlab.env.
|
|
||||||
|
|
||||||
[^1]: If you wanted to expose the Wekan UI directly, you could remove the oauth2_proxy from the design, and move the traefik_public-related labels directly to the wekan container. You'd also need to add the traefik_public network to the wekan container.
|
[^1]: Since the whole purpose of media/file sharing is to share stuff with **strangers**, this recipe doesn't take into account any sort of authentication using [Traefik Forward Auth](/ha-docker-swarm/traefik-forward-auth/).
|
||||||
|
|
||||||
--8<-- "recipe-footer.md"
|
--8<-- "recipe-footer.md"
|
||||||
+15
-12
@@ -25,6 +25,8 @@ plugins:
|
|||||||
- git-revision-date-localized:
|
- git-revision-date-localized:
|
||||||
type: date
|
type: date
|
||||||
- autolinks
|
- autolinks
|
||||||
|
- macros:
|
||||||
|
verbose: true
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -104,6 +106,7 @@ nav:
|
|||||||
- OIDC Provider: recipes/keycloak/setup-oidc-provider.md
|
- OIDC Provider: recipes/keycloak/setup-oidc-provider.md
|
||||||
- OpenLDAP: recipes/keycloak/authenticate-against-openldap.md
|
- OpenLDAP: recipes/keycloak/authenticate-against-openldap.md
|
||||||
- Komga: recipes/komga.md
|
- Komga: recipes/komga.md
|
||||||
|
- Linx: recipes/linx.md
|
||||||
- Minio: recipes/minio.md
|
- Minio: recipes/minio.md
|
||||||
- OpenLDAP: recipes/openldap.md
|
- OpenLDAP: recipes/openldap.md
|
||||||
- OwnTracks: recipes/owntracks.md
|
- OwnTracks: recipes/owntracks.md
|
||||||
@@ -150,24 +153,22 @@ nav:
|
|||||||
- Chef's Favorites:
|
- Chef's Favorites:
|
||||||
- Kanboard: recipes/kubernetes/kanboard.md
|
- Kanboard: recipes/kubernetes/kanboard.md
|
||||||
- Miniflux: recipes/kubernetes/miniflux.md
|
- Miniflux: recipes/kubernetes/miniflux.md
|
||||||
- 🍰 Get Premix!:
|
- 🚀 Get Premix!:
|
||||||
- Start: premix.md
|
- Start: premix.md
|
||||||
- Ansible:
|
- Ansible:
|
||||||
- Operation: premix/ansible/operation.md
|
- Operation: premix/ansible/operation.md
|
||||||
- Design: premix/ansible/design.md
|
- Design: premix/ansible/design.md
|
||||||
- Swarm: premix/swarm.md
|
- Swarm: premix/swarm.md
|
||||||
- Kubernetes: premix/kubernetes.md
|
- Kubernetes: premix/kubernetes.md
|
||||||
- CHANGELOG:
|
- CHANGELOG: CHANGELOG.md
|
||||||
- Start: CHANGELOG.md
|
- Support: support.md
|
||||||
- Support:
|
- Contribute: community/contribute.md
|
||||||
- Start: support.md
|
|
||||||
- Contribute:
|
|
||||||
- Start: community/contribute.md
|
|
||||||
- Community:
|
- Community:
|
||||||
- Code of Conduct: community/code-of-conduct.md
|
- Discord: community/discord.md
|
||||||
- Support: support.md
|
- Support: support.md
|
||||||
- Contribute: community/contribute.md
|
- Contribute: community/contribute.md
|
||||||
- Discord: community/discord.md
|
- Code of Conduct: community/code-of-conduct.md
|
||||||
|
|
||||||
# # - Discourse: community/discourse.md
|
# # - Discourse: community/discourse.md
|
||||||
# # - GitHub: community/github.md
|
# # - GitHub: community/github.md
|
||||||
|
|
||||||
@@ -231,14 +232,16 @@ google_analytics:
|
|||||||
- 'UA-139253-18'
|
- 'UA-139253-18'
|
||||||
- 'auto'
|
- 'auto'
|
||||||
|
|
||||||
extra_css:
|
# extra_css:
|
||||||
- 'stylesheets/mailchimp.css'
|
|
||||||
|
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
- 'extras/javascript/discord.js'
|
- extras/javascript/discord.js
|
||||||
|
- extras/javascript/sortable-tables.js
|
||||||
|
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
|
||||||
|
|
||||||
# Extensions
|
# Extensions
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
|
- attr_list
|
||||||
- admonition
|
- admonition
|
||||||
- codehilite:
|
- codehilite:
|
||||||
linenums: true
|
linenums: true
|
||||||
|
|||||||
+2
-1
@@ -5,4 +5,5 @@ Markdown>=3.0.1
|
|||||||
mkdocs-minify-plugin>=0.2
|
mkdocs-minify-plugin>=0.2
|
||||||
mkdocs-autolinks-plugin>=0.2.0
|
mkdocs-autolinks-plugin>=0.2.0
|
||||||
mkdocs-htmlproofer-plugin>=0.0.3
|
mkdocs-htmlproofer-plugin>=0.0.3
|
||||||
mkdocs-git-revision-date-localized-plugin>=0.4.8
|
mkdocs-git-revision-date-localized-plugin>=0.4.8
|
||||||
|
mkdocs-macros-plugin
|
||||||
Reference in new issue
Block a user