From 3edd60448b175760a9ecc6c8bb19cb4d79a68b2c Mon Sep 17 00:00:00 2001 From: devlikepro Date: Tue, 24 Jun 2025 18:31:52 +0700 Subject: [PATCH] [core] format .env better --- .env.example | 250 +++++++++++++++++---------------------------------- 1 file changed, 82 insertions(+), 168 deletions(-) diff --git a/.env.example b/.env.example index 21163d7c..2e2f8b8b 100644 --- a/.env.example +++ b/.env.example @@ -1,191 +1,105 @@ -# WAHA Configuration +# WAHA - WhatsApp HTTP API +# # https://waha.devlike.pro/docs/how-to/config/ # -# Common -# -# If you know the right URL, you can use it here. -# Use any port in WHATSAPP_API_PORT and domain in WHATSAPP_API_HOSTNAME -# https://waha.devlike.pro/docs/how-to/config/#common + +# ================== +# ===== COMMON ===== +# ================== +# Base URL for the API (used for webhooks, file URLs, etc.) WAHA_BASE_URL=http://localhost:3000 -#WHATSAPP_API_SCHEMA=http -#WHATSAPP_API_PORT=3000 -#WHATSAPP_API_HOSTNAME=localhost +# Server configuration (if you need to customize hostname/port) +# WHATSAPP_API_SCHEMA=http +# WHATSAPP_API_PORT=3000 +# WHATSAPP_API_HOSTNAME=localhost -# -# Set your timezone to see the right time on screenshots -# Find your timezone name in the list -# https://en.wikipedia.org/wiki/List_of_tz_database_time_zones -#TZ=Europe/Dublin - -# -# Security -# -# https://waha.devlike.pro/docs/how-to/security/ -# -WAHA_API_KEY=admin +# ==================== +# ===== SECURITY ===== +# ==================== +# "sha512:{SHA}" format - below is "admin" api key +WAHA_API_KEY=sha512:c7ad44cbad762a5da0a452f9e854fdc1e0e7a52a38015f23f3eab1d80b931dd472634dfac71cd34ebc35d16ab7fb8a90c81f975113d6c7538dc69dd8de9077ec WAHA_DASHBOARD_USERNAME=admin WAHA_DASHBOARD_PASSWORD=admin -#WHATSAPP_SWAGGER_USERNAME=admin -#WHATSAPP_SWAGGER_PASSWORD=admin - -# -# Dashboard -# -# https://waha.devlike.pro/docs/how-to/waha-dashboard/#configuration -# Enabled by default -#WAHA_DASHBOARD_ENABLED=true -#WAHA_DASHBOARD_USERNAME=admin -#WAHA_DASHBOARD_PASSWORD=admin - -# -# Logging -# https://waha.devlike.pro/docs/how-to/observability/#logging -# -# Set log format to JSON if you consume logs with log management systems -WAHA_LOG_FORMAT=JSON -WAHA_LOG_LEVEL=info -# WAHA_LOG_FORMAT=PRETTY -# If you want to see more logs, you can set the log level to debug -#WAHA_LOG_LEVEL=debug -# DEBUG=1 # shortcut for setting log level to debug - -# -# Engine -# https://waha.devlike.pro/docs/how-to/engines/ -# -# Choose the right engine for your needs (WEBJS by default) -WHATSAPP_DEFAULT_ENGINE=WEBJS -# Use NOWEB engine for the fastest performance -#WHATSAPP_DEFAULT_ENGINE=NOWEB - -# Worker -# WAHA_WORKER_ID=waha1 - -# -# Sessions -# https://waha.devlike.pro/docs/how-to/config/#sessions -# -# Do not print QR codes in logs -WAHA_PRINT_QR=False -# -# OR you can specify sessions by name, if you have handful amount of sessions -#WHATSAPP_START_SESSION=session1,session2 -# -# Restart all sessions when container starts -# !!! Do not use it with multiple workers against one database !!! -# WHATSAPP_RESTART_ALL_SESSIONS=True - -# -# Swagger -# https://waha.devlike.pro/docs/how-to/swagger/ -# WHATSAPP_SWAGGER_USERNAME=admin WHATSAPP_SWAGGER_PASSWORD=admin -# Disable Swagger -#WHATSAPP_SWAGGER_ENABLED=false -# Enable advanced Swagger configuration -#WHATSAPP_SWAGGER_CONFIG_ADVANCED=true -# -# Swagger White Label customization -# https://waha.devlike.pro/docs/how-to/swagger/#white-label -#WHATSAPP_SWAGGER_TITLE=WAHA API -# -# -# PostgresSQL Configuration -# https://waha.devlike.pro/docs/how-to/storages/#sessions---postgresql -#WHATSAPP_SESSIONS_POSTGRESQL_URL=postgres://postgres:postgres@postgres:5432/postgres?sslmode=disable -# -# Media - PostgresSQL Storage -# https://waha.devlike.pro/docs/how-to/storages/#media---postgresql -#WAHA_MEDIA_STORAGE=POSTGRESQL -#WAHA_MEDIA_POSTGRESQL_URL=postgres://postgres:postgres@postgres:5432/postgres?sslmode=disable -# +# WhatsApp engine (WEBJS is default, NOWEB for better performance) +WHATSAPP_DEFAULT_ENGINE=WEBJS -# -# Global Proxy Settings -# https://waha.devlike.pro/docs/how-to/config/#global-proxy-configuration -# -# You can also set proxy settings for each session later when starting it -# https://waha.devlike.pro/docs/how-to/sessions/#configure-proxy -#WHATSAPP_PROXY_SERVER=proxy.example.com:3128 -#WHATSAPP_PROXY_SERVER_USERNAME=user -#WHATSAPP_PROXY_SERVER_PASSWORD=pass -# +# =================== +# ===== LOGGING ===== +# =================== +# Log format: JSON (for log management systems) or PRETTY (for development) +WAHA_LOG_FORMAT=JSON -# -# Media Configuration -# -# https://waha.devlike.pro/docs/how-to/config/#files -# -# Disable media (images, videos, files) download for incoming messages -#WHATSAPP_DOWNLOAD_MEDIA=false -# -# Download only specific media types -#WHATSAPP_FILES_MIMETYPES=image/jpeg,image/png -# +# Log level: info, debug, error, warn +WAHA_LOG_LEVEL=info -# Media - Local Storage -# https://waha.devlike.pro/docs/how-to/storages/#media---local -# -# Set to 0 to keep media files forever -# https://waha.devlike.pro/docs/how-to/storages/#save-media-files-between-the-container-restarts +# Don't print QR codes in logs +WAHA_PRINT_QR=False + +# ========================= +# ===== MEDIA STORAGE ===== +# ========================= +# Local storage (default) WAHA_MEDIA_STORAGE=LOCAL WHATSAPP_FILES_LIFETIME=0 WHATSAPP_FILES_FOLDER=/app/.media -# Keep media files for 180 seconds (3 minutes) -#WHATSAPP_FILES_LIFETIME=180 -# -# Media - S3 Storage -# https://waha.devlike.pro/docs/how-to/storages/#media---s3 -#WAHA_MEDIA_STORAGE=S3 -#WAHA_S3_REGION=eu-west-2 -#WAHA_S3_BUCKET=waha -#WAHA_S3_ACCESS_KEY_ID=minioadmin -#WAHA_S3_SECRET_ACCESS_KEY=minioadmin -#WAHA_S3_ENDPOINT=http://minio:9000 # Not required if you're using AWS S3 -#WAHA_S3_FORCE_PATH_STYLE=True # Required for Minio -#WAHA_S3_PROXY_FILES=True # Required for docker-compose setup +# Media download settings +# WHATSAPP_DOWNLOAD_MEDIA=true +# WHATSAPP_FILES_MIMETYPES=image/jpeg,image/png -# -# Global Webhooks -# -# https://waha.devlike.pro/docs/how-to/config/#webhooks -# https://waha.devlike.pro/docs/how-to/webhooks/ -#WHATSAPP_HOOK_URL=https://webhook.site/11111111-1111-1111-1111-11111111 -#WHATSAPP_HOOK_EVENTS=session.status,message,message.reaction -# +# S3 storage (uncomment to use) +# WAHA_MEDIA_STORAGE=S3 +# WAHA_S3_REGION=eu-west-2 +# WAHA_S3_BUCKET=waha +# WAHA_S3_ACCESS_KEY_ID=minioadmin +# WAHA_S3_SECRET_ACCESS_KEY=minioadmin +# WAHA_S3_ENDPOINT=http://minio:9000 +# WAHA_S3_FORCE_PATH_STYLE=True +# WAHA_S3_PROXY_FILES=True -# -# Local Configuration -# -# WAHA_LOCAL_STORE_BASE_DIR=/app/sessions -# Remember to map the volume to the host machine to the right direction in "volumes" field in docker-compose.yml -# volumes: -# - './.sessions:/app/sessions' +# PostgreSQL storage (uncomment to use) +# WAHA_MEDIA_STORAGE=POSTGRESQL +# WAHA_MEDIA_POSTGRESQL_URL=postgres://postgres:postgres@postgres:5432/postgres?sslmode=disable + +# =========================== +# ===== SESSION STORAGE ===== +# =========================== +# PostgreSQL for sessions (uncomment to use) +# WHATSAPP_SESSIONS_POSTGRESQL_URL=postgres://postgres:postgres@postgres:5432/postgres?sslmode=disable + +# MongoDB for sessions (uncomment to use) +# WHATSAPP_SESSIONS_MONGO_URL=mongodb://mongouser:mongopassword@mongodb:27017 -# -# MongoDB Configuration -# https://waha.devlike.pro/docs/how-to/storages/#sessions---mongodb -#WHATSAPP_SESSIONS_MONGO_URL=mongodb://mongouser:mongopassword@mongodb:27017 -# +# ================================== +# ===== ADVANCED CONFIGURATION ===== +# ================================== -# -# HTTPS Configuration -# https://waha.devlike.pro/docs/how-to/config/#https -# -# Consider using certbot for HTTPS -# https://waha.devlike.pro/blog/setting-up-https-for-waha/#lets-encrypt-certbot--waha -# -#WAHA_HTTPS_ENABLED=true -#WAHA_HTTPS_PATH_KEY=/etc/letsencrypt/live/waha.example.pro/privkey.pem -#WAHA_HTTPS_PATH_CERT=/etc/letsencrypt/live/waha.example.pro/cert.pem \ -#WAHA_HTTPS_PATH_CA=/etc/letsencrypt/live/waha.example.pro/chain.pem -#WHATSAPP_API_SCHEMA=https -#WHATSAPP_API_PORT=3000 -#WHATSAPP_API_HOSTNAME=waha.example.pro -# +# Timezone for screenshots and logs +# TZ=Europe/Dublin +# Session management +# WHATSAPP_START_SESSION=session1,session2 +# WHATSAPP_RESTART_ALL_SESSIONS=False + +# Webhooks +# WHATSAPP_HOOK_URL=https://webhook.site/11111111-1111-1111-1111-11111111 +# WHATSAPP_HOOK_EVENTS=session.status,message,message.reaction + +# Proxy configuration +# WHATSAPP_PROXY_SERVER=proxy.example.com:3128 +# WHATSAPP_PROXY_SERVER_USERNAME=user +# WHATSAPP_PROXY_SERVER_PASSWORD=pass + +# HTTPS configuration +# !DEPRECATED! +# Setup nginx reverse proxy to handle TLS connection +# using Let's encrypt or self-issued certificate +# WAHA_HTTPS_ENABLED=true +# WAHA_HTTPS_PATH_KEY=/etc/letsencrypt/live/waha.example.pro/privkey.pem +# WAHA_HTTPS_PATH_CERT=/etc/letsencrypt/live/waha.example.pro/cert.pem +# WAHA_HTTPS_PATH_CA=/etc/letsencrypt/live/waha.example.pro/chain.pem \ No newline at end of file