1.7 KiB
Executable File
1.7 KiB
Executable File
SJHL Documentation
Welcome to Seirian & James' homelab documentation! This is a docs site that is built to easily show all the configs we use. MOst of the content is auto-generated from the actual config files, so it should always be up to date. This should be completely publically viewable as all private information is kept in .env files that are not committed to Git. It should provide good information on how to recover and rebuild the homelab if needed, and also just be a nice reference for how everything is configured.
Data Classification
| Type | Example | Git Repo? | Backup? | Location |
|---|---|---|---|---|
| Source Configs | docker-compose.yml, .env.example, Makefile |
Yes | No | /srv/homelab-infra |
| Service Secrets | .env (DB passwords, API keys) |
No | Yes | /srv/homelab-infra/<service>/.env |
| Runtime Configs | acme.json, service configs |
No | Yes | /mnt/storage/docker-data/<service> |
| Persistent Data | DB data, uploads, media | No | Yes | /mnt/storage/docker-data/<service> |
Services
| Service | Image | Status |
|---|---|---|
| devbox | devbox-devcontainer |
active |
| gitea | gitea/gitea:1.24.3 |
active |
| nextcloud | ghcr.io/nextcloud-releases/all-in-one:latest |
active |
| obsidian-livesync | couchdb:latest |
active |
| traefik | traefik:v3.6 |
active |
| whoami | traefik/whoami |
active |
Quick Start
cp .env.example .env
for svc in */; do [ -f "$svc/.env.example" ] && cp "$svc/.env.example" "$svc/.env"; done
docker network create web
make up