Homelab Documentation¶
Owner: Joshua Carmack Purpose: Recovery, rebuild, long-term maintainability
This repository documents the entire homelab setup with the assumption that everything may need to be rebuilt from scratch.
If it's not documented, it doesn't exist. If it's not backed up, it will be lost.
Quick Navigation¶
Current State & Planning¶
- Current State - What's deployed right now
- Quick Reference - IPs, URLs, key commands
- Hardware Inventory - All physical hardware
- Architecture - Design goals and server roles
- Changelog - All significant changes and decisions
- Lessons Learned - What worked, what didn't
Servers¶
Network¶
- Network Architecture - Topology, firewall, routing
Services¶
- Services Overview - All running services
- Home Assistant
- Uptime Kuma
- Grafana
- Prometheus
- Zabbix
- Jellyfin
- Caddy
- Tailscale
Recovery¶
Documentation Goals¶
- Recovery-grade: Sufficient to rebuild everything from scratch
- Single source of truth: Each piece of information lives in one place
- Decision tracking: Document WHY, not just WHAT
- Living document: Updated as your homelab evolves
- Version controlled: All changes tracked in git