env.example

Rama main · réplica de lectura del repositorio original.

# mailcow Logs Viewer Configuration
# Copy this file to .env and fill in your values

# ============================================================================
# REQUIRED SETTINGS
# ============================================================================

# Your mailcow instance URL (without trailing slash)
MAILCOW_URL=https://mail.example.com

# mailcow API key - Read-Only (generate from System → API in mailcow admin)
# Required permissions: Read access to logs
MAILCOW_API_KEY=your-api-key-here

# mailcow API key - Read-Write (optional, for edit operations like Fail2Ban)
# Generate a separate key with write permissions from System → API
# MAILCOW_API_KEY_RW=your-rw-api-key-here

# =============================================================================
# DATABASE CONFIGURATION (Required)
# =============================================================================
# These settings cannot be changed via the web UI and must be set here

# PostgreSQL credentials
POSTGRES_USER=mailcowlogs
POSTGRES_PASSWORD=changeme
POSTGRES_DB=mailcowlogs

# Database host (use 'db' for docker-compose setup)
POSTGRES_HOST=db

# Database port
POSTGRES_PORT=5432

# =============================================================================
# SETTINGS UI CONFIGURATION
# =============================================================================
# Allow editing app settings from the web UI (Settings tab). When enabled,
# values are stored in the database and override ENV (priority: Default → ENV → DB).
# Use "Import from ENV to DB" in the UI to migrate existing ENV config into DB,
# then you can remove ENV vars and manage everything from the website.
# Default: false (all configuration from ENV only)
# IMPORTANT: Must be in .env (or docker-compose environment) and app must be restarted after change.
SETTINGS_EDIT_VIA_UI_ENABLED=true

# =============================================================================
# NOTE: All other settings can be configured via the web UI
# =============================================================================
# When SETTINGS_EDIT_VIA_UI_ENABLED=true, you can manage all other settings
# from the Settings tab in the web interface. See documentation/ENV_Settings.md
# for a complete reference of all available environment variables.