Sanitized mirror from private repository - 2026-04-19 08:44:05 UTC

docs/README.md

@@ -0,0 +1,79 @@
+# Homelab Documentation
+
+Comprehensive documentation for the homelab infrastructure and services.
+
+For a full navigation guide with every doc and recent updates, see **[INDEX.md](INDEX.md)**.
+
+## 📁 Structure at a Glance
+
+### 🚀 Getting Started
+- [Beginner Quickstart](getting-started/BEGINNER_QUICKSTART.md) - Initial setup
+- [Docker Compose Guide](getting-started/docker-compose-guide.md) - Compose basics
+- [FAQ](getting-started/faq.md) - Quick answers
+- [Getting Started Directory](getting-started/) - Full walkthroughs
+
+### 🏗️ Infrastructure
+- [Infrastructure Overview](infrastructure/INFRASTRUCTURE_OVERVIEW.md)
+- [Network Architecture](infrastructure/network-architecture.md)
+- [Split-Horizon DNS](infrastructure/split-horizon-dns.md)
+- [Backup Strategy](infrastructure/backup-strategy.md)
+- [SSH Access Guide](infrastructure/SSH_ACCESS_GUIDE.md)
+
+### 🖥️ Hosts
+- [Host Overview](infrastructure/hosts.md) - Per-host details
+- [Jellyfish](hosts/jellyfish.md), [Setillo](hosts/setillo.md) - Dedicated host docs
+
+### 🔧 Services
+- [Verified Service Inventory](services/VERIFIED_SERVICE_INVENTORY.md)
+- [Individual Services](services/individual/) - Service-specific docs (dashboard, olares, anythingllm, holyclaude, …)
+- [arr-suite Language Config](services/arr-suite-language-configuration.md)
+
+### 👨‍💼 Administration
+- [Deployment Workflow](admin/DEPLOYMENT_WORKFLOW.md)
+- [GitOps Deployment Guide](admin/gitops-deployment-guide.md)
+- [GitOps Comprehensive Guide](admin/GITOPS_COMPREHENSIVE_GUIDE.md)
+- [Monitoring Setup](admin/monitoring-setup.md)
+- [Ansible Playbook Guide](admin/ANSIBLE_PLAYBOOK_GUIDE.md)
+- [ntfy Notification System](admin/ntfy-notification-system.md)
+- [Operational Status](admin/operational-status.md)
+- [AI Integrations](admin/ai-integrations.md)
+- [Secrets Management](admin/secrets-management.md)
+
+### 🚨 Troubleshooting
+- [Emergency Access](troubleshooting/EMERGENCY_ACCESS_GUIDE.md)
+- [Common Issues](troubleshooting/common-issues.md)
+- [Internet-Outage Access](troubleshooting/internet-outage-access.md)
+- [Watchtower Deployment Fixes](troubleshooting/watchtower-deployment-fixes.md)
+
+### 🎓 Advanced Topics
+- [Terraform Implementation](advanced/TERRAFORM_IMPLEMENTATION_GUIDE.md)
+- [Homelab Maturity Roadmap](advanced/HOMELAB_MATURITY_ROADMAP.md)
+
+### 📊 Other
+- [Diagrams](diagrams/) - Mermaid + ASCII network/service diagrams
+- [Hardware](hardware/) - Specs and setup guides
+- [Security](security/) - Hardening and best practices
+- [Runbooks](runbooks/) - Procedural playbooks
+
+## 🔗 Quick Access
+
+### Essential Operations
+- 🌐 **Portainer**: [pt.vish.gg](https://pt.vish.gg) (Authentik SSO)
+- 📊 **Dashboard**: [dash.vish.gg](https://dash.vish.gg)
+- 📈 **Grafana**: [gf.vish.gg](https://gf.vish.gg)
+- 🗂️ **NetBox (DCIM)**: [nb.vish.gg](https://nb.vish.gg)
+- 🚨 **Emergency**: [Emergency Access Guide](troubleshooting/EMERGENCY_ACCESS_GUIDE.md)
+
+### Common Tasks
+- 🔧 **Deploy Services**: [Deployment Workflow](admin/DEPLOYMENT_WORKFLOW.md)
+- 📈 **Monitor System**: [Monitoring Setup](admin/monitoring-setup.md)
+- 🔍 **Troubleshoot**: [Troubleshooting Directory](troubleshooting/)
+- 📚 **Full Index**: [INDEX.md](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](admin/DEPLOYMENT_WORKFLOW.md)
+- **Comprehensive Guide**: [GitOps Comprehensive Guide](admin/GITOPS_COMPREHENSIVE_GUIDE.md)
+- **Service Inventory**: [Verified Service Inventory](services/VERIFIED_SERVICE_INVENTORY.md)