25 lines
768 B
Markdown
25 lines
768 B
Markdown
# Homelab Docs (private / full runbook)
|
|
|
|
Source of truth for the Frostlabs homelab. Plain Markdown, rendered with
|
|
MkDocs Material, built and deployed by Gitea Actions on every push to `main`.
|
|
|
|
- **Edit** files under `docs/`, `git push`, done. CI builds and deploys.
|
|
- **Live site:** https://runbook.frostlabs.me (gated by Cloudflare Access)
|
|
- **Public portfolio subset:** separate repo → https://docs.frostlabs.me
|
|
|
|
## Local preview
|
|
```bash
|
|
python -m venv .venv && . .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
mkdocs serve # http://127.0.0.1:8000
|
|
```
|
|
|
|
## Repo layout
|
|
```
|
|
docs/
|
|
network/ topology, VLANs, firewall <- first real content
|
|
services/ what runs where
|
|
runbooks/ step-by-step recovery procedures
|
|
hardware/ physical inventory
|
|
```
|