This directory contains detailed documentation for the various components of the homelab.
The homelab is a GitOps-managed Kubernetes cluster built with K3S, Flux CD, and a variety of self-hosted applications. This documentation provides detailed information about the different components of the homelab.
- Networking: Details about the networking setup, including MetalLB, Traefik, and DNS configuration
- Storage: Information about the storage setup, including Democratic CSI, Longhorn, and backup strategy
- Media Stack: Documentation for the media management applications, including Sonarr, Radarr, and Jellyfin
- Home Automation: Details about the home automation setup, including Home Assistant, MQTT, and device integration
- Monitoring: Information about the monitoring stack, including Gatus health checking
- Gatus PostgreSQL Backend: Details about the PostgreSQL backend implementation for Gatus
- Authentication: Documentation for the authentication setup using Authentik
- Backup Strategy: Details about the backup strategy, including VolSync, CloudNative PG backups, and Cloudflare R2
If you're new to the homelab, start with the main README.md in the root directory for an overview of the entire project. Then, explore the specific documentation for the components you're interested in.
If you'd like to contribute to the documentation, please follow these guidelines:
- Use Markdown for all documentation
- Follow the existing structure and style
- Include detailed information about configuration, networking, storage, and troubleshooting
- Add diagrams where appropriate to visualize complex setups
Each component's documentation includes a troubleshooting section with common issues and solutions. If you encounter an issue that's not covered in the documentation, please consider adding it to help others in the future.