105 lines
4.6 KiB
Plaintext
105 lines
4.6 KiB
Plaintext
====== AI-Homelab Documentation Wiki ======
|
|
|
|
===== Welcome to AI-Homelab =====
|
|
|
|
**AI-Homelab** is a production-ready homelab infrastructure that deploys 70+ services through a file-based, AI-manageable architecture using Dockge for visual management.
|
|
|
|
**Key Features:**
|
|
* **Automated SSL** - Wildcard certificates via Let's Encrypt
|
|
* **Single Sign-On** - Authelia authentication across all services
|
|
* **VPN Routing** - Secure downloads through Gluetun
|
|
* **Lazy Loading** - Sablier enables on-demand container startup
|
|
* **Resource Limits** - Prevent resource exhaustion
|
|
* **AI Management** - GitHub Copilot integration for service management
|
|
|
|
**Quick Access:**
|
|
* [[getting_started:start|🚀 Getting Started]] - Setup and deployment guide
|
|
* [[architecture:overview|🏗️ Architecture]] - System design and components
|
|
* [[services:start|📦 Services]] - All available services and stacks
|
|
* [[backup_recovery:start|💾 Backup & Recovery]] - Data protection strategies
|
|
* [[troubleshooting:start|🔧 Troubleshooting]] - Common issues and solutions
|
|
* [[development:start|👨💻 Development]] - Contributing and customization
|
|
|
|
===== Quick Start Checklist =====
|
|
|
|
Complete these steps to get your homelab running:
|
|
|
|
* [ ] [[getting_started:prerequisites|Review prerequisites and requirements]]
|
|
* [ ] [[getting_started:setup|Run automated setup script]]
|
|
* [ ] [[getting_started:deployment|Deploy core infrastructure]]
|
|
* [ ] [[getting_started:access|Access your services]]
|
|
* [ ] [[getting_started:security|Configure security (2FA, access rules)]]
|
|
* [ ] [[services:deployment|Deploy additional services as needed]]
|
|
|
|
===== Architecture Overview =====
|
|
|
|
**Core Components:**
|
|
* **[[services:core:traefik|Traefik]]** - Reverse proxy with automatic SSL
|
|
* **[[services:core:authelia|Authelia]]** - Single sign-on authentication
|
|
* **[[services:core:duckdns|DuckDNS]]** - Dynamic DNS updates
|
|
* **[[services:core:gluetun|Gluetun]]** - VPN client for secure downloads
|
|
* **[[services:core:sablier|Sablier]]** - Lazy loading service
|
|
|
|
**Service Categories:**
|
|
* **[[services:infrastructure:start|Infrastructure]]** - Management and monitoring tools
|
|
* **[[services:media:start|Media]]** - Streaming, automation, and content management
|
|
* **[[services:productivity:start|Productivity]]** - Collaboration and workflow tools
|
|
* **[[services:monitoring:start|Monitoring]]** - Observability and alerting
|
|
* **[[services:utilities:start|Utilities]]** - Backup, security, and system tools
|
|
|
|
===== Service Access =====
|
|
|
|
After deployment, access your services at:
|
|
|
|
^ Service ^ URL ^ Authentication ^
|
|
| **Dockge** | https://dockge.{{DOMAIN}} | Authelia SSO |
|
|
| **Homepage** | https://home.{{DOMAIN}} | Authelia SSO |
|
|
| **Traefik Dashboard** | https://traefik.{{DOMAIN}} | Authelia SSO |
|
|
| **Authelia Login** | https://auth.{{DOMAIN}} | Direct access |
|
|
|
|
===== Getting Help =====
|
|
|
|
**Documentation Navigation:**
|
|
* Use the sidebar for quick navigation
|
|
* Search functionality is available in the top-right
|
|
* All pages include cross-references to related topics
|
|
|
|
**Community Resources:**
|
|
* [[https://github.com/kelinfoxy/AI-Homelab|GitHub Repository]]
|
|
* [[https://github.com/kelinfoxy/AI-Homelab/issues|Issue Tracker]]
|
|
* [[https://github.com/kelinfoxy/AI-Homelab/discussions|Discussions]]
|
|
|
|
**AI Assistance:**
|
|
* This wiki is designed to work with AI agents
|
|
* Use GitHub Copilot in VS Code for intelligent management
|
|
* See [[development:copilot|Copilot Instructions]] for details
|
|
|
|
===== Recent Updates =====
|
|
|
|
**January 20, 2026:**
|
|
* Updated service count to 70+ services
|
|
* Enhanced Sablier lazy loading documentation
|
|
* Improved backup strategy with Backrest as default
|
|
* Standardized service documentation format
|
|
* Added comprehensive troubleshooting guides
|
|
|
|
**Key Improvements:**
|
|
* Better navigation and cross-linking
|
|
* Comprehensive service documentation
|
|
* Enhanced security configurations
|
|
* Improved deployment automation
|
|
|
|
===== Navigation =====
|
|
|
|
{{:navigation-tree.png?300|Documentation Structure}}
|
|
|
|
**Main Sections:**
|
|
* [[getting_started:start|Getting Started]] - Setup and deployment
|
|
* [[architecture:start|Architecture]] - System design
|
|
* [[services:start|Services]] - Available services
|
|
* [[backup_recovery:start|Backup & Recovery]] - Data protection
|
|
* [[troubleshooting:start|Troubleshooting]] - Problem solving
|
|
* [[development:start|Development]] - Contributing and customization
|
|
* [[reference:start|Reference]] - Quick reference guides
|
|
|
|
This wiki serves as the comprehensive documentation hub for AI-Homelab. All content is maintained and regularly updated to reflect the latest features and best practices. |