126 lines
4.3 KiB
Plaintext
126 lines
4.3 KiB
Plaintext
====== Getting Started ======
|
|
|
|
Welcome to your AI-powered homelab! This guide will walk you through setting up your production-ready infrastructure with Dockge, Traefik, Authelia, and 70+ services.
|
|
|
|
===== Quick Start Checklist =====
|
|
|
|
**Prerequisites:**
|
|
* [ ] Fresh Debian/Ubuntu server (or existing system)
|
|
* [ ] Root/sudo access
|
|
* [ ] Internet connection
|
|
* [ ] VS Code with GitHub Copilot (recommended)
|
|
|
|
**Setup Process:**
|
|
* [ ] Clone repository: `git clone https://github.com/kelinfoxy/AI-Homelab.git`
|
|
* [ ] Configure `.env` file with your domain and tokens
|
|
* [ ] Run setup script: `sudo ./scripts/setup-homelab.sh`
|
|
* [ ] Run deployment script: `sudo ./scripts/deploy-homelab.sh`
|
|
* [ ] Access Dockge at `https://dockge.yourdomain.duckdns.org`
|
|
|
|
**Post-Setup:**
|
|
* [ ] Set up 2FA with Authelia
|
|
* [ ] Configure Homepage dashboard
|
|
* [ ] Deploy additional services as needed
|
|
* [ ] Set up backups with Backrest
|
|
|
|
===== What You Get =====
|
|
|
|
Your homelab includes:
|
|
|
|
**Core Infrastructure (Deployed First):**
|
|
* **DuckDNS**: Dynamic DNS with Let's Encrypt wildcard SSL certificates
|
|
* **Traefik**: Reverse proxy with automatic HTTPS termination
|
|
* **Authelia**: SSO authentication protecting all services
|
|
* **Gluetun**: VPN client for secure downloads
|
|
* **Sablier**: Lazy loading service for resource management
|
|
|
|
**Management Tools:**
|
|
* **Dockge**: Web-based Docker stack manager (PRIMARY interface)
|
|
* **Pi-hole**: Network-wide ad blocking and DNS
|
|
* **Dozzle**: Live Docker log viewer
|
|
* **Glances**: System monitoring dashboard
|
|
|
|
**Dashboards:**
|
|
* **Homepage**: AI-configured service dashboard
|
|
* **Homarr**: Modern alternative dashboard
|
|
|
|
**70+ Available Services:**
|
|
* Media: Plex, Jellyfin, Sonarr, Radarr, qBittorrent
|
|
* Productivity: Nextcloud, Gitea, BookStack, WordPress
|
|
* Home Automation: Home Assistant, Node-RED, Zigbee2MQTT
|
|
* Monitoring: Grafana, Prometheus, Uptime Kuma
|
|
* Development: VS Code Server, GitLab, Jupyter
|
|
* And many more...
|
|
|
|
===== Architecture Overview =====
|
|
|
|
```
|
|
Internet → DuckDNS → Traefik → Authelia → Services
|
|
↓
|
|
Wildcard SSL (*.yourdomain.duckdns.org)
|
|
```
|
|
|
|
**Key Features:**
|
|
* **File-based configuration**: AI-manageable YAML files
|
|
* **Automatic HTTPS**: Let's Encrypt wildcard certificates
|
|
* **SSO protection**: Authelia secures admin interfaces
|
|
* **VPN routing**: Downloads protected through Gluetun
|
|
* **Resource management**: Automatic container limits
|
|
* **Lazy loading**: Services start on-demand
|
|
|
|
===== Access Your Services =====
|
|
|
|
After deployment, access services at:
|
|
|
|
| Service | URL | Purpose |
|
|
|---------|-----|---------|
|
|
| **Dockge** | `https://dockge.yourdomain.duckdns.org` | Stack management |
|
|
| **Homepage** | `https://home.yourdomain.duckdns.org` | Service dashboard |
|
|
| **Authelia** | `https://auth.yourdomain.duckdns.org` | SSO login |
|
|
| **Traefik** | `https://traefik.yourdomain.duckdns.org` | Reverse proxy dashboard |
|
|
| **Pi-hole** | `http://pihole.yourdomain.duckdns.org` | DNS admin |
|
|
| **Dozzle** | `https://dozzle.yourdomain.duckdns.org` | Log viewer |
|
|
|
|
**Default Credentials:**
|
|
* Username: `admin` (or custom username from setup)
|
|
* Password: Secure password created during setup
|
|
|
|
===== Next Steps =====
|
|
|
|
1. **Complete Security Setup**
|
|
* Configure 2FA in Authelia
|
|
* Review service access policies
|
|
* Set up backup encryption
|
|
|
|
2. **Deploy Core Services**
|
|
* Use Dockge to deploy media services
|
|
* Configure Homepage widgets
|
|
* Set up monitoring dashboards
|
|
|
|
3. **Customize Your Stack**
|
|
* Add external service proxying
|
|
* Configure backup schedules
|
|
* Set up development environment
|
|
|
|
4. **Learn Advanced Features**
|
|
* Use AI Copilot for management
|
|
* Explore service customization
|
|
* Contribute to the project
|
|
|
|
===== Getting Help =====
|
|
|
|
**Documentation:**
|
|
* [[architecture:overview|Architecture Guide]]
|
|
* [[services:start|Service Reference]]
|
|
* [[troubleshooting:start|Troubleshooting]]
|
|
* [[reference:start|Quick Reference]]
|
|
|
|
**Community:**
|
|
* [[https://github.com/kelinfoxy/AI-Homelab/issues|GitHub Issues]]
|
|
* [[https://github.com/kelinfoxy/AI-Homelab/discussions|Discussions]]
|
|
|
|
**AI Assistance:**
|
|
* Use GitHub Copilot in VS Code
|
|
* Reference the [[development:copilot|Copilot Instructions]]
|
|
|
|
Ready to get started? Continue to [[getting_started:prerequisites|Prerequisites]] or jump straight to [[getting_started:setup|Automated Setup]]. |