7797f89fcb
Add complete centralized logging solution for all Docker containers. New services: - Loki: Log aggregation backend (loki.fig.systems) - Promtail: Log collection agent - Grafana: Log visualization (logs.fig.systems) Features: - Automatic Docker container discovery - 30-day log retention (configurable) - Powerful LogQL querying - Pre-configured Grafana datasource - Comprehensive documentation Resources: - ~400-700MB RAM for 20 containers - Automatic labeling by container/project/service - SSO protection for Loki API Documentation: - Complete setup guide - Query examples and patterns - Troubleshooting steps - Best practices |
||
|---|---|---|
| .. | ||
| guides | ||
| services | ||
| troubleshooting | ||
| getting-started.md | ||
| quick-reference.md | ||
| README.md | ||
Homelab Documentation
Welcome to the homelab documentation! This folder contains comprehensive guides for setting up, configuring, and maintaining your self-hosted services.
📚 Documentation Structure
Quick Start
- Getting Started - First-time setup walkthrough
- Quick Reference - Common commands and URLs
Configuration
- Environment Variables & Secrets - How to configure secure secrets
- DNS Configuration - Setting up domain names
- SSL/TLS Certificates - Let's Encrypt configuration
- GPU Acceleration - NVIDIA GPU setup for Jellyfin and Immich
Services
- Service Overview - All available services
- SSO Configuration - Single Sign-On with LLDAP and Tinyauth
- Media Stack - Jellyfin, Sonarr, Radarr setup
- Backup Solutions - Backrest configuration
Troubleshooting
- Common Issues - Frequent problems and solutions
- FAQ - Frequently asked questions
- Debugging Guide - How to diagnose problems
Operations
- Maintenance - Regular maintenance tasks
- Updates - Updating services
- Backups - Backup and restore procedures
- Monitoring - Service monitoring
🚀 Quick Links
First Time Setup
Common Tasks
- Add a new service
- Generate secure passwords
- Enable GPU acceleration
- Backup configuration
- Update a service
Troubleshooting
📖 Documentation Conventions
Throughout this documentation:
command- Commands to run in terminal- Bold - Important concepts or UI elements
https://service.fig.systems- Example URLs- ⚠️ - Warning or important note
- 💡 - Tip or helpful information
- ✅ - Verified working configuration
🔐 Security Notes
Before deploying to production:
- ✅ Change all passwords in
.envfiles - ✅ Configure DNS records
- ✅ Verify SSL certificates are working
- ✅ Enable backups
- ✅ Review security settings
🆘 Getting Help
If you encounter issues:
- Check Common Issues
- Review FAQ
- Check service logs:
docker compose logs servicename - Review the Debugging Guide
📝 Contributing to Documentation
Found an error or have a suggestion? Documentation improvements are welcome!
- Keep guides clear and concise
- Include examples and code snippets
- Test all commands before documenting
- Update the table of contents when adding new files
🔄 Last Updated
This documentation is automatically maintained and reflects the current state of the homelab repository.