brianpooe/homelab-blueprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
homelab-blueprint/README.md
Brian Pooe 708f260cfc Standardize stack deployment guides
2026-06-15 10:53:29 +02:00

2.3 KiB
Raw Blame History

Homelab Blueprint

Docker Compose templates and deployment guides for self-hosted services.

Quick Start

Run repository commands from the project root:

cp -n .env.sample .env

Configure .env, then follow the README for the stack you want to deploy. Each guide explains appdata placement, template rendering, startup, verification, networking, troubleshooting, and backup.

Stacks

Stack Description
Arr Stack Media management, downloads, VPN, Emby, and Recyclarr
Beszel Agent Host and Docker monitoring agent
Beszel Socket Proxy Restricted Docker API access for Beszel
Caddy Reverse proxy with Cloudflare DNS-01
Gramps Web Genealogy web application
Home Assistant Home Assistant, Mosquitto, and Zigbee2MQTT
Node-RED Flow automation with Home Assistant integration
PostgreSQL PostgreSQL and pgAdmin
Technitium DNS DNS server and ad blocking
Vault HashiCorp Vault secrets management

Shared Commands

Most stacks use the following pattern:

./substitute_env.sh docker-compose-files/<stack>/template.yaml docker-compose.<stack>.yml .env
docker compose -f docker-compose.<stack>.yml config --quiet
docker compose -f docker-compose.<stack>.yml up -d

Home Assistant and Node-RED use their setup scripts instead. Arr Stack, Caddy, and Gramps Web render additional configuration templates.

Requirements

  • Linux host with Docker Engine and Docker Compose
  • Git
  • A configured .env based on .env.sample
  • Service-specific storage and network access described in each stack README

Generated docker-compose.*.yml files may contain secrets and are ignored by Git.

Operational Documentation