Homelab Documentation
Comprehensive documentation for the homelab infrastructure and services.
For a full navigation guide with every doc and recent updates, see INDEX.md.
📁 Structure at a Glance
🚀 Getting Started
- Beginner Quickstart - Initial setup
- Docker Compose Guide - Compose basics
- FAQ - Quick answers
- Getting Started Directory - Full walkthroughs
🏗️ Infrastructure
🖥️ Hosts
- Host Overview - Per-host details
- Jellyfish, Setillo - Dedicated host docs
🔧 Services
- Verified Service Inventory
- Individual Services - Service-specific docs (dashboard, olares, anythingllm, holyclaude, …)
- arr-suite Language Config
👨💼 Administration
- Deployment Workflow
- GitOps Deployment Guide
- GitOps Comprehensive Guide
- Monitoring Setup
- Ansible Playbook Guide
- ntfy Notification System
- Operational Status
- AI Integrations
- Secrets Management
🚨 Troubleshooting
🎓 Advanced Topics
📊 Other
- Diagrams - Mermaid + ASCII network/service diagrams
- Hardware - Specs and setup guides
- Security - Hardening and best practices
- Runbooks - Procedural playbooks
🔗 Quick Access
Essential Operations
- 🌐 Portainer: pt.vish.gg (Tailscale-only)
- 📊 Dashboard: dash.vish.gg
- 📈 Grafana: gf.vish.gg
- 🗂️ NetBox (DCIM): nb.vish.gg
- 🚨 Emergency: Emergency Access Guide
Common Tasks
- 🔧 Deploy Services: Deployment Workflow
- 📈 Monitor System: Monitoring Setup
- 🔍 Troubleshoot: Troubleshooting Directory
- 📚 Full Index: INDEX.md
🔄 GitOps Integration
This homelab uses GitOps (Portainer + Gitea) for container orchestration. Every service definition is version-controlled and auto-deployed on push.
- Deployment Process: Deployment Workflow
- Comprehensive Guide: GitOps Comprehensive Guide
- Service Inventory: Verified Service Inventory