docs: implement user feedback from tasks.txt

- README.md: Fixed .env step order, updated to 60+ services - getting-started.md: Service count updates, credential clarifications, moved Manual Setup to separate file - manual-setup.md: Created comprehensive manual setup guide - authelia-customization.md: Moved Authelia customization from services-overview - services-overview.md: Added clickable links to service docs, removed disabled section and Quick Deployment - quick-reference.md: Linked to scripts/README.md instead of duplicating content - Removed services-reference.md as requested
2026-01-13 22:36:37 -05:00
parent ea4af44726
commit 3bad39567d
8 changed files with 565 additions and 341 deletions
--- a/docs/services-overview.md
+++ b/docs/services-overview.md
@@ -7,18 +7,16 @@ This document provides a comprehensive overview of all 60+ pre-configured servic
 | Stacks (10) | Services (70 + 6db) | SSO | Storage | Access URLs |
 |-------|----------|-----|---------|-------------|
 | **📦 core.yaml (4)** | **Deploy First** | | | |
-| ├─ DuckDNS | Dynamic DNS updater | - | /opt/stacks/core/duckdns | No UI |
-| ├─ Traefik | Reverse proxy + SSL | ✓ | /opt/stacks/core/traefik | traefik.${DOMAIN} |
-| ├─ Authelia | SSO authentication | - | /opt/stacks/core/authelia | auth.${DOMAIN} |
-| └─ Gluetun | VPN (Surfshark) | - | /opt/stacks/core/gluetun | No UI |
+| ├─ [DuckDNS](service-docs/duckdns.md) | Dynamic DNS updater | - | /opt/stacks/core/duckdns | No UI |
+| ├─ [Traefik](service-docs/traefik.md) | Reverse proxy + SSL | ✓ | /opt/stacks/core/traefik | traefik.${DOMAIN} |
+| ├─ [Authelia](service-docs/authelia.md) | SSO authentication | - | /opt/stacks/core/authelia | auth.${DOMAIN} |
+| └─ [Gluetun](service-docs/gluetun.md) | VPN (Surfshark) | - | /opt/stacks/core/gluetun | No UI |
 | **🔧 infrastructure.yaml (6+5)** | **Deployed: 6** | | | |
-| ├─ Dockge | Stack manager (PRIMARY) | ✓ | /opt/stacks/infrastructure | dockge.${DOMAIN} |
-| ├─ Pi-hole | DNS + Ad blocking | ✓ | /opt/stacks/infrastructure | pihole.${DOMAIN} |
-| ├─ Dozzle | Docker log viewer | ✓ | /opt/stacks/infrastructure | dozzle.${DOMAIN} |
-| ├─ Glances | System monitoring | ✓ | /opt/stacks/infrastructure | glances.${DOMAIN} |
-| └─ Docker Proxy | Secure socket access | - | /opt/stacks/infrastructure | No UI |
-| **⚠️ Disabled:** | | | | |
-| ├─ Watchtower | Auto updates (disabled) | - | Docker API issue | No UI |
+| ├─ [Dockge](service-docs/dockge.md) | Stack manager (PRIMARY) | ✓ | /opt/stacks/infrastructure | dockge.${DOMAIN} |
+| ├─ [Pi-hole](service-docs/pihole.md) | DNS + Ad blocking | ✓ | /opt/stacks/infrastructure | pihole.${DOMAIN} |
+| ├─ [Dozzle](service-docs/dozzle.md) | Docker log viewer | ✓ | /opt/stacks/infrastructure | dozzle.${DOMAIN} |
+| ├─ [Glances](service-docs/glances.md) | System monitoring | ✓ | /opt/stacks/infrastructure | glances.${DOMAIN} |
+| └─ [Docker Proxy](service-docs/docker-proxy.md) | Secure socket access | - | /opt/stacks/infrastructure | No UI |
 | **📦 alternatives.yaml (5)** | **Not deployed** | | | |
 | ├─ Portainer | Container management | ✓ | /opt/stacks/alternatives | portainer.${DOMAIN} |
 | ├─ Authentik Server | SSO with web UI | ✓ | /opt/stacks/alternatives | authentik.${DOMAIN} |
@@ -95,42 +93,6 @@ This document provides a comprehensive overview of all 60+ pre-configured servic

 **Legend:** ✓ = Protected by SSO | ✗ = Bypasses SSO | - = No web UI

-## Quick Deployment Order
-
-1. **Create Networks** (one-time setup)
-   ```bash
-   docker network create traefik-network
-   docker network create homelab-network
-   docker network create dockerproxy-network
-   ```
-
-2. **Deploy Core Stack** (required first)
-   ```bash
-   cd /opt/stacks/core/
-   docker compose up -d
-   ```
-
-3. **Deploy Infrastructure**
-   ```bash
-   cd /opt/stacks/infrastructure/
-   docker compose up -d
-   ```
-
-4. **Deploy Dashboards**
-   ```bash
-   cd /opt/stacks/dashboards/
-   docker compose up -d
-   ```
-
-5. **Deploy Additional Stacks** (as needed)
-   - Media: `/opt/stacks/media/`
-   - Extended Media: `/opt/stacks/media-extended/`
-   - Home Automation: `/opt/stacks/homeassistant/`
-   - Productivity: `/opt/stacks/productivity/`
-   - Utilities: `/opt/stacks/utilities/`
-   - Monitoring: `/opt/stacks/monitoring/`
-   - Development: `/opt/stacks/development/`
-
 ## Toggling SSO (Authelia) On/Off

 You can easily enable or disable SSO protection for any service by modifying its Traefik labels in the docker-compose.yml file.
@@ -192,137 +154,6 @@ docker compose -f /opt/stacks/stack-name/docker-compose.yml down
 - **Gradual Exposure**: Comment out SSO only when ready to expose a service
 - **Quick Toggle**: AI assistant can modify these labels automatically when you ask

-## Authelia Customization
-
-### Available Customization Options
-
-**1. Branding and Appearance**
-Edit `/opt/stacks/core/authelia/configuration.yml`:
-
-```yaml
-# Custom logo and branding
-theme: dark  # Options: light, dark, grey, auto
-
-# No built-in web UI for configuration
-# All settings managed via YAML files
-```
-
-**2. User Management**
-Users are managed in `/opt/stacks/core/authelia/users_database.yml`:
-
-```yaml
-users:
-  username:
-    displayname: "Display Name"
-    password: "$argon2id$v=19$m=65536..." # Generated with authelia hash-password
-    email: user@example.com
-    groups:
-      - admins
-      - users
-```
-
-Generate password hash:
-```bash
-docker run --rm authelia/authelia:4.37 authelia hash-password 'yourpassword'
-```
-
-**3. Access Control Rules**
-Customize who can access what in `configuration.yml`:
-
-```yaml
-access_control:
-  default_policy: deny
-  
-  rules:
-    # Public services (no auth)
-    - domain:
-        - "jellyfin.yourdomain.com"
-        - "plex.yourdomain.com"
-      policy: bypass
-    
-    # Admin only services
-    - domain:
-        - "dockge.yourdomain.com"
-        - "portainer.yourdomain.com"
-      policy: two_factor
-      subject:
-        - "group:admins"
-    
-    # All authenticated users
-    - domain: "*.yourdomain.com"
-      policy: one_factor
-```
-
-**4. Two-Factor Authentication (2FA)**
- TOTP (Time-based One-Time Password) via apps like Google Authenticator, Authy
- Configure in `configuration.yml` under `totp:` section
- Per-user enrollment via Authelia UI at `https://auth.${DOMAIN}`
-
-**5. Session Management**
-Edit `configuration.yml`:
-
-```yaml
-session:
-  name: authelia_session
-  expiration: 1h  # How long before re-login required
-  inactivity: 5m  # Timeout after inactivity
-  remember_me_duration: 1M  # "Remember me" checkbox duration
-```
-
-**6. Notification Settings**
-Email notifications for password resets, 2FA enrollment:
-
-```yaml
-notifier:
-  smtp:
-    host: smtp.gmail.com
-    port: 587
-    username: your-email@gmail.com
-    password: app-password
-    sender: authelia@yourdomain.com
-```
-
-### No Web UI for Configuration
-
-⚠️ **Important**: Authelia does **not** have a configuration web UI. All configuration is done via YAML files:
- `/opt/stacks/core/authelia/configuration.yml` - Main settings
- `/opt/stacks/core/authelia/users_database.yml` - User accounts
-
-This is **by design** and makes Authelia perfect for AI management and security-first approach:
- AI can read and modify YAML files
- Version control friendly
- No UI clicks required
- Infrastructure as code
- Secure by default
-
-**Web UI Available For:**
- Login page: `https://auth.${DOMAIN}`
- User profile: Change password, enroll 2FA
- Device enrollment: Manage trusted devices
-
-**Alternative with Web UI: Authentik**
-If you need a web UI for user management, Authentik is included in the infrastructure stack:
- **Authentik**: Full-featured SSO with web UI for user/group management
- Access at: `https://authentik.${DOMAIN}`
- Includes PostgreSQL database and Redis cache
- More complex but offers GUI-based configuration
- Deploy only if you need web-based user management
-
-**Other Alternatives:**
- **Keycloak**: Enterprise-grade SSO with web UI
- **Authelia + LDAP**: Use LDAP with web management (phpLDAPadmin, etc.)
-
-### Quick Configuration with AI
-
-Since all Authelia configuration is file-based, you can use the AI assistant to:
- Add/remove users
- Modify access rules
- Change session settings
- Update branding
- Enable/disable features
-
-Just ask: "Add a new user to Authelia" or "Change session timeout to 2 hours"
-
 ## Storage Recommendations

 | Data Type | Recommended Location | Reason |