Documentation for the home lab
Go to file
Christopher Darrigo 46cb1fadb9 First Commit 2025-07-11 16:45:09 -04:00
README.md First Commit 2025-07-11 16:45:09 -04:00
cloudflare-full.md First Commit 2025-07-11 16:45:09 -04:00
flaresolverr_complete.md First Commit 2025-07-11 16:45:09 -04:00
home-assistant-complete.md First Commit 2025-07-11 16:45:09 -04:00
homelab-graph.png First Commit 2025-07-11 16:45:09 -04:00
homelab-hardware-full.md First Commit 2025-07-11 16:45:09 -04:00
homelab-inventory-map.md First Commit 2025-07-11 16:45:09 -04:00
immich_complete.md First Commit 2025-07-11 16:45:09 -04:00
jackett_complete.md First Commit 2025-07-11 16:45:09 -04:00
nextcloud-aio.md First Commit 2025-07-11 16:45:09 -04:00
pihole-complete.md First Commit 2025-07-11 16:45:09 -04:00
plex_complete.md First Commit 2025-07-11 16:45:09 -04:00
proxmox04-complete.md First Commit 2025-07-11 16:45:09 -04:00
qbittorrent_complete.md First Commit 2025-07-11 16:45:09 -04:00
radarr_complete.md First Commit 2025-07-11 16:45:09 -04:00
sonarr_complete.md First Commit 2025-07-11 16:45:09 -04:00

README.md

Homelab Service Documentation Index

This repository contains Markdown-based documentation for each core service running in the homelab. Each document includes details such as IP address, container ID, ports, platform, backup and monitoring plans, and configuration paths.

📄 Service Docs

📦 Format Standard

Each file includes:

  • Overview & purpose
  • Container ID, IP, ports, domain
  • Config paths & storage
  • Authentication & credentials
  • Backup & restore strategy
  • Monitoring/logging details
  • Setup method & Docker image

🔐 Credentials

All credentials are stored in Bitwarden under the homelab folder.

🔄 Backup Strategy

ZFS snapshots used for persistent volumes. Daily snapshot rotation is planned for critical services like Nextcloud and Plex.

📊 Monitoring

Monitoring stack planned using Uptime Kuma and Prometheus/Grafana.


Managed and maintained by ChatGPT Homelab Project Documentation