• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

• Project homepage: https://mattermost.com/
• Docker image: repository/image
• Subreddit (optional): https://reddit.com/r/mattermost

📝 Instructions

https://docs.mattermost.com/install/prod-docker.html

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

Polr is an intrepid, self-hostable open-source link shortening web application with a robust API. It allows you to host your own URL shortener, to brand your URLs, and to gain control over your data. Polr is especially easy to use, and provides a modern, themable feel.

• Project homepage: https://github.com/Cydrobolt/polr
• Docker image: repository/image
• Subreddit (optional): https://reddit.com/r/selfhosted

📝 Instructions

There's a 6-year-old Dockerfile at https://github.com/cydrobolt/docker-polr, I'm not sure that's the best place to start though

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

Now that I've enabled the attr_list markdown plugin, we can append {: loading=lazy } to any images to "lazyload" them, hopefully decreasing the page load time and getting some extra pagespeed points!

We need a recipe page to document the steps required to set up Duplicati for those that wish to use it as their backup solution.

Given I'm the biggest culprit for stale issues, I'll add https://github.com/actions/stale to the repo to close out any stale issues/PRs :)

It's impractical to maintain 2 source trees, one for the leanpub manuscript. Leanpub has some requirements around document structure - all content goes into manuscript/. It should be possible to alter mkdocs to use manuscript as the source tree, thereby combining sources for leanpub book and geek-cookbook website.

Sent by @funkypenguin ([email protected]). Created by fire.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

• Project homepage: https://github.com/Coderior/lovingmemory
• Docker image:
• Community (optional):

📝 Instructions

< upstream docker compose / install instructions go here >

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

• Project homepage: https://github.com/gchq/CyberChef
• Docker image: mpepping/cyberchef

📝 Instructions

Nothing special upstream, just a container listening on port 8080, with no local storage

🖼 Live Demo!

A live demo can be found at https://gchq.github.io/CyberChef/

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

After reports of the gitlab recipe not working any more, I'll recreate the recipe and confirm whether or not it still works with the original config, or whether it needs to be updated.

Per https://gist.github.com/marianopw/58ca3f8a6b14123831b517ccd08c8b34

Currently, the syslog on the atomic hosts is too noisy, very hard to identify what's good/bad. Look into options to collect and display all stack logs.

Per the excellent example submitted by @ambroisemaupate, I'll update https://geek-cookbook.funkypenguin.co.nz/recipes/gitlab/ to use official omnibus container now, plus all the traefik tweaks documented at https://github.com/ambroisemaupate/docker-server-env/blob/master/compose/example-gitlab-traefik/docker-compose.yml

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

One time read messaging system. You can try it at viacry.pt.

• Project homepage: https://github.com/vialink/viacrypt
• Docker image: https://hub.docker.com/r/shyper/viacrypt/dockerfile
• Community (optional):

📝 Instructions

< upstream docker compose / install instructions go here >

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

I was looking at your traefik forward-auth recepie as it's one of the simpler ways to implement forward-auth, especially because you can use docker labels.

Do you know of any way to exclude certain paths using this method? Sonarr/Radarr/Lidarr for example rely on /api and /feed (calendar) being accessible without external authentication (api key is used).

I was looking at traefik v2.0 documentation, as it seems the new version will improve authentication and other middleware. However I wasn't able to find anything that would allow for this specific usecase.

If you have interest in looking at authentication again, this project could be interesting: https://github.com/travisghansen/external-auth-server

Thanks for the great resources!

test

Docker Compose for traefik-app.yml (https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/traefik/) needs updating to version 3.2 to avoid error message 'services.traefik.ports.0 must be a string or number'

moby/moby#32202

Find bot (or make one) To post RSS feed to #socialfeed Or #changelogs
Or maybe even webhook? (Not sure if its possible)

SimpleLogin is an open source, self-hostable email alias solution to protect your email address. It's best used together with a password manager like Bitwarden.

I wonder if we could add it into the cookbook?

Its github repo is https://github.com/simple-login/app

Add discord widget (maybe to support page)

Sed rules are not working (not removing broken emoji from preview)

https://geek-cookbook.funkypenguin.co.nz/ha-docker-swarm/vms/ is broken: The tips are missing.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

Plausible Analytics is a simple, lightweight (< 1 KB), open-source and privacy-friendly alternative to Google Analytics. It doesn’t use cookies and is fully compliant with GDPR, CCPA and PECR. You can self-host Plausible or have us run it for you in the Cloud.

• Project homepage: https://plausible.io/
• Docker image: https://hub.docker.com/r/plausible/analytics
• Community (optional): https://github.com/plausible/analytics/discussions

📝 Instructions

Instructions for self-hosting are at https://plausible.io/docs/self-hosting

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

Readers may want to request new recipies, or contribute fixes. Add details to navigation / README to cover this

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

• Project homepage: https://github.com/hay-kot/mealie
• Docker image: https://hub.docker.com/repository/docker/hkotel/mealies
• Community (optional):

📝 Instructions

< upstream docker compose / install instructions go here >

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

There are some beautiful metrics available for GH repos at https://github.com/lowlighter/metrics - it may be interesting to self-host a copy of the generator tool (below)

• Project homepage: https://github.com/lowlighter/metrics
• Docker image: repository/image
• Subreddit (optional): https://reddit.com/r/selfhosted

📝 Instructions

< upstream docker compose / install instructions go here >

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

As @dskaggs pointed out, theres's no "README" for the Discord server, so some users may be unaware of conventions/features.

This issue tracks the addition of a Discord README page to the cookbook, as well as a bot command to trigger a link (!readme ?)

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

Searx is a privacy-respecting metasearch engine, aggregating the results of other search engines while not storing information about its users. It's primary utility to me is the ability to create "saved searches" as RSS feeds, which can then be scraped using something like Huginn.

• Project homepage: https://github.com/searx/searx
• Docker image: https://hub.docker.com/r/searx/searx

📝 Instructions

A "batteries included" docker-compose file can be found at https://github.com/searx/searx-docker/blob/master/docker-compose.yaml

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

Sent by @funkypenguin ([email protected]). Created by fire.

Cant' have registry without traefik.

But can have traefik without registry.

Let's address the following feedback from https://www.reddit.com/r/usenet/comments/7j9hdr/sabnzbd_and_friends_in_a_secure_ha_docker_swarm/dr6wlvm/

I think it would be a good idea to review your ordering on the recipe and structure of files. For example, I followed the Essentials section from top to bottom which meant I was trying to set up the docker-mailserver on the swarm before I had followed the instructions to actually init the swarm 😛 You’ve also explained your file structure well but you havent followed it in the traefik section (toml file is in /var/data/traefik but seems like it should go in /var/data/config/traefik). For traefik, your premix repo does make use of the config file structure but it then mentions an env file which I couldn’t find anywhere so I just stuck to your website recipe.
It would be good to go into a bit more detail for people like me (experience in usenet automation but docker/traefik/lets encrypt/oauth noob). For example:
the acme.json file needs 600 permissions
get ALL of your subdomains setup on your dns/hosting provider before starting
open all the required ports on your router before starting (sounds obvious I know but coming from a non-docker experience, services would start and be accessible locally without port forwarding whereas with docker, some services just refused to start at all)
when setting up oauth, you have to make up a cookie secret to go with the provided client ID/secret or else it wont work

As suggested in Discord - https://github.com/omarroth/invidious

In the Setup environment section the following line is missing an 's'
old:

COOKIE_DOMAIN=<the root FQDN of your domain>

new:

COOKIE_DOMAINS=<the root FQDN of your domain>

As suggested in Discord, this would be an interesting addition to the cookbook: https://github.com/crazy-max/docker-anonaddy

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

Description

Authelia is an open-source authentication and authorization server providing 2-factor authentication and single sign-on (SSO) for your applications via a web portal. It acts as a companion of reverse proxies like nginx, Traefik or HAProxy to let them know whether queries should pass through. Unauthenticated users are redirected to Authelia Sign-in portal instead.

• Project homepage: https://github.com/authelia/authelia
• Docker image: https://hub.docker.com/r/authelia/authelia
• Community (optional): https://discord.authelia.com/

📝 Instructions

Upstream compose files (of varying complexity) can be found here: https://github.com/authelia/authelia/tree/master/compose

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

• Project homepage: https://github.com/ArchiveBox/ArchiveBox/releases
• Docker image:
• Community (optional):

📝 Instructions

< upstream docker compose / install instructions go here >

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your own personal, searchable and extensible wiki.

• Project homepage: https://archivy.github.io/
• Docker image: repository/image
• Subreddit (optional): https://reddit.com/r/selfhosted

📝 Instructions

Nice-looking docs available at https://archivy.github.io/docker/

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

• Project homepage: https://my-project-page
• Docker image: repository/image
• Subreddit (optional): https://reddit.com/r/selfhosted

📝 Instructions

Official compose file is https://github.com/tootsuite/mastodon/blob/master/docker-compose.yml, and there's another one at https://gist.github.com/fredix/6ef5c95c600dbbb9afc0e0538a93d90d

< upstream docker compose / install instructions go here >

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

RSS-Bridge is a PHP project capable of generating RSS and Atom feeds for websites that don't have one. It can be used on webservers or as a stand-alone application in CLI mode.

• Project homepage: https://github.com/RSS-Bridge/rss-bridge
• Docker image: https://hub.docker.com/r/rssbridge/rss-bridge

📝 Instructions

< upstream docker compose / install instructions go here >

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

linx - a self-hosted version of imgur and pastebin

• Project homepage: https://github.com/andreimarcu/linx-server
• Docker image: andreimarcu/linx-server

📝 Instructions

version: '2.2'
services:
  linx-server:
    container_name: linx-server
    image: andreimarcu/linx-server
    command: -config /data/linx-server.conf
    volumes:
      - /path/to/files:/data/files
      - /path/to/meta:/data/meta
      - /path/to/linx-server.conf:/data/linx-server.conf
    network_mode: bridge
    ports:
      - "8080:8080"
    restart: unless-stopped

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. I'd be happy exposing it to the internet
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

Greetings, fire here!

@funkypenguin recently invited @fire-bot to this repository. Before fire is enabled, @funkypenguin needs to complete a few steps:

Complete fire setup now

Only @funkypenguin will be able to enable fire using the above link. If someone added fire by mistake, feel free to remove @fire-bot from your repo's collaborators.

Already in pre-mix, will update public recipe accordingly.

Ref https://discourse.geek-kitchen.funkypenguin.co.nz/t/traefik-funky-penguins-geek-cookbook/59/24

• Recipe Request
  • 💬 Summary
  • 📝 Instructions
  • 🖼 Screenshot
• Checklist
  • ☑️ Prerequisites
  • 👮‍♂️ Access Control
  • ⚙️ Config Management
  • 🪠 Connectivity
  • 💾 Data Management
  • 🪂 Backup
  • 🤹‍♀️ Orchestration Platform
  • 💍 Engagement
• What's next?

Recipe Request

💬 Summary

• Project homepage: https://hedgedoc.org/
• Docker image: https://github.com/hedgedoc/container (hosted on quay.io)
• Community (optional): https://community.hedgedoc.org/

📝 Instructions

https://github.com/hedgedoc/container/blob/master/docker-compose.yml

🖼 Screenshot

Checklist

☑️ Prerequisites

First, some house-keeping. Review closed issues and PRs, and confirm that this recipe hasn't already been proposed, deprecated, or duplicated before. Also confirm that the application itself is not abandoned.

• I have searched and confirmed no existing open or closed issues/PRs for this app
• The app is actively supported by its developers (i.e., not deprecated)

👮‍♂️ Access Control

Does the app provide its own authentication (i.e. NextCloud), or does it require an authentication frontend (i.e., Radarr)?

How should access to the app be managed?

• The app provides its own, trustworthy authentication, or access control is unnecessary. (I'd be happy exposing it to the internet)
• The app needs something in front of it to secure access (traefik-forward-auth, authelia, etc)

⚙️ Config Management

How is the app configured? Some applications are configured entirely using environment variables, some need static config files mounted into their container, and some are configured using an interactive setup process (i.e. NextCloud).

• Environment variables
• Command-line options
• Static config file
• Interactive setup which then persists the config somewhere to the filesystem

🪠 Connectivity

What sort of network connectivity does the app need?

• None
• Requires inbound web access HTTP/S access
• Requires inbound arbitrary TCP/UDP access
• Requires connectivity to other apps

💾 Data Management

What sort of persisted data does the app need?

• The app needs access to its own persistent data (i.e. logs, database directory, etc)
• The app needs access to outside data (i.e. Plex)
• The app needs access to another app's data

🪂 Backup

How is backup of the app's data to be handled?

• Backup is unnecessary
• A simple file-based copy of the app's data folders will suffice
• A process is required to create backups for a file-based copy (i.e., a mysql database dump)
• A custom backup/restore process is required (provide details below)

🤹‍♀️ Orchestration Platform

Which platform(s) are you interested in a recipe supporting?

• Docker Swarm (via docker-compose files)
• Docker Swarm (via premix ansible deploy)
• Kubernetes (via a helm chart)

💍 Engagement

I'm willing to:

• Submit a PR for the recipe
• Test the recipe
• Engage the community on Q&A for the recipe

What's next?

What happens next? 🙋‍♂️

Seek buy-in from the community, to indicate whether the recipe is a good fit for the cookbook or not.

The kanboard recipe currently does not include a cron, and so daily tasks (like auto-closing completed tasks) are not executed. Further, the kanboard stack would benefit from the addition of an (optional) oauth_proxy instance protecting its SSL login, although cognisance should be taken of how this would affect external webhooks for stuff like incoming email for task creation.

Panel

Weird symbol + panel

Weird symbol in book #3

Weird symbol in book #2

Weird symbol in book

Panels are not supported in books

@gkoerk in Discord has proposed an implementation of Auth0, which requires only a single oauth (instead of the current design of an oauth per service). I will review and create an updated recipe / snippet to retroactively apply to existing recipes

Sent by @funkypenguin ([email protected]). Created by fire.

Add a recipe for TTRSS