Files
truenas-stacks/docs/README.md
Fizzlepoof 493f3253b8
Some checks failed
secret-guardrails / artifact-secret-scan (push) Has been cancelled
secret-guardrails / gitleaks (push) Has been cancelled
docs: add Serenity cleanup wave 1 plan
2026-05-25 18:55:29 +00:00

51 lines
2.7 KiB
Markdown

# Homelab Documentation
Central index for all homelab infrastructure documentation.
## Servers
| File | Description |
|------|-------------|
| [PlausibleDeniability](servers/PLAUSIBLEDENABILITY.md) | Primary Docker host — TrueNAS Scale, RTX 2080 Ti |
| [Serenity](servers/SERENITY.md) | NAS + media ingestion — Unraid, dual Xeon X5690 |
| [N.O.M.A.D.](servers/NOMAD.md) | Offline knowledge / game servers — Ubuntu, GTX 1080 |
| [Rocinante](servers/ROCINANTE.md) | Heavy AI inference — RTX 4090 |
## Architecture
| File | Description |
|------|-------------|
| [Architecture Overview](architecture/ARCHITECTURE_OVERVIEW.md) | Full stack diagram and service map |
| [Services Directory](architecture/SERVICES_DIRECTORY.md) | All services with hosts, ports, and status |
| [Networking Model](architecture/NETWORKING_MODEL.md) | VLANs, firewall policy, DHCP DNS, and remote access |
| [PD Future-State Topology](architecture/pd-future-state-topology.html) | Visual target-state diagram for the PD rebuild, cyber VM lane, and Serenity retirement |
| [AI Services Network](architecture/AI_SERVICES_NETWORK.md) | Cross-stack Docker networking for AI services |
## Stacks
| File | Description |
|------|-------------|
| [AI Stack](stacks/AI_STACK.md) | LiteLLM, OpenWebUI, Qdrant, Whisper, SearXNG |
| [Media Stack](stacks/MEDIA_STACK.md) | Plex, Tautulli, Audiobookshelf, Calibre |
| [Home Automation](stacks/HOME_AUTOMATION.md) | Home Assistant, KitchenOwl, DoneTick |
| [Infrastructure](stacks/INFRASTRUCTURE.md) | Homepage, Uptime Kuma, Gitea, Gotify |
## Planning
| File | Description |
|------|-------------|
| [Expansion Plan](planning/HOMELAB_EXPANSION_PLAN.md) | 6-phase buildout — all phases complete as of 2026-05-06 |
| [PD Future-State Architecture](planning/PD_FUTURE_STATE_ARCHITECTURE.md) | Target-state host layout, storage model, cyber VM policy, and Serenity retirement path |
| [Serenity Docker Audit](planning/SERENITY_DOCKER_AUDIT.md) | Live-audited keep/move/retire container baseline for Serenity cleanup |
| [Serenity Cleanup Wave 1](planning/SERENITY_CLEANUP_WAVE_1.md) | First safe cleanup pass: legacy Pi-hole removal, stale container pruning, and DB-app migration ordering |
| [TODO](planning/TODO.md) | Active and backlog tasks |
## Operations
| File | Description |
|------|-------------|
| [DNS Resilience](operations/DNS_RESILIENCE.md) | Technitium backup-node topology, PD sync automation, fallback semantics, and validation SOP |
| [Backup Policy](operations/BACKUP_POLICY.md) | Backup scope, database dumps, and restore cadence |
| [PD Backup Deployment](operations/PD_BACKUP_DEPLOYMENT.md) | Live PD backup runner deployment details |
| [Secrets Management](operations/SECRETS_MANAGEMENT.md) | `.env` handling, encrypted backups, and incident guardrails |