Adding a Service
Checklist for deploying a new service to the homelab.Steps
-
Create the directory:
mkdir ~/apps/<service> -
Write
compose.yamlwith:user: "1000:1000"- Traefik labels (if on i3) or exposed port (if on Pentium)
networks: [traefik](i3 only)- Volume mounts for persistent data
-
Create
.envwith any secrets (API keys, passwords). These are gitignored. -
Traefik routing:
- i3 services: add Docker labels in compose.yaml
- Pentium services: add entry to
traefik/dynamic/pentium-services.yaml
-
Cloudflare DNS: add a CNAME record for
<service>.augustin.ai→ tunnel -
Start it:
docker compose -f <service>/compose.yaml up -d -
Homepage: add entry to
homepage/config/services.yaml - Uptime Kuma: add a monitor for the service URL
- Backups: ensure the data directory is included in the restic backup script
- Documentation: add a doc page under the appropriate service category
Traefik Labels (i3)
Pentium Routing
Add totraefik/dynamic/pentium-services.yaml on i3: