geek-cookbook/.github/ISSUE_TEMPLATE/recipe-request.md

name, about, title, labels

name	about	title	labels
🍰 Request a recipe!	I have a request for a fresh recipe 😋	[recipe]	recipe/request, status/backlog, good first issue

• 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:
• Project homepage:
• 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.