117 lines
5.4 KiB
Plaintext
117 lines
5.4 KiB
Plaintext
====== 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 ====
|
|
* [[getting-started:what-is-homelab|What is a Homelab?]] - Complete beginner's introduction
|
|
* [[getting-started:quick-start|Quick Start Guide]] - Get up and running fast
|
|
* [[getting-started:architecture|Architecture Overview]] - Understanding the infrastructure
|
|
* [[getting-started:prerequisites|Prerequisites]] - What you need to know/have
|
|
|
|
==== Infrastructure ====
|
|
* [[infrastructure:hosts|Host Overview]] - All physical and virtual machines
|
|
* [[infrastructure:networking|Network Architecture]] - How everything connects
|
|
* [[infrastructure:storage|Storage Systems]] - Data storage and management
|
|
* [[infrastructure:security|Security Model]] - How the lab is secured
|
|
|
|
==== Services ====
|
|
* [[services:individual:index|Individual Service Docs]] - **NEW!** Detailed guides for all 159 services
|
|
* [[services:categories|Service Categories]] - Services organized by function
|
|
* [[services:index|Service Index]] - Complete alphabetical list
|
|
* [[services:popular|Popular Services]] - Most commonly used services
|
|
* [[services:dependencies|Service Dependencies]] - How services interact
|
|
|
|
==== Administration ====
|
|
* [[admin:deployment|Deployment Guide]] - How to deploy new services
|
|
* [[admin:monitoring|Monitoring & Alerting]] - Keeping track of everything
|
|
* [[admin:backup|Backup & Recovery]] - Protecting your data
|
|
* [[admin:maintenance|Maintenance Tasks]] - Regular upkeep
|
|
|
|
==== Troubleshooting ====
|
|
* [[troubleshooting:common-issues|Common Issues]] - Frequent problems and solutions
|
|
* [[troubleshooting:diagnostics|Diagnostic Tools]] - How to investigate problems
|
|
* [[troubleshooting:emergency|Emergency Procedures]] - When things go very wrong
|
|
* [[troubleshooting:performance|Performance Tuning]] - Optimizing your setup
|
|
|
|
==== Advanced Topics ====
|
|
* [[advanced:ansible|Ansible Automation]] - Infrastructure as Code
|
|
* [[advanced:customization|Custom Configurations]] - Tailoring to your needs
|
|
* [[advanced:integrations|Integration Patterns]] - Connecting services together
|
|
* [[advanced:scaling|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 [[getting-started:what-is-homelab|What is a Homelab?]]
|
|
- Review [[getting-started:prerequisites|Prerequisites]]
|
|
- Follow the [[getting-started:quick-start|Quick Start Guide]]
|
|
- Explore [[services:popular|Popular Services]]
|
|
|
|
==== For Intermediate Users ====
|
|
- Review [[getting-started:architecture|Architecture Overview]]
|
|
- Check [[services:categories|Service Categories]]
|
|
- Learn about [[admin:deployment|Deployment]]
|
|
- Set up [[admin:monitoring|Monitoring]]
|
|
|
|
==== For Advanced Users ====
|
|
- Dive into [[advanced:ansible|Ansible Automation]]
|
|
- Explore [[advanced:customization|Custom Configurations]]
|
|
- Review [[advanced:integrations|Integration Patterns]]
|
|
- Consider [[advanced:scaling|Scaling Strategies]]
|
|
|
|
===== Need Help? =====
|
|
|
|
* **Common Issues**: Check [[troubleshooting:common-issues|Common Issues]]
|
|
* **Service Not Working**: See [[troubleshooting:diagnostics|Diagnostic Tools]]
|
|
* **Performance Problems**: Review [[troubleshooting:performance|Performance Tuning]]
|
|
* **Emergency**: Follow [[troubleshooting:emergency|Emergency Procedures]]
|
|
|
|
===== Contributing =====
|
|
|
|
This documentation is a living document. If you find errors, have suggestions, or want to add content:
|
|
|
|
- Check the [[services:index|Service Index]] for existing documentation
|
|
- Review [[admin:deployment|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//
|