Environment-variables-reference.md

Environment Variables Reference

acme-companion Container Variables

Variable	Default	Legacy Variable	Documentation
ACME_CA_URI	https://acme-v02.api.letsencrypt.org/directory	—	Container configuration
ACME_CA_BUNDLE	Alpine trust store	—	Container configuration
ACME_CHALLENGE	HTTP-01	—	Let's Encrypt and ACME › DNS-01 challenge
ACMESH_DNS_API_CONFIG	—	—	Let's Encrypt and ACME › DNS-01 challenge
ACME_CERT_PROFILE	CA default	—	Let's Encrypt and ACME › Default certificate profile
ACME_EAB_KID	—	—	Zero SSL · Google Trust Services
ACME_EAB_HMAC_KEY	—	—	Zero SSL · Google Trust Services
ACME_HTTP_CHALLENGE_LOCATION	false	—	Container configuration
ACME_POST_HOOK	—	—	Container configuration · Hooks
ACME_PRE_HOOK	—	—	Container configuration · Hooks
ACME_RENEW_AFTER	60 (days)	DEFAULT_RENEW ⚠️ deprecated	Container configuration
CERTS_UPDATE_INTERVAL	3600 (seconds)	—	Container configuration
CREATE_DEFAULT_CERTIFICATE	false	—	Let's Encrypt and ACME › Self signed default certificate
DEBUG	0	—	Container configuration
DEFAULT_EMAIL	—	—	Let's Encrypt and ACME › Default contact address
DEFAULT_KEY_SIZE	4096	—	Let's Encrypt and ACME › Private key size
DHPARAM_BITS	4096	—	Container configuration
DHPARAM_SKIP	false	—	Container configuration
DOCKER_CERT_PATH	—	—	Container configuration
DOCKER_CONTAINER_FILTERS	all containers	—	Container configuration
DOCKER_HOST	unix:///var/run/docker.sock	—	Container configuration
DOCKER_TLS_VERIFY	false	—	Container configuration
ENABLE_IPV6	false	—	Container configuration
FILES_GID	same as FILES_UID	—	Persistent data › Ownership & permissions
FILES_PERMS	600	—	Persistent data › Ownership & permissions
FILES_UID	root	—	Persistent data › Ownership & permissions
FOLDERS_PERMS	755	—	Persistent data › Ownership & permissions
NGINX_DOCKER_GEN_CONTAINER	—	—	Advanced usage · Getting containers IDs
NGINX_PROXY_CONTAINER	—	—	Getting containers IDs
RELOAD_NGINX_ONLY_ONCE	false	—	Container configuration
RENEW_PRIVATE_KEYS	true	—	Container configuration · Let's Encrypt and ACME › Private key re-utilization
ZEROSSL_API_KEY	—	—	Zero SSL

---

Proxied Container Variables

Variable	Default	Legacy Variable	Documentation
ACME_HOST	—	LETSENCRYPT_HOST	Basic usage · Let's Encrypt and ACME
ACME_EMAIL	DEFAULT_EMAIL or none	LETSENCRYPT_EMAIL	Let's Encrypt and ACME › Contact address
ACME_CA_URI	acme-companion's ACME_CA_URI	—	Let's Encrypt and ACME › ACME CA URI
ACME_CA_BUNDLE	acme-companion's ACME_CA_BUNDLE	—	Let's Encrypt and ACME › Alternate trusted root CA
ACME_CHALLENGE	acme-companion's ACME_CHALLENGE	—	Let's Encrypt and ACME › DNS-01 challenge
ACMESH_DNS_API_CONFIG	acme-companion's ACMESH_DNS_API_CONFIG	—	Let's Encrypt and ACME › DNS-01 challenge
ACME_CERT_PROFILE	acme-companion's ACME_CERT_PROFILE or CA default	—	Let's Encrypt and ACME › Certificate profile
ACME_EAB_KID	acme-companion's ACME_EAB_KID	—	Zero SSL · Google Trust Services
ACME_EAB_HMAC_KEY	acme-companion's ACME_EAB_HMAC_KEY	—	Zero SSL · Google Trust Services
ACME_KEYSIZE	DEFAULT_KEY_SIZE (4096)	LETSENCRYPT_KEYSIZE	Let's Encrypt and ACME › Private key size
ACME_OCSP	false	—	Let's Encrypt and ACME › OCSP stapling
ACME_POST_HOOK	—	—	Let's Encrypt and ACME › Pre-Hook and Post-Hook
ACME_PRE_HOOK	—	—	Let's Encrypt and ACME › Pre-Hook and Post-Hook
ACME_PREFERRED_CHAIN	—	—	Let's Encrypt and ACME › Preferred chain
ACME_RENEW_AFTER	acme-companion's ACME_RENEW_AFTER (60)	—	Let's Encrypt and ACME › Certificate renewal timing
ACME_RENEW_PRIVATE_KEYS	RENEW_PRIVATE_KEYS (true)	—	Container configuration
ACME_RESTART_CONTAINER	false	LETSENCRYPT_RESTART_CONTAINER	Let's Encrypt and ACME › Container restart on cert renewal
ACME_SINGLE_DOMAIN_CERTS	false	LETSENCRYPT_SINGLE_DOMAIN_CERTS	Let's Encrypt and ACME › Separate certificate for each domain
LETSENCRYPT_TEST	false	—	Let's Encrypt and ACME › Test certificates
ZEROSSL_API_KEY	acme-companion's ZEROSSL_API_KEY	—	Zero SSL