7.8 KiB
7.8 KiB
📚 Homelab Documentation Index
Complete navigation guide for Vish's Homelab documentation
🎯 Quick Navigation
🚀 Getting Started
- README.md - Main repository overview and quick start
- What is a Homelab? - Introduction to homelabs
- Beginner Quickstart - Step-by-step setup guide
- Prerequisites - Required knowledge and tools
- Shopping Guide - Hardware recommendations
🏗️ GitOps Deployment (Primary Method)
- Deploy a New Service — End-to-End - ⭐ START HERE: compose file → Portainer → auto-deploy
- GitOps Comprehensive Guide - Full GitOps architecture reference
- GitOps Deployment Guide - Dashboard fixes and procedures
- Deployment Workflow - Step-by-step deployment process
🖥️ Infrastructure & Architecture
- Infrastructure Overview - Complete infrastructure documentation
- Infrastructure Health Report - Current system status
- Hardware Inventory - Complete hardware documentation
- Network Topology - Network architecture diagrams
- Service Architecture - Service deployment architecture
🔧 Administration & Operations
- Current Infrastructure Status - ⭐ LATEST STATUS REPORT
- Operational Status - Historical deployment status
- DokuWiki Integration - Documentation mirroring to DokuWiki ✅
- Gitea Wiki Integration - Native wiki integration 🔄
- Portainer API Guide - Container management via API ⭐
- Documentation Maintenance Guide - Keep docs synchronized ⭐
- Monitoring Setup - Monitoring and alerting configuration
- Backup Strategies - Backup and disaster recovery
- Maintenance Procedures - Regular maintenance tasks
- Security Hardening - Security configuration guide
📊 Monitoring & Observability
- Monitoring Architecture - Complete monitoring stack documentation
- Dashboard Setup - Grafana dashboard configuration
- Watchtower Deployment Fixes - Auto-update system
🛠️ Service Management
- Verified Service Inventory - Complete service catalog
- Service Categories - Services organized by function
- Popular Services - Most commonly used services
- Service Dependencies - Service relationship mapping
🔐 Security Documentation
- Security Overview - Security architecture
- SSH Access Guide - Secure access procedures
- User Access Guide - User management and access
- Repository Sanitization - Public mirror documentation
🏠 Host-Specific Documentation
Synology NAS Systems
- Atlantis Storage - Primary NAS configuration
- Synology SSH Access - SSH setup for Synology
- Synology DSM Upgrade - DSM upgrade procedures
Virtual Machines & Edge Devices
- Proxmox Setup - VM host configuration
- Raspberry Pi Setup - Edge device configuration
🌐 Network & Connectivity
- Tailscale Setup Guide - VPN mesh network
- Cloudflare Tunnels - External access setup
- Port Forwarding Guide - Network configuration
- Network Performance Tuning - Optimization guide
🎮 Gaming & Entertainment
- Gaming Server Documentation - Minecraft, Garry's Mod setup
- Fluxer Setup - Self-hosted chat platform (st.vish.gg)
- Media Services - Plex, Jellyfin, *arr stack
🔄 Advanced Topics
- Homelab Maturity Roadmap - Infrastructure evolution
- Terraform Implementation - Infrastructure as Code
- Kubernetes Setup - Container orchestration
- Scaling Guide - Infrastructure scaling strategies
📊 Documentation Status
✅ Up-to-Date Documentation
- GitOps deployment procedures
- Infrastructure health reports
- Service inventory and status
- Security hardening guides
- Monitoring and alerting setup
🔄 Recently Updated
- GitOps comprehensive guide (Feb 14, 2026)
- Infrastructure health report (Feb 8, 2026)
- Operational status (Feb 11, 2026)
- Watchtower deployment fixes (Feb 13, 2026)
📝 Documentation Standards
- Status Indicators: ✅ Active, 🔄 Updated, 🚧 In Progress, ⚠️ Needs Update
- Review Cycle: Monthly review for critical docs, quarterly for others
- Version Control: All documentation changes tracked in Git
- Cross-References: Links validated and updated regularly
🎯 Quick Reference by Use Case
"I want to deploy a new service"
- Deploy a New Service — End-to-End - Complete walkthrough from compose file to live container
- Add New Service Runbook - Extended checklist (monitoring, backups, SSO)
"Something is broken"
- Common Issues - Quick fixes
- Emergency Access Guide - Emergency procedures
- Container Diagnosis - Container troubleshooting
"I need to understand the infrastructure"
- Infrastructure Overview - Complete overview
- Network Topology - Network architecture
- Service Architecture - Service layout
"I'm new to homelabs"
- What is a Homelab? - Introduction
- Beginner Quickstart - Getting started
- Shopping Guide - Hardware recommendations
"I need to perform maintenance"
- Maintenance Procedures - Regular maintenance
- Backup Strategies - Backup procedures
- Security Hardening - Security updates
📞 Support & Contact
- Repository: git.vish.gg/Vish/homelab
- Issues: Use the repository issue tracker
- Chat: Available on Fluxer (st.vish.gg)
- Documentation Issues: Create issue with "documentation" label
Last Updated: March 7, 2026
Total Documents: 80+ documentation files
Coverage: Complete infrastructure and operational procedures
Maintenance: Active and regularly updated