1
0
Fork 0
docker-easy-haproxy/docs/environment-variable.md
Joao Gilberto Magalhaes bfd38adea5 Add standalone Python entrypoint for EasyHAProxy and pip-based installation
- Introduced `/scripts/.venv/bin/easy-haproxy` as the default entrypoint for standalone environments.
- Added `_build_parser` and `start` functions to enable CLI-driven functionality configuration.
- Updated packaging to reflect new `easyhaproxy.main` module and adapted project name from `easymapping` to `easyhaproxy`.
- Modified `Dockerfile` to align with new script paths and entrypoints for better portability.
- Enhanced documentation with dedicated sections for pip-based installation, CLI references, and systemd setup for non-Docker environments.
- Adjusted helm, plugin, and environment-related docs for accurate sidebar ordering.
- Added a new GitHub workflow to automate package publishing to PyPI.
2026-02-17 21:41:33 -05:00

4.3 KiB

sidebar_position
13

Docker environment variables

Environment Variable Description Default
EASYHAPROXY_DISCOVER How the services will be discovered to create haproxy.cfg: static, docker, swarm or kubernetes required
EASYHAPROXY_LABEL_PREFIX (Optional) The key will search for matching resources. easyhaproxy
EASYHAPROXY_BASE_PATH (Optional) Base directory for all EasyHAProxy files. All paths (config, certs, plugins, www) are constructed relative to this base. /etc/easyhaproxy
EASYHAPROXY_CERTBOT_* (Optional) Enable Let's Encrypt or any other ACME certificate. See more: acme empty
EASYHAPROXY_SSL_MODE (Optional) strict supports only the most recent TLS version; default good SSL integration with recent browsers; loose supports all old SSL protocols for old browsers (not recommended). default
EASYHAPROXY_REFRESH_CONF (Optional) Check for new containers/services every N seconds. 10
EASYHAPROXY_LOG_LEVEL (Optional) The log level for EasyHAproxy messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL DEBUG
CERTBOT_LOG_LEVEL (Optional) The log level for Certbot messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL DEBUG
HAPROXY_LOG_LEVEL (Optional) The log level for HAProxy messages. Available: TRACE,DEBUG,INFO,WARN,ERROR,FATAL INFO
HAPROXY_USERNAME (Optional) The HAProxy username for the statistics endpoint (used only when HAPROXY_PASSWORD is set). admin
HAPROXY_PASSWORD (Optional) The HAProxy password to the statistics endpoint. Stats are disabled unless this is defined. empty
HAPROXY_STATS_PORT (Optional) The HAProxy port to the statistics. If set to false, disable statistics. Only applies when HAPROXY_PASSWORD is defined. 1936
HAPROXY_STATS_CORS_ORIGIN (Optional) Enable CORS for the HAProxy stats dashboard by specifying the allowed origin (e.g., http://localhost:3000). Only applies when HAPROXY_PASSWORD is defined. empty
HAPROXY_CUSTOMERRORS (Optional) If HAProxy will use custom HTML errors. true/false. false

:::tip HAProxy Stats Statistics are only configured when HAPROXY_PASSWORD is set. Without a password, the stats section is not generated. :::

:::note ACME/Certbot Environment Variables For ACME/Certbot configuration (Let's Encrypt, ZeroSSL, etc.), see the ACME documentation for the complete list of EASYHAPROXY_CERTBOT_* variables. :::


Open source ByJG