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

docs: explicitly document wildcard SSL certificate usage

Browse Source 
- README.md: Updated Traefik feature to mention wildcard certificates via DNS challenge
- README.md: Added wildcard cert note to deployment script section
- getting-started.md: Explicitly mention wildcard certificate generation in deploy step

All documentation now clearly states the project uses wildcard SSL certificates with DNS challenge.
This commit is contained in:
kelin
2026-01-13 23:15:23 -05:00
parent 9f122af4b5
commit a916d48776
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -24,7 +24,7 @@ The infrastructure uses Traefik for reverse proxy with automatic SSL, Authelia f
- **Automated Setup & Deployment**: Two-script installation process with intelligent error handling - **Automated Setup & Deployment**: Two-script installation process with intelligent error handling
- **Dockge Structure**: All stacks organized in `/opt/stacks/` for easy management via Dockge web UI - **Dockge Structure**: All stacks organized in `/opt/stacks/` for easy management via Dockge web UI
- **60+ Pre-configured Services**: Production-ready compose files across infrastructure, media, home automation, productivity, and monitoring - **60+ Pre-configured Services**: Production-ready compose files across infrastructure, media, home automation, productivity, and monitoring
- **Traefik Reverse Proxy**: Automatic HTTPS with Let's Encrypt via file-based configuration (no web UI needed) - **Traefik Reverse Proxy**: Automatic HTTPS with Let's Encrypt wildcard certificates via DNS challenge
- **Authelia SSO**: Single Sign-On protection for all admin interfaces with automated password generation - **Authelia SSO**: Single Sign-On protection for all admin interfaces with automated password generation
- **Gluetun VPN**: Surfshark WireGuard integration for secure downloads - **Gluetun VPN**: Surfshark WireGuard integration for secure downloads
- **Homepage Dashboard**: AI-configurable dashboard with automatic domain variable replacement - **Homepage Dashboard**: AI-configurable dashboard with automatic domain variable replacement
@@ -104,7 +104,7 @@ The infrastructure uses Traefik for reverse proxy with automatic SSL, Authelia f
This automated script will: This automated script will:
- Configure Traefik with your email and domain - Configure Traefik with your email and domain
- Deploy admin password from setup script - **Obtain wildcard SSL certificate** (*.yourdomain.duckdns.org) via DNS challenge
- Deploy core stack (DuckDNS, Traefik, Authelia, Gluetun) - 4 services - Deploy core stack (DuckDNS, Traefik, Authelia, Gluetun) - 4 services
- Deploy infrastructure stack (Dockge, Pi-hole, monitoring) - 6 services - Deploy infrastructure stack (Dockge, Pi-hole, monitoring) - 6 services
- Deploy dashboards stack (Homepage with configured URLs, Homarr) - 2 services - Deploy dashboards stack (Homepage with configured URLs, Homarr) - 2 services
@@ -116,7 +116,7 @@ The infrastructure uses Traefik for reverse proxy with automatic SSL, Authelia f
./scripts/deploy-homelab.sh ./scripts/deploy-homelab.sh
``` ```
**Note:** The script will prompt to optionally pre-pull images for additional stacks. This takes time but speeds up future deployments. Default is no. **Note:** The script will prompt to optionally pre-pull images for additional stacks. This takes time but speeds up future deployments. Default is no. Wildcard certificate generation takes 2-5 minutes.
5. **Deploy additional stacks through Dockge:** 5. **Deploy additional stacks through Dockge:**

6
docs/getting-started.md
View File

@@ -77,13 +77,15 @@ For most users, the automated setup script handles everything:
**The deploy script automatically:** **The deploy script automatically:**
- Creates Docker networks - Creates Docker networks
- Configures Traefik with your email - Configures Traefik with your email and domain
- Generates Authelia admin password (saved to `/opt/stacks/core/authelia/ADMIN_PASSWORD.txt`) - **Obtains wildcard SSL certificate** (*.yourdomain.duckdns.org) via DNS challenge
- Deploys core stack (DuckDNS, Traefik, Authelia, Gluetun) - Deploys core stack (DuckDNS, Traefik, Authelia, Gluetun)
- Deploys infrastructure stack (Dockge, Pi-hole, monitoring) - Deploys infrastructure stack (Dockge, Pi-hole, monitoring)
- Deploys dashboards stack (Homepage, Homarr) - Deploys dashboards stack (Homepage, Homarr)
- Opens Dockge in your browser - Opens Dockge in your browser
**Note:** Certificate generation may take 2-5 minutes. All services will use the wildcard certificate automatically.
**Login credentials:** **Login credentials:**
- Username: `admin` (default username - or the custom username you specified during setup) - Username: `admin` (default username - or the custom username you specified during setup)
- Password: The secure password you created when prompted by the setup script - Password: The secure password you created when prompted by the setup script