kelin/EZ-Homelab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename project from AI-Homelab to EZ-Homelab

Browse Source 
- Updated all documentation references from AI-Homelab to EZ-Homelab
- Changed repository URLs and directory paths
- Updated wiki content and navigation
- Maintained AI assistance functionality while emphasizing ease of use
- Updated copilot instructions and agent guidelines
This commit is contained in:
kelinfoxy
2026-01-21 19:54:27 -05:00
parent ef55974b50
commit 43f78b384f
20 changed files with 61 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/copilot-instructions.md vendored
View File

@@ -1,6 +1,6 @@
# AI Homelab Management Assistant
# EZ-Homelab Management Assistant
You are an AI assistant for the **AI-Homelab** project - a production-ready Docker homelab infrastructure managed through GitHub Copilot in VS Code. This system deploys 50+ services with automated SSL, SSO authentication, and VPN routing using a file-based, AI-manageable architecture.
You are an AI assistant for the **EZ-Homelab** project - a production-ready Docker homelab infrastructure managed through GitHub Copilot in VS Code. This system deploys 50+ services with automated SSL, SSO authentication, and VPN routing using a file-based, AI-manageable architecture.
## Project Architecture
@@ -16,7 +16,7 @@ The **core stack** (`/opt/stacks/core/`) contains essential services that must r
- **Two-script setup**: `setup-homelab.sh` (system prep, Docker install, secrets generation) → `deploy-homelab.sh` (automated deployment)
- **Dockge-based management**: All stacks in `/opt/stacks/`, managed via web UI at `dockge.${DOMAIN}`
- **Automated workflows**: Scripts create directories, configure networks, deploy stacks, wait for health checks
- **Repository location**: `/home/kelin/AI-Homelab/` (templates in `docker-compose/`, docs in `docs/`)
- **Repository location**: `/home/kelin/EZ-Homelab/` (templates in `docker-compose/`, docs in `docs/`)
### File Structure Standards
```
@@ -90,7 +90,7 @@ deploy:
- **Configs**: Bind mount `./service/config:/config` relative to stack directory
- **Small data**: Named volumes (databases, app data <50GB)
- **Large data**: External mounts `/mnt/media`, `/mnt/downloads` (user must configure)
- **Secrets**: `.env` files in stack directories (auto-copied from `~/AI-Homelab/.env`)
- **Secrets**: `.env` files in stack directories (auto-copied from `~/EZ-Homelab/.env`)
### 5. LinuxServer.io Preference
- Use `lscr.io/linuxserver/*` images when available (PUID/PGID support for permissions)

14
AGENT_INSTRUCTIONS.md
View File

@@ -4,14 +4,14 @@
You are an AI agent specialized in managing Docker-based homelab infrastructure using Dockge. Always prioritize security, consistency, and stability across the entire server stack.
## Repository Context
- **Repository Location**: `~/AI-Homelab/`
- **Repository Location**: `~/EZ-Homelab/`
- **Purpose**: Production-ready Docker homelab infrastructure managed through GitHub Copilot in VS Code
- **User**: `kelin` (PUID=1000, PGID=1000)
- **Critical**: All file operations must respect user ownership - avoid permission escalation issues
## Repository Structure
```
~/AI-Homelab/
~/EZ-Homelab/
├── .github/
│ └── copilot-instructions.md # GitHub Copilot guidelines
├── docker-compose/ # Compose file templates
@@ -292,7 +292,7 @@ labels:
**Deployment Steps:**
1. Create stack directory: `/opt/stacks/stack-name/`
2. Write docker-compose.yml using LinuxServer.io template with Traefik labels
3. Create `.env` file for secrets (copy from `~/AI-Homelab/.env`)
3. Create `.env` file for secrets (copy from `~/EZ-Homelab/.env`)
4. **Ask user**: Enable SSO protection? (Default: Yes, unless media service like Plex/Jellyfin)
5. **Ask user**: Enable lazy loading (Sablier)? (Default: Yes for resource conservation) - **Note**: Requires `restart: no` instead of `unless-stopped`
6. Add service to Homepage dashboard config
@@ -441,14 +441,14 @@ labels:
sudo chown -R kelin:kelin /opt/stacks
# For repository files
chown -R kelin:kelin ~/AI-Homelab # No sudo needed in home dir
chown -R kelin:kelin ~/EZ-Homelab # No sudo needed in home dir
# For Docker-managed directories, leave as root
# (e.g., /opt/stacks/*/data/ created by containers)
```
3. **Prevent Future Issues**
- Edit files in `~/AI-Homelab/` without sudo
- Edit files in `~/EZ-Homelab/` without sudo
- Only use sudo for Docker commands
- Don't change ownership of Docker-created volumes
@@ -509,7 +509,7 @@ labels:
## Repository Management Guidelines
### Repository Maintenance
- Work within `~/AI-Homelab/` for all operations
- Work within `~/EZ-Homelab/` for all operations
- Validate all YAML files before committing
- Ensure `.env.example` stays updated with new variables
- Document breaking changes in commit messages
@@ -532,7 +532,7 @@ grep -v '^#' .env | grep -v '^$'
bash -n scripts/deploy-homelab.sh
# Verify file permissions
ls -la ~/AI-Homelab/
ls -la ~/EZ-Homelab/
```
### Deployment Checklist

6
README.md
View File

@@ -1,4 +1,4 @@
# AI Homelab
# EZ-Homelab
[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=flat&logo=docker&logoColor=white)](https://docker.com)
[![Traefik](https://img.shields.io/badge/Traefik-24.0.0-24A1C6)](https://traefik.io)
@@ -17,8 +17,8 @@
### Automated Setup
```bash
# Clone repository
git clone https://github.com/kelinfoxy/AI-Homelab.git
cd AI-Homelab
git clone https://github.com/kelinfoxy/EZ-Homelab.git
cd EZ-Homelab
# Configure environment
cp .env.example .env

2
docker-compose/README-dockge.md
View File

@@ -178,7 +178,7 @@ docker network create homelab-network
## Environment Variables
Each stack needs a `.env` file. Use `/home/runner/work/AI-Homelab/AI-Homelab/.env.example` as a template.
Each stack needs a `.env` file. Use `/home/runner/work/EZ-Homelab/EZ-Homelab/.env.example` as a template.
**Required variables**:
- `DOMAIN`: Your DuckDNS domain (e.g., `yourdomain.duckdns.org`)

2
docs/automated-setup.md
View File

@@ -33,7 +33,7 @@ For most users, the automated setup script handles everything from system prepar
- `ACME_EMAIL` - Your email for Let's Encrypt certificates
- `SURFSHARK_USERNAME` and `SURFSHARK_PASSWORD` - If using VPN
**Note:** The `.env` file stays in the repository folder (`~/AI-Homelab/.env`). The deploy script copies it to stack directories automatically. Authelia secrets (JWT, session, encryption key) are auto-generated by the setup script - leave them with default values for now.
**Note:** The `.env` file stays in the repository folder (`~/EZ-Homelab/.env`). The deploy script copies it to stack directories automatically. Authelia secrets (JWT, session, encryption key) are auto-generated by the setup script - leave them with default values for now.
5. **Run the setup script:**
```bash

2
docs/env-configuration.md
View File

@@ -1,6 +1,6 @@
# Environment Configuration Guide
This guide explains how to configure the `.env` file required for your AI-Homelab deployment.
This guide explains how to configure the `.env` file required for your EZ-Homelab deployment.
## Prerequisites

4
docs/troubleshooting/COMMON-ISSUES.md
View File

@@ -142,7 +142,7 @@ nslookup yourdomain.duckdns.org
**Solutions:**
```bash
# Check credentials in .env
cat ~/AI-Homelab/.env | grep SURFSHARK
cat ~/EZ-Homelab/.env | grep SURFSHARK
# Check Gluetun logs
sudo docker logs gluetun
@@ -279,7 +279,7 @@ docker run --rm \
4. **Verify configuration:**
```bash
# Check .env file
cat ~/AI-Homelab/.env
cat ~/EZ-Homelab/.env
# Check compose file
cat /opt/stacks/stack-name/docker-compose.yml

2
docs/troubleshooting/SSL-CERTIFICATES-DUCKDNS.md
View File

@@ -185,7 +185,7 @@ Ensure wildcard domain configuration is correct (it is currently):
```
**This is correct** - keep both apex and wildcard.
### ~/AI-Homelab/docs/service-docs/traefik.md
### ~/EZ-Homelab/docs/service-docs/traefik.md
Add troubleshooting section for DuckDNS DNS challenge issues.
## Success Criteria for Next Test

12
wiki/AI-Management-Guide.md
View File

@@ -2,7 +2,7 @@
## Overview
The AI-Homelab is designed for **AI-assisted management** using GitHub Copilot in VS Code. This guide explains how to leverage AI capabilities for deploying, configuring, and maintaining your homelab infrastructure.
The EZ-Homelab is designed for **AI-assisted management** using GitHub Copilot in VS Code. This guide explains how to leverage AI capabilities for deploying, configuring, and maintaining your homelab infrastructure.
## AI Assistant Capabilities
@@ -28,14 +28,14 @@ The entire system is built with AI management in mind:
### Prerequisites
1. **VS Code** with GitHub Copilot extension
2. **AI-Homelab Repository** cloned locally
2. **EZ-Homelab Repository** cloned locally
3. **Basic Understanding** of Docker concepts
### Initial Setup
```bash
# Clone the repository
git clone https://github.com/kelinfoxy/AI-Homelab.git
cd AI-Homelab
git clone https://github.com/kelinfoxy/EZ-Homelab.git
cd EZ-Homelab
# AI will help with configuration
# Ask: "Help me configure the .env file"
@@ -266,7 +266,7 @@ AI Response:
## Getting Help
### AI Assistant Commands
- **General Help**: "Help me with AI-Homelab management"
- **General Help**: "Help me with EZ-Homelab management"
- **Specific Tasks**: "How do I deploy a new service?"
- **Troubleshooting**: "Why isn't my service working?"
- **Configuration**: "How do I configure Authelia?"
@@ -295,5 +295,5 @@ AI Response:
- **Monitoring Integration**: AI-driven alerting
- **Cost Optimization**: Resource usage analysis
The AI-Homelab's AI-first design makes complex homelab management accessible to users of all skill levels while maintaining production-ready reliability and security.</content>
The EZ-Homelab's AI-first design makes complex homelab management accessible to users of all skill levels while maintaining production-ready reliability and security.</content>
<parameter name="filePath">c:\Users\kelin\Documents\Apps\GitHub\AI-Homelab\wiki\AI-Management-Guide.md

2
wiki/Automated-Setup.md
View File

@@ -33,7 +33,7 @@ For most users, the automated setup script handles everything from system prepar
- `ACME_EMAIL` - Your email for Let's Encrypt certificates
- `SURFSHARK_USERNAME` and `SURFSHARK_PASSWORD` - If using VPN
**Note:** The `.env` file stays in the repository folder (`~/AI-Homelab/.env`). The deploy script copies it to stack directories automatically. Authelia secrets (JWT, session, encryption key) are auto-generated by the setup script - leave them with default values for now.
**Note:** The `.env` file stays in the repository folder (`~/EZ-Homelab/.env`). The deploy script copies it to stack directories automatically. Authelia secrets (JWT, session, encryption key) are auto-generated by the setup script - leave them with default values for now.
5. **Run the setup script:**
```bash

2
wiki/Copilot-Instructions.md
View File

@@ -90,7 +90,7 @@ deploy:
- **Configs**: Bind mount `./service/config:/config` relative to stack directory
- **Small data**: Named volumes (databases, app data <50GB)
- **Large data**: External mounts `/mnt/media`, `/mnt/downloads` (user must configure)
- **Secrets**: `.env` files in stack directories (auto-copied from `~/AI-Homelab/.env`)
- **Secrets**: `.env` files in stack directories (auto-copied from `~/EZ-Homelab/.env`)
### 5. LinuxServer.io Preference
- Use `lscr.io/linuxserver/*` images when available (PUID/PGID support for permissions)

20
wiki/Home.md
View File

@@ -1,6 +1,6 @@
# AI-Homelab Wiki
# EZ-Homelab Wiki
Welcome to the **AI-Homelab Wiki** - the comprehensive source of truth for deploying and managing a production-ready homelab infrastructure with 50+ services.
Welcome to the **EZ-Homelab Wiki** - the comprehensive source of truth for deploying and managing a production-ready homelab infrastructure with 50+ services.
[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=flat&logo=docker&logoColor=white)](https://docker.com)
[![Traefik](https://img.shields.io/badge/Traefik-24.0.0-24A1C6)](https://traefik.io)
@@ -8,7 +8,7 @@ Welcome to the **AI-Homelab Wiki** - the comprehensive source of truth for deplo
## 📖 Wiki Overview
This wiki serves as the **single source of truth** for the AI-Homelab project, containing all documentation, guides, and reference materials needed to deploy and manage your homelab infrastructure.
This wiki serves as the **single source of truth** for the EZ-Homelab project, containing all documentation, guides, and reference materials needed to deploy and manage your homelab infrastructure.
### 🎯 Key Features
@@ -20,7 +20,7 @@ This wiki serves as the **single source of truth** for the AI-Homelab project, c
### 🏗️ Architecture Overview
The AI-Homelab uses a layered architecture:
The EZ-Homelab uses a layered architecture:
1. **Core Infrastructure** (Deploy First)
- DuckDNS: Dynamic DNS with wildcard SSL
@@ -48,8 +48,8 @@ The AI-Homelab uses a layered architecture:
### Automated Deployment
```bash
git clone https://github.com/kelinfoxy/AI-Homelab.git
cd AI-Homelab
git clone https://github.com/kelinfoxy/EZ-Homelab.git
cd EZ-Homelab
cp .env.example .env
nano .env # Configure your domain and tokens
sudo ./scripts/setup-homelab.sh
@@ -122,7 +122,7 @@ sudo ./scripts/deploy-homelab.sh
### Repository Structure
```
AI-Homelab/
EZ-Homelab/
├── docs/ # Documentation
├── docker-compose/ # Service definitions
├── config-templates/ # Configuration templates
@@ -133,8 +133,8 @@ AI-Homelab/
## 📞 Support & Community
- **Issues**: [GitHub Issues](https://github.com/kelinfoxy/AI-Homelab/issues)
- **Discussions**: [GitHub Discussions](https://github.com/kelinfoxy/AI-Homelab/discussions)
- **Issues**: [GitHub Issues](https://github.com/kelinfoxy/EZ-Homelab/issues)
- **Discussions**: [GitHub Discussions](https://github.com/kelinfoxy/EZ-Homelab/discussions)
- **Documentation**: This wiki is the primary source of truth
## 📈 Project Status
@@ -147,5 +147,5 @@ AI-Homelab/
---
*This wiki is automatically maintained and serves as the single source of truth for the AI-Homelab project. All information is kept current with the latest documentation.*</content>
*This wiki is automatically maintained and serves as the single source of truth for the EZ-Homelab project. All information is kept current with the latest documentation.*</content>
<parameter name="filePath">c:\Users\kelin\Documents\Apps\GitHub\AI-Homelab\wiki\Home.md

12
wiki/README.md
View File

@@ -1,6 +1,6 @@
# AI-Homelab Wiki
# EZ-Homelab Wiki
This directory contains the **complete wiki documentation** for the AI-Homelab project, serving as the **single source of truth** for all project information.
This directory contains the **complete wiki documentation** for the EZ-Homelab project, serving as the **single source of truth** for all project information.
## 📖 Wiki Structure
@@ -50,7 +50,7 @@ This directory contains the **complete wiki documentation** for the AI-Homelab p
## 🎯 Purpose
This wiki serves as the **authoritative source of truth** for the AI-Homelab project, containing:
This wiki serves as the **authoritative source of truth** for the EZ-Homelab project, containing:
- ✅ **Complete Documentation** - All setup guides, configuration options, and troubleshooting
- ✅ **Service Catalog** - Detailed information for all 70+ available services
@@ -127,7 +127,7 @@ When contributing to the wiki:
---
*This wiki represents the complete knowledge base for the AI-Homelab project and serves as the primary reference for all users and contributors.*
*This wiki represents the complete knowledge base for the EZ-Homelab project and serves as the primary reference for all users and contributors.*
### 📦 Services & Stacks
@@ -269,7 +269,7 @@ Services that provide alternatives to the defaults:
### 📚 Additional Resources
- **[GitHub Repository](https://github.com/kelinfoxy/AI-Homelab)** - Source code and issues
- **[GitHub Repository](https://github.com/kelinfoxy/EZ-Homelab)** - Source code and issues
- **[Docker Hub](https://hub.docker.com)** - Container images
- **[Traefik Documentation](https://doc.traefik.io/traefik/)** - Official reverse proxy docs
- **[Authelia Documentation](https://www.authelia.com/)** - SSO documentation
@@ -279,7 +279,7 @@ Services that provide alternatives to the defaults:
## 🎯 Quick Navigation
**New to AI-Homelab?** → [Getting Started](getting-started.md)
**New to EZ-Homelab?** → [Getting Started](getting-started.md)
**Need to add a service?** → [Service Creation Guide](docker-guidelines.md#service-creation-guidelines)

4
wiki/Service-Documentation.md
View File

@@ -2,7 +2,7 @@
## Overview
This section contains detailed documentation for all 70+ services available in the AI-Homelab. Each service has its own documentation page with setup instructions, configuration options, and troubleshooting guides.
This section contains detailed documentation for all 70+ services available in the EZ-Homelab. Each service has its own documentation page with setup instructions, configuration options, and troubleshooting guides.
## Service Categories
@@ -195,5 +195,5 @@ Use the alphabetical list above or search for the specific service.
- **Intermediate**: Nextcloud, Gitea, BookStack
- **Advanced**: GitLab, Home Assistant, Prometheus
Each service page provides complete setup instructions and is designed to work with the AI-Homelab's file-based, AI-manageable architecture.</content>
Each service page provides complete setup instructions and is designed to work with the EZ-Homelab's file-based, AI-manageable architecture.</content>
<parameter name="filePath">c:\Users\kelin\Documents\Apps\GitHub\AI-Homelab\wiki\Service-Documentation.md

2
wiki/Services-Overview.md
View File

@@ -1,6 +1,6 @@
# Services Overview
This document provides a comprehensive overview of all 50+ pre-configured services available in the AI-Homelab repository.
This document provides a comprehensive overview of all 50+ pre-configured services available in the EZ-Homelab repository.
## Services Overview

2
wiki/System-Architecture.md
View File

@@ -2,7 +2,7 @@
## Overview
The AI-Homelab implements a **layered, production-ready architecture** designed for reliability, security, and ease of management. The system is built around Docker containers orchestrated through Traefik reverse proxy with Authelia SSO authentication.
The EZ-Homelab implements a **layered, production-ready architecture** designed for reliability, security, and ease of management. The system is built around Docker containers orchestrated through Traefik reverse proxy with Authelia SSO authentication.
## Core Principles

10
wiki/_Footer.md
View File

@@ -1,12 +1,12 @@
# AI-Homelab Wiki Footer
# EZ-Homelab Wiki Footer
## 📖 Quick Links
- [[Home]] | [[Getting Started Guide]] | [[Services Overview]]
- [[Quick Reference]] | [[Troubleshooting]] | [[AI Management Guide]]
## 🆘 Need Help?
- **Issues**: [GitHub Issues](https://github.com/kelinfoxy/AI-Homelab/issues)
- **Discussions**: [GitHub Discussions](https://github.com/kelinfoxy/AI-Homelab/discussions)
- **Issues**: [GitHub Issues](https://github.com/kelinfoxy/EZ-Homelab/issues)
- **Discussions**: [GitHub Discussions](https://github.com/kelinfoxy/EZ-Homelab/discussions)
- **Documentation**: This wiki is the primary source of truth
## 📊 Project Status
@@ -22,8 +22,8 @@
- [[Code Standards]] - Development best practices
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/kelinfoxy/AI-Homelab/blob/main/LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](https://github.com/kelinfoxy/EZ-Homelab/blob/main/LICENSE) file for details.
---
*Last updated: January 21, 2026 | AI-Homelab Wiki*</content>
*Last updated: January 21, 2026 | EZ-Homelab Wiki*</content>
<parameter name="filePath">c:\Users\kelin\Documents\Apps\GitHub\AI-Homelab\wiki\_Footer.md

6
wiki/_Sidebar.md
View File

@@ -1,4 +1,4 @@
# AI-Homelab Wiki Navigation
# EZ-Homelab Wiki Navigation
## 🚀 Getting Started
- [[Home]] - Wiki overview and navigation
@@ -43,12 +43,12 @@
- [[Core Stack README]] - Core infrastructure details
## 📚 External Links
- [GitHub Repository](https://github.com/kelinfoxy/AI-Homelab)
- [GitHub Repository](https://github.com/kelinfoxy/EZ-Homelab)
- [Docker Hub](https://hub.docker.com)
- [Traefik Documentation](https://doc.traefik.io/traefik/)
- [Authelia Documentation](https://www.authelia.com/)
- [DuckDNS](https://www.duckdns.org/)
---
*This wiki serves as the single source of truth for the AI-Homelab project.*</content>
*This wiki serves as the single source of truth for the EZ-Homelab project.*</content>
<parameter name="filePath">c:\Users\kelin\Documents\Apps\GitHub\AI-Homelab\wiki\_Sidebar.md

4
wiki/troubleshooting/COMMON-ISSUES.md
View File

@@ -142,7 +142,7 @@ nslookup yourdomain.duckdns.org
**Solutions:**
```bash
# Check credentials in .env
cat ~/AI-Homelab/.env | grep SURFSHARK
cat ~/EZ-Homelab/.env | grep SURFSHARK
# Check Gluetun logs
sudo docker logs gluetun
@@ -279,7 +279,7 @@ docker run --rm \
4. **Verify configuration:**
```bash
# Check .env file
cat ~/AI-Homelab/.env
cat ~/EZ-Homelab/.env
# Check compose file
cat /opt/stacks/stack-name/docker-compose.yml

6
wiki/troubleshooting/SSL-CERTIFICATES-DUCKDNS.md
View File

@@ -174,10 +174,10 @@ Keep DuckDNS for dynamic IP updates, but use different DNS for certificates:
## Files to Update in Repository
### ~/AI-Homelab/stacks/core/traefik/traefik.yml
### ~/EZ-Homelab/stacks/core/traefik/traefik.yml
Document both HTTP and DNS challenge configurations with clear comments.
### ~/AI-Homelab/stacks/core/docker-compose.yml
### ~/EZ-Homelab/stacks/core/docker-compose.yml
Ensure wildcard domain configuration is correct (it is currently):
```yaml
- "traefik.http.routers.traefik.tls.domains[0].main=${DOMAIN}"
@@ -185,7 +185,7 @@ Ensure wildcard domain configuration is correct (it is currently):
```
**This is correct** - keep both apex and wildcard.
### ~/AI-Homelab/docs/service-docs/traefik.md
### ~/EZ-Homelab/docs/service-docs/traefik.md
Add troubleshooting section for DuckDNS DNS challenge issues.
## Success Criteria for Next Test