Homelab Docs

Markdown-documentatie van het Proxmox-thuisnetwerk. Bruikbaar als:

1. Naslag — lees docs/ direct.
2. Website op help.stijnjanssen.nl — MkDocs Material.
3. Kennisbasis voor een help-bot — platte MD, ideaal voor zoeken/RAG.

Structuur

docs/
├─ index.md              overzicht + snelle kaart
├─ architecture.md       het grote plaatje
├─ netwerk.md            router, DNS, port forwarding, verkeersstromen
├─ proxmox.md            host, storage, VM's, opstartvolgorde
├─ diensten/            per dienst: adguard, npm, nextcloud, immich, bots
├─ procedures/          nieuwe-webapp, herstel, backups
├─ woordenlijst.md
└─ troubleshooting.md

Lokaal bekijken

pip install mkdocs-material
mkdocs serve            # http://127.0.0.1:8000

Publiceren op help.stijnjanssen.nl

Als Docker-stack op de Webservices VM (zelfde patroon als andere sites):

scp -r homelab-docs stijn@192.168.1.150:/opt/stacks/help
cd /opt/stacks/help
docker compose up -d --build

Daarna in NPM een Proxy Host: help.stijnjanssen.nl → http → help-docs:80, certificaat aanvragen. AdGuard-rewrite help.stijnjanssen.nl → 192.168.1.150 en publiek A-record help → <WAN IPv4> (geen AAAA).

Bij elke doc-wijziging: git pull && docker compose up -d --build — de site wordt in de image gebouwd (mkdocs build --strict).

Help-bot (later)

De MD-bestanden zijn de bron. Een help-bot kan ze indexeren (embeddings) en vragen beantwoorden met verwijzing naar de juiste pagina. Bewaar bots in de tgbots-repo, patroon identiek aan de bestaande bots (long polling, whitelist).