From f318170d02d39ee8d92793f23a601c3d525ceba1 Mon Sep 17 00:00:00 2001 From: kelin Date: Tue, 10 Feb 2026 19:14:53 -0500 Subject: [PATCH] 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. --- docker-compose/alternatives/.env.example | 16 ++++++--- docker-compose/arcane/.env.example | 20 +++++++---- docker-compose/core/.env.example | 36 ++++++++----------- docker-compose/dashboards/.env.example | 17 ++++----- docker-compose/dockge/.env.example | 7 ++-- docker-compose/homeassistant/.env.example | 8 ++--- docker-compose/infrastructure/.env.example | 23 ++++++------ docker-compose/media-management/.env.example | 12 ++++--- .../media-management/docker-compose.yml | 12 +++---- docker-compose/media/.env.example | 10 +++--- docker-compose/monitoring/.env.example | 13 ++++--- docker-compose/productivity/.env.example | 29 ++++++++++----- docker-compose/sablier/.env.example | 4 +-- docker-compose/transcoders/.env.example | 13 ++++--- docker-compose/utilities/.env.example | 28 ++++++++++++--- docker-compose/vpn/.env.example | 17 +++++---- docker-compose/vpn/docker-compose.yml | 2 +- docker-compose/wikis/.env.example | 21 ++++++----- 18 files changed, 166 insertions(+), 122 deletions(-) diff --git a/docker-compose/alternatives/.env.example b/docker-compose/alternatives/.env.example index 5ec7db4..5638dac 100644 --- 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= diff --git a/docker-compose/arcane/.env.example b/docker-compose/arcane/.env.example index de5303f..ac5751c 100644 --- 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= \ No newline at end of file diff --git a/docker-compose/core/.env.example b/docker-compose/core/.env.example index 602f304..9f96c72 100644 --- 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 diff --git a/docker-compose/dashboards/.env.example b/docker-compose/dashboards/.env.example index 3baf1b5..2d13953 100644 --- 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= diff --git a/docker-compose/dockge/.env.example b/docker-compose/dockge/.env.example index f979d10..f6e8ca5 100644 --- 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= diff --git a/docker-compose/homeassistant/.env.example b/docker-compose/homeassistant/.env.example index 29719fc..ce49a35 100644 --- 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= diff --git a/docker-compose/infrastructure/.env.example b/docker-compose/infrastructure/.env.example index 473dd9c..6a67878 100644 --- 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= diff --git a/docker-compose/media-management/.env.example b/docker-compose/media-management/.env.example index 703b67d..c5803a9 100644 --- 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= diff --git a/docker-compose/media-management/docker-compose.yml b/docker-compose/media-management/docker-compose.yml index b7e8948..949acfe 100644 --- 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} diff --git a/docker-compose/media/.env.example b/docker-compose/media/.env.example index fc532ff..21d42f7 100644 --- 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= diff --git a/docker-compose/monitoring/.env.example b/docker-compose/monitoring/.env.example index 8c01914..47c76e9 100644 --- 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= diff --git a/docker-compose/productivity/.env.example b/docker-compose/productivity/.env.example index 54c37e6..dd9d5b8 100644 --- 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= diff --git a/docker-compose/sablier/.env.example b/docker-compose/sablier/.env.example index bbb5347..a20e3cd 100644 --- 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= diff --git a/docker-compose/transcoders/.env.example b/docker-compose/transcoders/.env.example index dd86a84..a13b34a 100644 --- 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= diff --git a/docker-compose/utilities/.env.example b/docker-compose/utilities/.env.example index f03bae5..f028907 100644 --- 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= diff --git a/docker-compose/vpn/.env.example b/docker-compose/vpn/.env.example index 0706873..7338789 100644 --- 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= diff --git a/docker-compose/vpn/docker-compose.yml b/docker-compose/vpn/docker-compose.yml index e957423..fc49fbb 100644 --- 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} diff --git a/docker-compose/wikis/.env.example b/docker-compose/wikis/.env.example index 2b892af..fb3ec80 100644 --- 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=