- Update .env.example with latest environment variables - Update deployment and task documentation - Update backend configuration settings Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
61 lines
2.9 KiB
Plaintext
61 lines
2.9 KiB
Plaintext
# ──────────────────────────────────────────────────────────────
|
|
# BanGUI — Environment Variables Template
|
|
# Copy this file to .env and fill in the values below
|
|
# ──────────────────────────────────────────────────────────────
|
|
|
|
# Session Secret (REQUIRED)
|
|
# Generate a secure random secret for session tokens.
|
|
# WARNING: Do not use the same secret across different environments.
|
|
# Generate with: python -c 'import secrets; print(secrets.token_hex(32))'
|
|
# Example value: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
|
|
BANGUI_SESSION_SECRET=
|
|
|
|
# Previous Session Secret (optional)
|
|
# Used during secret rotation to accept tokens signed with the old secret.
|
|
# Set this to the previous secret when rotating secrets, then unset it once
|
|
# all old tokens have expired. This enables gradual rotation without forcing logout.
|
|
# Leave empty unless performing a rotation.
|
|
BANGUI_SESSION_SECRET_PREVIOUS=
|
|
|
|
# Timezone (optional, defaults to UTC)
|
|
# Use standard timezone names from the IANA Time Zone Database
|
|
# Examples: America/New_York, Europe/London, Asia/Tokyo, UTC
|
|
BANGUI_TIMEZONE=UTC
|
|
|
|
# Backend port (optional, defaults to 8000)
|
|
# When using docker-compose, this is the port on your host machine
|
|
BANGUI_BACKEND_PORT=8000
|
|
|
|
# Frontend port (optional, defaults to 5173)
|
|
# When using docker-compose, this is the port on your host machine
|
|
BANGUI_FRONTEND_PORT=5173
|
|
|
|
# Public port (optional, defaults to 8080)
|
|
# When using production compose, this is the public-facing port
|
|
BANGUI_PORT=8080
|
|
|
|
# IP Geolocation (optional)
|
|
# Path to MaxMind GeoLite2-Country MMDB database file (primary resolver).
|
|
# Download from: https://www.maxmind.com/en/geolite2/signup
|
|
# If not set, geolocation is disabled (or falls back to HTTP if enabled below).
|
|
# Example: /data/GeoLite2-Country.mmdb
|
|
BANGUI_GEOIP_DB_PATH=
|
|
|
|
# IP Geolocation HTTP Fallback (optional, defaults to false)
|
|
# ⚠️ SECURITY WARNING: Only enable if you cannot mount the MaxMind database.
|
|
# When enabled, unresolved IP addresses are sent unencrypted to ip-api.com.
|
|
# This is a privacy and GDPR/CCPA concern. Do NOT enable in production unless necessary.
|
|
# Set to "true" to enable (default is "false" for security).
|
|
BANGUI_GEOIP_ALLOW_HTTP_FALLBACK=false
|
|
|
|
# CORS Configuration (optional)
|
|
# Comma-separated list of allowed origins for cross-origin requests.
|
|
# Defaults to common localhost development origins (http://localhost:5173, http://127.0.0.1:5173, etc).
|
|
# Set this in production to your frontend domain(s).
|
|
# Examples:
|
|
# BANGUI_CORS_ALLOWED_ORIGINS=https://example.com,https://app.example.com
|
|
# BANGUI_CORS_ALLOWED_ORIGINS= (empty to disable CORS)
|
|
# WARNING: Do NOT use wildcard "*" — it defeats CORS security when credentials are enabled.
|
|
BANGUI_CORS_ALLOWED_ORIGINS=
|
|
|