6.1 KiB
6.1 KiB
🏠 Vish's Homelab Documentation
Welcome to the comprehensive documentation for Vish's homelab infrastructure! This documentation is designed to serve users ranging from complete beginners ("what is a computer?") to experienced HPC engineers.
📚 Documentation Structure
🚀 Getting Started
- 01-What-is-a-Homelab - Complete beginner's introduction
- 02-Quick-Start-Guide - Get up and running fast
- 03-Architecture-Overview - Understanding the infrastructure
- 04-Prerequisites - What you need to know/have
🏗️ Infrastructure
- 10-Host-Overview - All physical and virtual machines
- 11-Network-Architecture - How everything connects
- 12-Storage-Systems - Data storage and management
- 13-Security-Model - How the lab is secured
🐳 Services
- 19-Individual-Service-Docs - NEW! Detailed guides for all 159 services
- 20-Service-Categories - Services organized by function
- 21-Service-Index - Complete alphabetical list
- 22-Popular-Services - Most commonly used services
- 23-Service-Dependencies - How services interact
🔧 Administration
- 30-Deployment-Guide - How to deploy new services
- 31-Monitoring-Alerting - Keeping track of everything
- 32-Backup-Recovery - Protecting your data
- 33-Maintenance-Tasks - Regular upkeep
🚨 Troubleshooting
- 40-Common-Issues - Frequent problems and solutions
- 41-Diagnostic-Tools - How to investigate problems
- 42-Emergency-Procedures - When things go very wrong
- 43-Performance-Tuning - Optimizing your setup
🎓 Advanced Topics
- 50-Ansible-Automation - Infrastructure as Code
- 51-Custom-Configurations - Tailoring to your needs
- 52-Integration-Patterns - Connecting services together
- 53-Scaling-Strategies - Growing your homelab
🏠 Infrastructure Overview
This homelab consists of 159 fully documented services running across 13 different hosts:
📊 Host Summary
| Host Type | Count | Primary Purpose |
|---|---|---|
| Synology NAS | 3 | Storage, Media, Core Services |
| Intel NUC | 1 | Edge Computing, IoT Hub |
| Proxmox VMs | 3 | Isolated Workloads, Testing |
| Raspberry Pi | 2 | Lightweight Services, Sensors |
| Remote VMs | 2 | External Services, Backup |
| Physical Hosts | 2 | High-Performance Computing |
🎯 Service Categories
| Category | Services | Examples |
|---|---|---|
| Media & Entertainment | 25+ | Plex, Jellyfin, Immich, Arr Suite |
| Development & DevOps | 20+ | GitLab, Gitea, Portainer, Dozzle |
| Productivity | 15+ | Paperless-NGX, Firefly III, Calibre |
| Communication | 10+ | Matrix, Mastodon, Jitsi, Mattermost |
| Monitoring | 15+ | Grafana, Prometheus, Uptime Kuma |
| Security & Privacy | 10+ | Vaultwarden, Wireguard, Pi-hole |
| AI & Machine Learning | 5+ | Ollama, LlamaGPT, Whisper |
| Gaming | 8+ | Minecraft, Factorio, Satisfactory |
🎯 Quick Navigation
For Beginners
- Start with 01-What-is-a-Homelab
- Review 04-Prerequisites
- Follow the 02-Quick-Start-Guide
- Explore 22-Popular-Services
For Intermediate Users
- Review 03-Architecture-Overview
- Check 20-Service-Categories
- Learn about 30-Deployment-Guide
- Set up 31-Monitoring-Alerting
For Advanced Users
- Dive into 50-Ansible-Automation
- Explore 51-Custom-Configurations
- Review 52-Integration-Patterns
- Consider 53-Scaling-Strategies
🆘 Need Help?
- Common Issues: Check 40-Common-Issues
- Service Not Working: See 41-Diagnostic-Tools
- Performance Problems: Review 43-Performance-Tuning
- Emergency: Follow 42-Emergency-Procedures
📝 Contributing
This documentation is a living document. If you find errors, have suggestions, or want to add content:
- Check the 21-Service-Index for existing documentation
- Review 30-Deployment-Guide for deployment patterns
- Follow the documentation style guide in each section
🏷️ Conventions Used
- 🟢 Beginner-Friendly: Suitable for newcomers
- 🟡 Intermediate: Requires basic Docker/Linux knowledge
- 🔴 Advanced: Requires significant technical expertise
- ⚠️ Caution: Potentially destructive operations
- 💡 Tip: Helpful hints and best practices
- 🔧 Technical: Deep technical details
Last Updated: November 2024
Infrastructure: 159 fully documented services across 13 hosts
Documentation Status: Complete with individual service guides
📋 Document Organization for Joplin
This documentation is organized with numbered prefixes for easy sorting in Joplin:
- 00-09: Index and overview documents
- 10-19: Infrastructure and architecture
- 20-29: Services and applications
- 30-39: Administration and deployment
- 40-49: Troubleshooting and maintenance
- 50-59: Advanced topics and automation
Each document is self-contained but cross-references related topics for easy navigation.