Refine .env.example files across all stacks

- Streamline variable organization and formatting
- Reduce redundant comments and improve clarity
- Maintain all required variables for each stack
This commit is contained in:
2026-02-10 20:23:52 -05:00
parent 4067ba9c38
commit 5df66a3923
17 changed files with 68 additions and 112 deletions

View File

@@ -7,9 +7,9 @@
# #### REQUIRED CONFIGURATION #### # #### REQUIRED CONFIGURATION ####
# Required for file permissions (get with: id -u and id -g) # Required for file permissions (get with: id -u and id -g)
TZ=America/New_York
PUID=1000 PUID=1000
PGID=1000 PGID=1000
TZ=America/New_York
# This Server's IP and Hostname # This Server's IP and Hostname
SERVER_IP= SERVER_IP=

View File

@@ -1,16 +1,15 @@
# Alternatives Stack Environment Variables # Alternatives Stack Environment Variables
# These variables are used for alternative services (Plex, Authentik, etc.)
# Base Configuration TZ=
PUID=
PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN= DOMAIN=
# Directory Configuration
MEDIA_DIR= MEDIA_DIR=
# Plex Configuration
PLEX_CLAIM= PLEX_CLAIM=
# Authentik Configuration
AUTHENTIK_SECRET_KEY= AUTHENTIK_SECRET_KEY=
AUTHENTIK_DB_NAME= AUTHENTIK_DB_NAME=
AUTHENTIK_DB_USER= AUTHENTIK_DB_USER=

View File

@@ -1,19 +1,13 @@
# Arcane Stack Environment Variables # Arcane Stack Environment Variables
# These variables are used for Arcane Docker Management UI
# Server Configuration TZ=
SERVER_IP=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
PROJECTS_DIR= PROJECTS_DIR=
# Arcane Configuration
ARCANE_ENCRYPTION_KEY=
ARCANE_JWT_SECRET= ARCANE_JWT_SECRET=
ARCANE_ENCRYPTION_KEY=
# Optional: Agent Configuration
ARCANE_AGENT_TOKEN=

View File

@@ -1,25 +1,17 @@
# Core Stack Environment Variables # Core Stack Environment Variables
# These variables are used for Traefik, Authelia, DuckDNS, and Pi-hole
# Base Configuration
DOMAIN=
TZ= TZ=
# Server Configuration
SERVER_IP=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# DuckDNS Configuration
DUCKDNS_SUBDOMAINS= DUCKDNS_SUBDOMAINS=
DUCKDNS_TOKEN= DUCKDNS_TOKEN=
# Pi-hole Configuration
PIHOLE_PASSWORD= PIHOLE_PASSWORD=
# Authelia Configuration (Generated by script)
AUTHELIA_JWT_SECRET= AUTHELIA_JWT_SECRET=
AUTHELIA_SESSION_SECRET= AUTHELIA_SESSION_SECRET=
AUTHELIA_STORAGE_ENCRYPTION_KEY= AUTHELIA_STORAGE_ENCRYPTION_KEY=

View File

@@ -1,16 +1,11 @@
# Dashboards Stack Environment Variables # Dashboards Stack Environment Variables
# These variables are used for Homepage and Homarr
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
# Directory Configuration SERVER_HOSTNAME=
DOMAIN=
STACKS_DIR= STACKS_DIR=
# Homepage Configuration
HOMEPAGE_ALLOWED_HOSTS= HOMEPAGE_ALLOWED_HOSTS=

View File

@@ -1,9 +1,10 @@
# Dockge Stack Environment Variables # Dockge Stack Environment Variables
# These variables are used in docker-compose labels and configuration
# Base Configuration TZ=
DOMAIN= PUID=
PGID=
SERVER_IP=
SERVER_HOSTNAME= SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
STACKS_DIR= STACKS_DIR=

View File

@@ -1,6 +1,8 @@
# Home Assistant Stack Environment Variables # Home Assistant Stack Environment Variables
# These variables are used for Home Assistant and related services
# Base Configuration
DOMAIN=
TZ= TZ=
PUID=
PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=

View File

@@ -1,16 +1,15 @@
# Infrastructure Stack Environment Variables # Infrastructure Stack Environment Variables
# These variables are used for Watchtower, Dozzle, Glances, Code Server
# Base Configuration
DOMAIN=
TZ= TZ=
PUID=
PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
STACKS_DIR= STACKS_DIR=
# Code Server Configuration
CODE_SERVER_PASSWORD= CODE_SERVER_PASSWORD=
CODE_SERVER_SUDO_PASSWORD= CODE_SERVER_SUDO_PASSWORD=
# Watchtower Configuration (Optional)
WATCHTOWER_NOTIFICATION_URL= WATCHTOWER_NOTIFICATION_URL=

View File

@@ -1,13 +1,11 @@
# Media Management Stack Environment Variables # Media Management Stack Environment Variables
# These variables are used for Sonarr, Radarr, Prowlarr, etc.
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
MEDIA_DIR= MEDIA_DIR=
DOWNLOAD_DIR= DOWNLOAD_DIR=

View File

@@ -1,12 +1,10 @@
# Media Stack Environment Variables # Media Stack Environment Variables
# These variables are used for Jellyfin, Calibre-web, etc.
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
MEDIA_DIR= MEDIA_DIR=

View File

@@ -1,12 +1,10 @@
# Monitoring Stack Environment Variables # Monitoring Stack Environment Variables
# These variables are used for Prometheus, Grafana, Uptime Kuma, etc.
# Base Configuration TZ=
DOMAIN=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Grafana Configuration
GRAFANA_ADMIN_PASSWORD= GRAFANA_ADMIN_PASSWORD=

View File

@@ -1,27 +1,21 @@
# Productivity Stack Environment Variables # Productivity Stack Environment Variables
# These variables are used for productivity and collaboration tools
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Nextcloud Configuration
NEXTCLOUD_DIR= NEXTCLOUD_DIR=
NEXTCLOUD_ADMIN_USER= NEXTCLOUD_ADMIN_USER=
NEXTCLOUD_ADMIN_PASSWORD= NEXTCLOUD_ADMIN_PASSWORD=
NEXTCLOUD_DB_PASSWORD= NEXTCLOUD_DB_PASSWORD=
NEXTCLOUD_DB_ROOT_PASSWORD= NEXTCLOUD_DB_ROOT_PASSWORD=
# WordPress Configuration
WORDPRESS_DB_PASSWORD= WORDPRESS_DB_PASSWORD=
WORDPRESS_DB_ROOT_PASSWORD= WORDPRESS_DB_ROOT_PASSWORD=
# Gitea Configuration
GITEA_DB_PASSWORD= GITEA_DB_PASSWORD=
# Jupyter Configuration
JUPYTER_TOKEN= JUPYTER_TOKEN=

View File

@@ -1,5 +1,8 @@
# Sablier Stack Environment Variables # Sablier Stack Environment Variables
# These variables are used for Sablier lazy loading service
# Base Configuration TZ=
PUID=
PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN= DOMAIN=

View File

@@ -1,15 +1,12 @@
# Transcoders Stack Environment Variables # Transcoders Stack Environment Variables
# These variables are used for Tdarr, Unmanic
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
MEDIA_DIR= MEDIA_DIR=
TDARR_TRANSCODE_DIR= TDARR_TRANSCODE_DIR=
UNMANIC_TRANSCODE_DIR= UNMANIC_TRANSCODE_DIR=

View File

@@ -1,27 +1,21 @@
# Utilities Stack Environment Variables # Utilities Stack Environment Variables
# These variables are used for backup and utility services
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
STACKS_DIR= STACKS_DIR=
# Bitwarden Configuration FORMIO_JWT_SECRET=
FORMIO_DB_SECRET=
BITWARDEN_SIGNUPS_ALLOWED= BITWARDEN_SIGNUPS_ALLOWED=
BITWARDEN_INVITATIONS_ALLOWED= BITWARDEN_INVITATIONS_ALLOWED=
BITWARDEN_ADMIN_TOKEN= BITWARDEN_ADMIN_TOKEN=
# Form.io Configuration
FORMIO_JWT_SECRET=
FORMIO_DB_SECRET=
# SMTP Configuration (Optional for Bitwarden)
SMTP_HOST= SMTP_HOST=
SMTP_PORT= SMTP_PORT=
SMTP_USERNAME= SMTP_USERNAME=

View File

@@ -1,18 +1,14 @@
# VPN Stack Environment Variables # VPN Stack Environment Variables
# These variables are used for VPN services
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# Directory Configuration
DOWNLOAD_DIR= DOWNLOAD_DIR=
# VPN Configuration
SURFSHARK_USERNAME= SURFSHARK_USERNAME=
SURFSHARK_PASSWORD= SURFSHARK_PASSWORD=
VPN_SERVER_COUNTRIES= VPN_SERVER_COUNTRIES=

View File

@@ -1,18 +1,14 @@
# Wikis Stack Environment Variables # Wikis Stack Environment Variables
# These variables are used for wiki and documentation platforms
# Base Configuration
DOMAIN=
TZ= TZ=
# User Configuration
PUID= PUID=
PGID= PGID=
SERVER_IP=
SERVER_HOSTNAME=
DOMAIN=
# BookStack Database Configuration
BOOKSTACK_DB_PASSWORD= BOOKSTACK_DB_PASSWORD=
BOOKSTACK_DB_ROOT_PASSWORD= BOOKSTACK_DB_ROOT_PASSWORD=
# MediaWiki Database Configuration
MEDIAWIKI_DB_PASSWORD= MEDIAWIKI_DB_PASSWORD=
MEDIAWIKI_DB_ROOT_PASSWORD= MEDIAWIKI_DB_ROOT_PASSWORD=