Standardize .env.example files with complete variables and empty values

Changes: - Reviewed all docker-compose files to identify required variables - Updated all .env.example files to include ONLY variables used in their respective compose files - Changed all placeholder values to empty strings for cleaner configuration - Fixed variable name inconsistency: DOWNLOADS_DIR -> DOWNLOAD_DIR (to match main .env) - Removed unnecessary variables that aren't used by the compose files All .env.example files now: - Contain only the variables actually used in the stack - Have empty values instead of example placeholders - Match the variable names used in docker-compose files This ensures clean, minimal .env files for each stack without any extraneous variables or confusing placeholder values.
2026-02-10 19:14:53 -05:00
parent 96c7ff39a4
commit f318170d02
18 changed files with 166 additions and 122 deletions
--- a/docker-compose/alternatives/.env.example
+++ b/docker-compose/alternatives/.env.example
@@ -2,10 +2,16 @@
 # These variables are used for alternative services (Plex, Authentik, etc.)

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=

 # Directory Configuration
-STACKS_DIR=/opt/stacks
-MEDIA_DIR=/mnt/media
+MEDIA_DIR=
+
+# Plex Configuration
+PLEX_CLAIM=
+
+# Authentik Configuration
+AUTHENTIK_SECRET_KEY=
+AUTHENTIK_DB_NAME=
+AUTHENTIK_DB_USER=
+AUTHENTIK_DB_PASSWORD=
--- a/docker-compose/arcane/.env.example
+++ b/docker-compose/arcane/.env.example
@@ -1,11 +1,19 @@
 # Arcane Stack Environment Variables
 # These variables are used for Arcane Docker Management UI

-# Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+# Server Configuration
+SERVER_IP=
+
+# User Configuration
+PUID=
+PGID=

 # Directory Configuration
-STACKS_DIR=/opt/stacks
-PROJECTS_DIR=/opt/stacks
+PROJECTS_DIR=
+
+# Arcane Configuration
+ARCANE_ENCRYPTION_KEY=
+ARCANE_JWT_SECRET=
+
+# Optional: Agent Configuration
+ARCANE_AGENT_TOKEN=
--- a/docker-compose/core/.env.example
+++ b/docker-compose/core/.env.example
@@ -1,32 +1,26 @@
 # Core Stack Environment Variables
-# These variables are used for Traefik, Authelia, and DuckDNS
+# These variables are used for Traefik, Authelia, DuckDNS, and Pi-hole

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=
+
+# Server Configuration
+SERVER_IP=
+
+# User Configuration
+PUID=
+PGID=

 # DuckDNS Configuration
-DUCKDNS_SUBDOMAINS=yourdomain
-DUCKDNS_TOKEN=your-token-here
+DUCKDNS_SUBDOMAINS=
+DUCKDNS_TOKEN=

-# Directory Configuration  
-STACKS_DIR=/opt/stacks
+# Pi-hole Configuration
+PIHOLE_PASSWORD=

-# Admin Configuration
-DEFAULT_USER=admin
-DEFAULT_PASSWORD=changeme
-DEFAULT_EMAIL=admin@example.com
-
-# Authelia Configuration
+# Authelia Configuration (Generated by script)
 AUTHELIA_JWT_SECRET=
 AUTHELIA_SESSION_SECRET=
 AUTHELIA_STORAGE_ENCRYPTION_KEY=
 AUTHELIA_ADMIN_PASSWORD_HASH=
-
-# SMTP Configuration (Optional)
-SMTP_HOST=smtp.gmail.com
-SMTP_PORT=587
-SMTP_USERNAME=
-SMTP_PASSWORD=
-SMTP_SENDER=noreply@example.com
--- a/docker-compose/dashboards/.env.example
+++ b/docker-compose/dashboards/.env.example
@@ -2,18 +2,15 @@
 # These variables are used for Homepage and Homarr

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=

-# Server Configuration
-SERVER_IP=192.168.1.100
+# User Configuration
+PUID=
+PGID=

 # Directory Configuration
-STACKS_DIR=/opt/stacks
+STACKS_DIR=

 # Homepage Configuration
-HOMEPAGE_VAR_TITLE=My Homelab
-
-# Grafana Configuration (if used)
-GRAFANA_ADMIN_PASSWORD=changeme
+HOMEPAGE_ALLOWED_HOSTS=
--- a/docker-compose/dockge/.env.example
+++ b/docker-compose/dockge/.env.example
@@ -2,9 +2,8 @@
 # These variables are used in docker-compose labels and configuration

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+SERVER_HOSTNAME=

 # Directory Configuration
-STACKS_DIR=/opt/stacks
+STACKS_DIR=
--- a/docker-compose/homeassistant/.env.example
+++ b/docker-compose/homeassistant/.env.example
@@ -2,9 +2,5 @@
 # These variables are used for Home Assistant and related services

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
-
-# Directory Configuration
-STACKS_DIR=/opt/stacks
+DOMAIN=
+TZ=
--- a/docker-compose/infrastructure/.env.example
+++ b/docker-compose/infrastructure/.env.example
@@ -1,17 +1,16 @@
 # Infrastructure Stack Environment Variables
-# These variables are used for Pi-hole, Watchtower, Dozzle, Glances
+# These variables are used for Watchtower, Dozzle, Glances, Code Server

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
-
-# Pi-hole Configuration
-PIHOLE_WEBPASSWORD=changeme
-
-# Code Server Configuration
-CODE_SERVER_PASSWORD=changeme
-CODE_SERVER_SUDO_PASSWORD=changeme
+DOMAIN=
+TZ=

 # Directory Configuration
-STACKS_DIR=/opt/stacks
+STACKS_DIR=
+
+# Code Server Configuration
+CODE_SERVER_PASSWORD=
+CODE_SERVER_SUDO_PASSWORD=
+
+# Watchtower Configuration (Optional)
+WATCHTOWER_NOTIFICATION_URL=
--- a/docker-compose/media-management/.env.example
+++ b/docker-compose/media-management/.env.example
@@ -2,10 +2,12 @@
 # These variables are used for Sonarr, Radarr, Prowlarr, etc.

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=
+
+# User Configuration
+PUID=

 # Directory Configuration
-MEDIA_DIR=/mnt/media
-DOWNLOAD_DIR=/mnt/downloads
+MEDIA_DIR=
+DOWNLOAD_DIR=
--- a/docker-compose/media-management/docker-compose.yml
+++ b/docker-compose/media-management/docker-compose.yml
@@ -18,7 +18,7 @@ services:
    volumes:
      - ./sonarr/config:/config
      - ${MEDIA_DIR}:/media
-      - ${DOWNLOADS_DIR}:/downloads # Large downloads on separate drive
+      - ${DOWNLOAD_DIR}:/downloads # Large downloads on separate drive
    environment:
      - PUID=${PUID}
      - PGID=${PUID}
@@ -63,7 +63,7 @@ services:
    volumes:
      - ./radarr/config:/config
      - ${MEDIA_DIR}:/media
-      - ${DOWNLOADS_DIR}:/downloads # Large downloads on separate drive
+      - ${DOWNLOAD_DIR}:/downloads # Large downloads on separate drive
    environment:
      - PUID=${PUID}
      - PGID=${PUID}
@@ -152,7 +152,7 @@ services:
    volumes:
      - ./readarr/config:/config
      - ${MEDIA_DIR}/books:/books
-      - ${DOWNLOADS_DIR}:/downloads
+      - ${DOWNLOAD_DIR}:/downloads
    environment:
      - PUID=${PUID}
      - PGID=${PUID}
@@ -191,7 +191,7 @@ services:
    volumes:
      - ./lidarr/config:/config
      - ${MEDIA_DIR}/music:/music
-      - ${DOWNLOADS_DIR}:/downloads
+      - ${DOWNLOAD_DIR}:/downloads
    environment:
      - PUID=${PUID}
      - PGID=${PUID}
@@ -230,7 +230,7 @@ services:
    volumes:
      - ./lazylibrarian/config:/config
      - ${MEDIA_DIR}/books:/books
-      - ${DOWNLOADS_DIR}:/downloads
+      - ${DOWNLOAD_DIR}:/downloads
    environment:
      - PUID=${PUID}
      - PGID=${PUID}
@@ -270,7 +270,7 @@ services:
    volumes:
      - ./mylar3/config:/config
      - ${MEDIA_DIR}/comics:/comics
-      - ${DOWNLOADS_DIR}:/downloads
+      - ${DOWNLOAD_DIR}:/downloads
    environment:
      - PUID=${PUID}
      - PGID=${PUID}
--- a/docker-compose/media/.env.example
+++ b/docker-compose/media/.env.example
@@ -2,9 +2,11 @@
 # These variables are used for Jellyfin, Calibre-web, etc.

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=
+
+# User Configuration
+PUID=

 # Directory Configuration
-MEDIA_DIR=/mnt/media
+MEDIA_DIR=
--- a/docker-compose/monitoring/.env.example
+++ b/docker-compose/monitoring/.env.example
@@ -2,12 +2,11 @@
 # These variables are used for Prometheus, Grafana, Uptime Kuma, etc.

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+
+# User Configuration
+PUID=
+PGID=

 # Grafana Configuration
-GRAFANA_ADMIN_PASSWORD=changeme
-
-# Directory Configuration
-STACKS_DIR=/opt/stacks
+GRAFANA_ADMIN_PASSWORD=
--- a/docker-compose/productivity/.env.example
+++ b/docker-compose/productivity/.env.example
@@ -2,15 +2,26 @@
 # These variables are used for productivity and collaboration tools

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=

-# Code Server Configuration
-CODE_SERVER_PASSWORD=changeme
+# User Configuration
+PUID=
+PGID=
+
+# Nextcloud Configuration
+NEXTCLOUD_DIR=
+NEXTCLOUD_ADMIN_USER=
+NEXTCLOUD_ADMIN_PASSWORD=
+NEXTCLOUD_DB_PASSWORD=
+NEXTCLOUD_DB_ROOT_PASSWORD=
+
+# WordPress Configuration
+WORDPRESS_DB_PASSWORD=
+WORDPRESS_DB_ROOT_PASSWORD=
+
+# Gitea Configuration
+GITEA_DB_PASSWORD=

 # Jupyter Configuration
-JUPYTER_TOKEN=changeme
-
-# Directory Configuration
-STACKS_DIR=/opt/stacks
+JUPYTER_TOKEN=
--- a/docker-compose/sablier/.env.example
+++ b/docker-compose/sablier/.env.example
@@ -2,6 +2,4 @@
 # These variables are used for Sablier lazy loading service

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
--- a/docker-compose/transcoders/.env.example
+++ b/docker-compose/transcoders/.env.example
@@ -2,9 +2,14 @@
 # These variables are used for Tdarr, Unmanic

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=
+
+# User Configuration
+PUID=
+PGID=

 # Directory Configuration
-MEDIA_DIR=/mnt/media
+MEDIA_DIR=
+TDARR_TRANSCODE_DIR=
+UNMANIC_TRANSCODE_DIR=
--- a/docker-compose/utilities/.env.example
+++ b/docker-compose/utilities/.env.example
@@ -2,9 +2,29 @@
 # These variables are used for backup and utility services

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=
+
+# User Configuration
+PUID=
+PGID=

 # Directory Configuration
-STACKS_DIR=/opt/stacks
+STACKS_DIR=
+
+# Bitwarden Configuration
+BITWARDEN_SIGNUPS_ALLOWED=
+BITWARDEN_INVITATIONS_ALLOWED=
+BITWARDEN_ADMIN_TOKEN=
+
+# Form.io Configuration
+FORMIO_JWT_SECRET=
+FORMIO_DB_SECRET=
+
+# SMTP Configuration (Optional for Bitwarden)
+SMTP_HOST=
+SMTP_PORT=
+SMTP_USERNAME=
+SMTP_PASSWORD=
+SMTP_FROM=
+SMTP_SECURITY=
--- a/docker-compose/vpn/.env.example
+++ b/docker-compose/vpn/.env.example
@@ -2,12 +2,17 @@
 # These variables are used for VPN services

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=

-# qBittorrent Configuration
-QBITTORRENT_WEBUI_PASSWORD=changeme
+# User Configuration
+PUID=
+PGID=

 # Directory Configuration
-DOWNLOAD_DIR=/mnt/downloads
+DOWNLOAD_DIR=
+
+# VPN Configuration
+SURFSHARK_USERNAME=
+SURFSHARK_PASSWORD=
+VPN_SERVER_COUNTRIES=
--- a/docker-compose/vpn/docker-compose.yml
+++ b/docker-compose/vpn/docker-compose.yml
@@ -71,7 +71,7 @@ services:
    network_mode: 'service:gluetun'  # Routes through VPN in same compose file
    volumes:
      - ./qbittorrent/config:/config
-      - ${DOWNLOADS_DIR}:/downloads
+      - ${DOWNLOAD_DIR}:/downloads
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
--- a/docker-compose/wikis/.env.example
+++ b/docker-compose/wikis/.env.example
@@ -2,14 +2,17 @@
 # These variables are used for wiki and documentation platforms

 # Base Configuration
-DOMAIN=example.duckdns.org
-SERVER_HOSTNAME=myserver
-TZ=America/New_York
+DOMAIN=
+TZ=

-# Wiki Database Configuration
-POSTGRES_PASSWORD=changeme
-MEDIAWIKI_DB_PASSWORD=changeme
-BOOKSTACK_DB_PASSWORD=changeme
+# User Configuration
+PUID=
+PGID=

-# Directory Configuration
-STACKS_DIR=/opt/stacks
+# BookStack Database Configuration
+BOOKSTACK_DB_PASSWORD=
+BOOKSTACK_DB_ROOT_PASSWORD=
+
+# MediaWiki Database Configuration
+MEDIAWIKI_DB_PASSWORD=
+MEDIAWIKI_DB_ROOT_PASSWORD=