Environment Variables

April 18, 2026 · View on GitHub

Complete reference for all Synapse environment variables. Variables use the AX_ prefix for the canonical form; many also accept a shorter alias without the prefix (e.g. MODE = AX_MODE).


Application

VariableDescriptionDefault
MODE / AX_MODEDeployment mode: proxy or agentagent

Network & Firewall

VariableDescriptionDefault
NETWORK_IFACE / AX_NETWORK_IFACEPrimary network interface for XDPeth0
NETWORK_IFACES / AX_NETWORK_IFACESAdditional interfaces, comma-separated
NETWORK_IP_VERSIONIP version filter: ipv4, ipv6, bothboth
FIREWALL_MODEFirewall backend: auto, xdp, nftables, iptables, noneauto

Gen0Sec Platform

VariableDescriptionDefault
API_KEY / AX_ARXIGNIS_API_KEYGen0Sec API key
BASE_URL / AX_ARXIGNIS_BASE_URLGen0Sec API base URLhttps://api.gen0sec.com/v1
LOG_SENDING_ENABLED / AX_ARXIGNIS_LOG_SENDING_ENABLEDSend logs/events to APItrue
AX_ARXIGNIS_INCLUDE_RESPONSE_BODYInclude response body in access logstrue
AX_ARXIGNIS_MAX_BODY_SIZEMax body size to capture (bytes)1048576

Threat Intelligence

VariableDescriptionDefault
THREAT_MMDB_URL / AX_ARXIGNIS_THREAT_MMDB_URLThreat MMDB download URLhttps://download.gen0sec.com/v1
THREAT_MMDB_PATH / AX_ARXIGNIS_THREAT_MMDB_PATHLocal path to store MMDB/var/lib/synapse
AX_ARXIGNIS_THREAT_MMDB_REFRESH_SECSRefresh interval (0 = disable auto-refresh)300

GeoIP

VariableDescriptionDefault
GEOIP_COUNTRY_URLCountry MMDB download URL
GEOIP_COUNTRY_PATHLocal path/var/lib/synapse
GEOIP_ASN_URLASN MMDB download URL
GEOIP_ASN_PATHLocal path/var/lib/synapse
GEOIP_CITY_URLCity MMDB download URL
GEOIP_CITY_PATHLocal path/var/lib/synapse
GEOIP_REFRESH_SECSRefresh interval (seconds)28800

Redis

VariableDescriptionDefault
REDIS_URL / AX_REDIS_URLRedis connection URLredis://127.0.0.1/0
REDIS_PREFIX / AX_REDIS_PREFIXRedis key namespace prefixax:synapse

CAPTCHA

VariableDescriptionDefault
CAPTCHA_SITE_KEY / AX_CAPTCHA_SITE_KEYCAPTCHA site key
CAPTCHA_SECRET_KEY / AX_CAPTCHA_SECRET_KEYCAPTCHA secret key
CAPTCHA_JWT_SECRET / AX_CAPTCHA_JWT_SECRETJWT secret for token signing
CAPTCHA_PROVIDER / AX_CAPTCHA_PROVIDERhcaptcha, recaptcha, or turnstile
CAPTCHA_TOKEN_TTL / AX_CAPTCHA_TOKEN_TTLToken validity (seconds)7200
CAPTCHA_CACHE_TTL / AX_CAPTCHA_CACHE_TTLVerification cache TTL (seconds)300

Content Scanning

VariableDescriptionDefault
CONTENT_SCANNING_ENABLED / AX_CONTENT_SCANNING_ENABLEDEnable ClamAV scanningfalse
CLAMAV_SERVER / AX_CLAMAV_SERVERClamAV TCP addresslocalhost:3310
CONTENT_MAX_FILE_SIZE / AX_CONTENT_MAX_FILE_SIZEMax body size to scan (bytes)10485760
CONTENT_SCAN_CONTENT_TYPES / AX_CONTENT_SCAN_CONTENT_TYPESMIME types to scan (comma-separated)
CONTENT_SKIP_EXTENSIONS / AX_CONTENT_SKIP_EXTENSIONSExtensions to skip (comma-separated)
CONTENT_SCAN_EXPRESSION / AX_CONTENT_SCAN_EXPRESSIONWirefilter expression for scan trigger

Internal Services

VariableDescriptionDefault
INTERNAL_SERVICES_ENABLEDEnable internal HTTP servertrue
INTERNAL_SERVICES_PORTInternal server port9180
INTERNAL_SERVICES_BIND_IPBind address127.0.0.1

PROXY Protocol

VariableDescriptionDefault
PROXY_PROTOCOL_ENABLEDEnable PROXY protocolfalse
PROXY_PROTOCOL_TIMEOUTTimeout in milliseconds1000

ACME / TLS

VariableDescriptionDefault
ACME_ENABLEDEnable automatic certificate provisioningfalse
ACME_EMAILContact email for Let's Encrypt
ACME_STORAGE_TYPEredis or fileredis
ACME_PORTACME challenge server port9180

BPF Statistics

VariableDescriptionDefault
BPF_STATS_ENABLED / AX_BPF_STATS_ENABLEDEnable BPF statistics collectiontrue
BPF_STATS_LOG_INTERVAL / AX_BPF_STATS_LOG_INTERVALStats log interval (seconds)60
AX_BPF_STATS_ENABLE_DROPPED_IP_EVENTSEnable per-IP drop eventstrue
AX_BPF_STATS_DROPPED_IP_EVENTS_INTERVALDrop events interval (seconds)30

TCP Fingerprinting

VariableDescriptionDefault
TCP_FINGERPRINT_ENABLED / AX_TCP_FINGERPRINT_ENABLEDEnable TCP fingerprintingtrue
TCP_FINGERPRINT_LOG_INTERVAL / AX_TCP_FINGERPRINT_LOG_INTERVALLog interval (seconds)60
AX_TCP_FINGERPRINT_ENABLE_FINGERPRINT_EVENTSEnable fingerprint event sendingtrue
AX_TCP_FINGERPRINT_EVENTS_INTERVALEvent interval (seconds)30
AX_TCP_FINGERPRINT_MIN_PACKET_COUNTMin packets before fingerprint is recorded3
AX_TCP_FINGERPRINT_MIN_CONNECTION_DURATIONMin connection duration (seconds)1

Daemon mode

VariableDescriptionDefault
DAEMON_ENABLED / AX_DAEMON_ENABLEDRun as background daemonfalse
DAEMON_PID_FILE / AX_DAEMON_PID_FILEPID file path/var/run/synapse.pid
DAEMON_WORKING_DIRECTORY / AX_DAEMON_WORKING_DIRECTORYWorking directory/
AX_DAEMON_ACCESS_LOGAccess log path/var/log/synapse/access.log
AX_DAEMON_ERROR_LOGError log path/var/log/synapse/error.log
DAEMON_USER / AX_DAEMON_USERDrop privileges to this user
DAEMON_GROUP / AX_DAEMON_GROUPDrop privileges to this group
AX_DAEMON_CHOWN_PID_FILEChange PID file ownership to daemon user/grouptrue

Logging

VariableDescriptionDefault
LOGGING_LEVEL / AX_LOGGING_LEVELLog level: error, warn, info, debug, traceinfo
LOGGING_FILE_ENABLEDEnable file loggingfalse
LOGGING_DIRECTORYLog directory/var/log/synapse
LOGGING_MAX_FILE_SIZEMax log file size (bytes)104857600
LOGGING_FILE_COUNTNumber of rotated log files to keep10
LOGGING_SYSLOG_ENABLEDEnable syslog (Linux only)false
LOGGING_SYSLOG_FACILITYSyslog facilitydaemon
LOGGING_SYSLOG_IDENTIFIERSyslog identifiersynapse
LOGGING_ETW_ENABLEDEnable ETW (Windows only)false

Runtime

VariableDescriptionDefault
TOKIO_WORKER_THREADSTokio async runtime thread countCPU core count