EZ-Homelab/wiki-update/README.md

EZ-Homelab Wiki

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

Core Documentation

• Home.md - Main wiki page with overview and navigation
• _Sidebar.md - Wiki navigation sidebar
• _Footer.md - Footer with quick links and project info

Getting Started

• Getting-Started-Guide.md - Complete setup instructions
• Environment-Configuration.md - Required settings and tokens
• Automated-Setup.md - One-click deployment process
• Manual-Setup.md - Step-by-step manual installation
• Post-Setup-Guide.md - Post-deployment configuration

Architecture & Design

• System-Architecture.md - High-level component overview
• Docker-Guidelines.md - Service management patterns
• Ports-in-Use.md - Complete port mapping reference
• SSL-Certificates.md - HTTPS and certificate management

Services & Documentation

• Services-Overview.md - All 50+ services catalog
• Service-Documentation.md - Individual service guides index
• service-docs/ - Individual service documentation files
• Core-Infrastructure.md - Essential services guide
• Infrastructure-Services.md - Management tools guide

Operations & Management

• Quick-Reference.md - Command cheat sheet
• Backup-Strategy.md - Restic + Backrest comprehensive guide
• Proxying-External-Hosts.md - Connect non-Docker services
• Resource-Limits-Template.md - Performance optimization
• troubleshooting/ - Issue resolution guides

AI & Automation

• AI-Management-Guide.md - Using AI for homelab management
• Copilot-Instructions.md - AI assistant configuration
• AI-VS-Code-Setup.md - Development environment setup
• AI-Management-Prompts.md - Sample AI interactions

Additional Resources

• How-It-Works.md - System architecture explanation
• Authelia-Customization.md - SSO configuration options
• On-Demand-Remote-Services.md - Lazy loading configuration
• action-reports/ - Deployment logs and reports

🎯 Purpose

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 50+ available services
• ✅ Architecture Guides - System design, network configuration, and security models
• ✅ AI Integration - Copilot instructions and AI management capabilities
• ✅ Operational Guides - Backup strategies, monitoring, and maintenance
• ✅ Reference Materials - Port mappings, resource limits, and quick references

📋 Wiki Standards

Naming Convention

• Use Title-Case-With-Dashes.md for file names
• Match wiki link format: [[Wiki Links]]
• Descriptive, searchable titles

Content Organization

• Headers: Use # ## ### hierarchy
• Links: Use [[Wiki Links]] for internal references
• Code: Use backticks for commands and file paths
• Lists: Use bullet points for features/options

Maintenance

• Single Source of Truth: All information kept current
• Comprehensive: No missing critical information
• Accurate: Verified configurations and commands
• Accessible: Clear language, logical organization

🔄 Synchronization

This wiki is automatically synchronized with the main documentation in ../docs/ and should be updated whenever:

• New services are added
• Configuration changes are made
• Documentation is updated
• New features are implemented

📖 Usage

For Users

• Start with Home.md for overview
• Use _Sidebar.md for navigation
• Search for specific topics or services
• Reference individual service documentation

For Contributors

• Update wiki when modifying documentation
• Add new pages for new features
• Maintain link integrity
• Keep information current

For AI Management

• Copilot uses this wiki as reference
• Contains complete system knowledge
• Provides context for AI assistance
• Enables intelligent homelab management

🤝 Contributing

When contributing to the wiki:

1. Update Content: Modify relevant pages with new information
2. Check Links: Ensure all internal links work
3. Update Navigation: Add new pages to _Sidebar.md if needed
4. Verify Accuracy: Test commands and configurations
5. Maintain Standards: Follow naming and formatting conventions

📊 Wiki Statistics

• Total Pages: 25+ main pages
• Service Docs: 50+ individual service guides
• Categories: 10 service categories
• Topics Covered: Setup, configuration, troubleshooting, architecture
• Last Updated: January 21, 2026

---

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

Core Infrastructure (Deploy First)

Essential services that everything else depends on:

• DuckDNS - Dynamic DNS updates
• Traefik - Reverse proxy & SSL termination
• Authelia - Single Sign-On authentication
• Gluetun - VPN client for secure downloads
• Sablier - Lazy loading service for on-demand containers

Management & Monitoring

• Dockge - Primary stack management UI
• Homepage - Service dashboard (AI-configurable)
• Homarr - Alternative modern dashboard
• Dozzle - Real-time log viewer
• Glances - System monitoring
• Pi-hole - DNS & ad blocking

Media Services

• Jellyfin - Open-source media streaming
• Plex - Popular media server (alternative)
• qBittorrent - Torrent client (VPN-routed)
• Calibre-Web - Ebook reader & server

Media Management (Arr Stack)

• Sonarr - TV show automation
• Radarr - Movie automation
• Prowlarr - Indexer management
• Readarr - Ebook/audiobook automation
• Lidarr - Music library management
• Bazarr - Subtitle automation
• Jellyseerr - Media request interface

Home Automation

• Home Assistant - Smart home platform
• Node-RED - Flow-based programming
• Zigbee2MQTT - Zigbee device integration
• ESPHome - ESP device firmware
• TasmoAdmin - Tasmota device management
• MotionEye - Video surveillance

Productivity & Collaboration

• Nextcloud - Self-hosted cloud storage
• Gitea - Git service (GitHub alternative)
• BookStack - Documentation/wiki platform
• WordPress - Blog/CMS platform
• MediaWiki - Wiki platform
• DokuWiki - Simple wiki
• Excalidraw - Collaborative drawing

Development Tools

• Code Server - VS Code in the browser
• GitLab - Complete DevOps platform
• Jupyter - Interactive computing
• pgAdmin - PostgreSQL administration

Monitoring & Observability

• Grafana - Metrics visualization
• Prometheus - Metrics collection
• Uptime Kuma - Uptime monitoring
• Loki - Log aggregation
• Promtail - Log shipping
• Node Exporter - System metrics
• cAdvisor - Container metrics

Utilities & Tools

• Backrest - Backup management (Restic-based, default)
• Duplicati - Alternative backup solution
• FreshRSS - RSS feed reader
• Wallabag - Read-it-later service
• Watchtower - Automatic updates
• Vaultwarden - Password manager

Alternative Services

Services that provide alternatives to the defaults:

• Portainer - Alternative container management
• Authentik - Alternative SSO with web UI

🛠️ Development & Operations

Docker & Container Management

• Docker Guidelines - Complete service management guide
• Service Creation - How to add new services
• Service Modification - Updating existing services
• Resource Limits - CPU/memory management
• Troubleshooting - Common issues & fixes

External Service Integration

• Proxying External Hosts - Route non-Docker services through Traefik
• External Host Examples - Raspberry Pi, NAS, etc.

AI & Automation

• Copilot Instructions - AI agent guidelines for this codebase
• AI Management Capabilities - What the AI can help with

📋 Quick References

Commands & Operations

• Quick Reference - Essential commands and workflows
• Stack Management - Start/stop/restart services
• Deployment Scripts - Setup and deployment automation

Troubleshooting

• Common Issues - SSL, networking, permissions
• Service Won't Start - Debugging steps
• Traefik Routing - Route configuration issues
• VPN Problems - Gluetun troubleshooting

📖 Advanced Topics

SSL & Certificates

• Wildcard SSL Setup - How SSL certificates work
• Certificate Troubleshooting - SSL issues and fixes
• DNS Challenge Process - How domain validation works

Security & Access Control

• Authelia Configuration - SSO setup and customization
• Bypass Rules - When to skip authentication
• 2FA Setup - Two-factor authentication

Backup & Recovery

• Backup Strategies - Data protection approaches
• Service Backups - Database backup solutions
• Configuration Backup - Config file preservation

🔧 Development & Contributing

Repository Structure

• File Organization - How files are organized
• Service Documentation - Individual service guides
• Configuration Templates - Reusable configurations
• Scripts - Automation and deployment tools

Development Workflow

• Adding Services - New service integration
• Testing Changes - Validation procedures
• Resource Limits - Performance management

📚 Additional Resources

• GitHub Repository - Source code and issues
• Docker Hub - Container images
• Traefik Documentation - Official reverse proxy docs
• Authelia Documentation - SSO documentation
• DuckDNS - Dynamic DNS service

---

🎯 Quick Navigation

New to EZ-Homelab? → Getting Started

Need to add a service? → Service Creation Guide

Having issues? → Troubleshooting

Want to contribute? → Development Workflow

---

This documentation is maintained by AI and community contributors. Last updated: January 20, 2026