Skip to main content
Version: 10.1

Environment Variables Reference

This file documents all supported .env entries for the Frafos monitoring stack. Place your .env file in the same directory as your docker-compose.yml or manifest files to configure your deployment.

Example .env File​

Show example .env file
⬇️ Download env.example
.env
# --- Generic ---
# NODE_ENV=production # Specifies the current environment for the application. Affects configuration, logging, and feature toggles throughout the app. Defaults to 'production'. | required | enum: [dev, test, production, CI]
# MOKI_DEBUG=false # Enable verbose debug logging and additional diagnostic output for Moki. Useful for troubleshooting and development. | required
# ADDR=0.0.0.0 # IP address or hostname for the Express.js server to bind to. Must be a valid IPv4 or IPv6 address. | required
# PORT=5000 # Port number for the server to listen on. | required | min: 0, max: 65536
# PUBLIC_URL= # Publicly accessible URL of the application. Used for generating links and references. Must be a valid URL. | optional
# STATIC_DOC_FILES_PATH=/moki/documentations # Filesystem path to static documentation files served by the application. Used for hosting and accessing documentation. | required
# LOG_PATH=/data/abc-monitor/logs # Filesystem path where application log files are stored. Used for tracking server and application events. | required
# LOG_LEVEL=debug # Logging level for application output. Controls verbosity: trace (most detailed), debug, info, warn, error, fatal (least detailed). | required | enum: [trace, debug, info, warn, error, fatal]
# REPORT_URL=http://localhost:5000/report # URL endpoint for accessing application reports. Must be a valid URL. | required
# BROWSER_URL=http://chrome:9222/ # URL of the browser endpoint used for remote browser automation or debugging. Must be a valid URL. | required
# PYTHON_PATH=python3 # Filesystem path or command to the Python executable used for running Python scripts or integrations. | required

# --- Auth ---
# JWT_required=false # Require JWT authentication for SIP user access. If true, users must provide a valid JWT token to authenticate. | required
# BYPASS_AUTH=false # If true, the login page is displayed for user authentication; if false, users are redirected directly to the dashboard without authentication. | required
# CCM= # IP address or hostname of the CCM server used for SIP communications. Must be a valid IPv4, IPv6, or hostname. | optional
# PROXY_CCM= # If set to 1, the CCM is proxied behind the Monitor for authentication purposes. Value "0" sets the authentication mechanism to a redirect mode.| optional

# --- Elasticsearch ---
# ES= # URL of the Elasticsearch server to override the value from monitor.json. Must be a valid URL. Used for connecting to the Elasticsearch instance. | optional
# ES_USERNAME= # Username for authenticating with the Elasticsearch server. Required if ES_PASSWORD is provided. | optional
# ES_PASSWORD= # Password for authenticating with the Elasticsearch server. Required if ES_USERNAME is provided. | optional
# ES_RECOVERY_CONFIRMATION_COUNT=3 # Number of confirmations required to complete the recovery process in Elasticsearch operations. Controls how many successful confirmations are needed before recovery is considered complete. | required
# LOCAL_ES= # Run the Elasticsearch database inside the Monitor container instead of using an external instance. Values "0" or "1" | optional

# --- Logstash ---
# LOGSTASH_URL=http://127.0.0.1:9600 # URL of the Logstash server for event ingestion and monitoring. Useful when Logstash runs on a different server or in the 'mon' container (127.0.0.1). Must be a valid URL. | required
# LOGSTASH_DISABLED=false # If true, disables Logstash integration when running the monitor server. For fresh Elasticsearch setups, datastreams config must be pushed before sending events via Logstash. | required
# LOGSTASH_BIN=/opt/logstash/bin/logstash # Filesystem path to the Logstash binary. Required for local development or manual Logstash operation. | required
# LOGSTASH_BEATS_PORT=5044 # Input port for Logstash. Used by event-generator to push events. | required | min: 0, max: 65536
# LOGSTASH_GEOIP_DB=/data/abc-monitor/logstash/GeoLite2-City.mmdb # Filesystem path to the GeoIP database used by Logstash for geolocation enrichment of events. | required
# LS_RECOVERY_CONFIRMATION_COUNT=3 # Number of confirmations required to complete the recovery process for Logstash operations. Controls how many successful confirmations are needed before recovery is considered complete. | required | min: 1, max: 100

# --- AA ---
# ADVANCED_ALERTS= # Enable advanced alerts for enhanced monitoring and notification features | optional
# ADVANCED_ALERTS_URL= # The endpoint URL used for advanced alerts when ADVANCED_ALERTS is enabled. Must be a valid URL. | optional
# AA_RECOVERY_CONFIRMATION_COUNT=3 # Number of confirmations required to complete the recovery process. Controls how many successful confirmations are needed before recovery is considered complete. | required | min: 1, max: 100


# --- CI ---
# CI_LOGSTASH_ADDR=127.0.0.1 # IP address of the Logstash server used for CI logging and data collection. Must be a valid IPv4 or IPv6 address. | required
# CI_LOGSTASH_PORT=0 # Port number for connecting to the Logstash server in CI. Must be within the allowed port range. | required | min: 0, max: 65536
# CI_SKIP_DATA_GEN=false # If true, skips generating test data during CI runs. Useful for faster execution when data generation is not required. | required

Ports​

  • PORT - GUI port: 5000
  • LOGSTASH events - plain: 5044
  • LOGSTASH events - secured: 5045
  • RSYNC - plain: 873
  • RSYNC - secured: 1873

Variable Definitions​

Generic environment variables used for core application configuration, debugging, server address, ports, URLs, and paths. These variables control the main behavior and entry points of the monitoring stack.

VariableTypeDefault ValueRestrictionsDescription
NODE_ENVenum [dev, test, production, CI]productionenum: [dev, test, production, CI]Specifies the current environment for the application. Affects configuration, logging, and feature toggles throughout the app. Defaults to 'production'.
MOKI_DEBUGbooleanfalse-Enable verbose debug logging and additional diagnostic output for Moki. Useful for troubleshooting and development.
ADDRstring0.0.0.0-IP address or hostname for the Express.js server to bind to. Must be a valid IPv4 or IPv6 address.
PORTnumber5000min: 0, max: 65536Port number for the server to listen on.
PUBLIC_URLstring--Publicly accessible URL of the application. Used for generating links and references. Must be a valid URL.
STATIC_DOC_FILES_PATHstring/moki/documentations-Filesystem path to static documentation files served by the application. Used for hosting and accessing documentation.
LOG_PATHstring/data/abc-monitor/logs-Filesystem path where application log files are stored. Used for tracking server and application events.
LOG_LEVELenum [trace, debug, info, warn, error, fatal]debugenum: [trace, debug, info, warn, error, fatal]Logging level for application output. Controls verbosity: trace (most detailed), debug, info, warn, error, fatal (least detailed).
REPORT_URLstringhttp://localhost:5000/report-URL endpoint for accessing application reports. Must be a valid URL.
BROWSER_URLstringhttp://chrome:9222/-URL of the browser endpoint used for remote browser automation or debugging. Must be a valid URL.
PYTHON_PATHstringpython3-Filesystem path or command to the Python executable used for running Python scripts or integrations.

Usage Notes​

info
  • Add or override variables as needed for your deployment.
  • For sensitive values, consider using Docker secrets or Kubernetes secrets.
  • Not all variables are required for every service; check your compose/manifest for usage.