homelab-blueprint/docs/README.md
Brian Pooe 1815beadf4 refactor: restructure docs, sync stacks with Caddyfile, harden compose templates
- Add compose stacks for apps already proxied by Caddy: bento-pdf,
  it-tools, paperless-ngx, and beszel-hub (with Makefile targets)
- Remove the unused Vault stack and the drawio Caddyfile block
- Fix Caddyfile gramps upstream to port 80 to match the compose file
- Bring immich and gramps-web up to the shared template pattern
  (no-new-privileges, log rotation, memory limits, healthchecks)
- Single-quote vaultwarden SSO_AUDIENCE_TRUSTED so regex values like
  ^\d{18}$ render as valid YAML
- Move root docs into kebab-case topic folders, rebuild the docs index
  to cover every doc, and fix all broken links
2026-07-03 17:45:16 +02:00

34 lines
1.6 KiB
Markdown

# Documentation
Operational documentation, grouped by topic. For per-stack installation
guides, see the [Stacks table in the root README](../README.md#stacks).
## Arr Stack
- [Deployment](arr-stack/deployment.md): UNAS NFS, Proxmox LXC, permissions, and hardlinks.
- [Recyclarr](arr-stack/recyclarr.md): Recyclarr configuration and sync workflow.
## Proxmox
- [NVMe storage layout](proxmox/storage-layout.md): Fresh-install named storage layout for OS files and VM/LXC disks.
- [LXC boot dependencies](proxmox/nfs-lxc-boot-dependency.md): Making NFS mounts and NVIDIA device nodes ready before LXCs start.
- [NVIDIA GPU passthrough](nvidia/proxmox-nvidia-lxc.md): Host -> LXC -> Docker for hardware transcoding.
## Network
- [Firewall rules](network/firewall-rules.md): Custom UniFi firewall rules, target IPs, ports, and stateful return traffic.
- [Caddy firewall policies](network/allow-caddy-to-apps.md): Zone policies that allow the Caddy DMZ host to reach apps on other VLANs.
- [Rack layout](network/rack-layout.md): Current UNAS and MikroTik rack layout.
## UNAS Storage
- [NFS and SMB mounts](unas/nfs-mounts.md): Persistent UniFi Drive share mounts on Proxmox and LXC bind mounts.
- [In-pool share move](unas/in-pool-reflink-move.md): Move large folders between UniFi Drive shares using Btrfs reflinks without duplicating data.
## Immich
- [Mobile sync](immich/mobile-sync.md): Phone -> NAS -> external library sync that avoids re-upload after server-side deletes.
## Troubleshooting
- [Troubleshooting guide](troubleshooting.md): Common stack issues and recovery steps.