Welcome to the English documentation of the NCC-HomeLab project.
Comprehensive guides on important topics:
- Docker Swarm Guide - Complete guide to Docker Swarm
- Rootless Docker Guide - Complete guide to Rootless Docker
- Migration Guide - Step-by-step migration to Swarm
- Overview - Overview of Rootless Docker & Swarm
Documentation for individual services, organized by category:
- Traefik - Reverse Proxy Configuration
- CrowdSec - Security & Threat Detection
- DDNS Updater - Dynamic DNS Updates
- Portainer - Docker Management UI
- Watchtower - Auto-Updates
- Bitwarden - Password Manager
- OwnCloud - File Storage
- Pi-hole - DNS-based Ad Blocker
- WireGuard - VPN Server
- Tarpit - Security Monitoring
Step-by-step guides:
- Initial Setup - First-time setup
- Service Deployment - Deploying services
Quick references and cheatsheets:
- Quick Reference - Important commands & cheatsheet
- Security Overview - Security overview of all services
- First-time setup: Initial Setup Tutorial
- Setup Gateway: Traefik Setup
- Deploy services: Service Deployment
If you want to add improvements or new documentation:
- Create the documentation in Markdown
- Use the existing structure
- Add links to related documents
- Test all code examples
Note: Documentation is continuously expanded. Missing documents will be added gradually.