Comment on page

Internal Environment Variables

Nginx-LE uses a no. of internal environment variables primarily to communicate with Auth providers. You do not normally need to worry about these as the Nginx-LE sets these as necessary based on the selected Auth Provider.
Name
Type
Domain
Description
LOG_FILE
String
Path
The name of the logfile that certbot writes to. We also redirect the auth providers to write to this log file.
CERTBOT_ROOT_PATH
String
Path
Path to the letsencrypt root directory which defaults to: /etc/letsencrypt. You don't normally need to alter this. Its primary purpose is for Unit Testing.
CERTBOT_VERBOSE
String
true | false
Used by the acquire command to control the log level of the Certbot Auth and Cleanup hooks.
CERTBOT_AUTH_HOOK_PATH
String
Path
Path to the auth_hook script provided as part of nginx-le. The auth hook is called by certbot at the start of an attempt to acquire or renew a certificate.
CERTBOT_CLEANUP_HOOK_PATH
String
Path
Path to the cleanup_hook script provided as part of nginx-le. The cleanup hook is called by certbot when completing an attempt to acquire or renew a certificate.
CERTBOT_DEPLOY_HOOK
String
Path to the deploy_hook script provided as part of nginx-le. The deploy hook is called by certbot to deploy certificates into nginx. Its is only called when a certificate is sucessfully renewed or acquired.
​
DNS_RETRIES
int
Integer
The number of times the DNS Auth Hook will check the DNS for the required TXT record.
NGINX_CERT_ROOT_OVERWRITE
String
Path
Only used for Unit Testing. Sets the path where certbot saves certificates to.
NGINX_ACCESS_LOG_PATH
String
Path
Path to the Nginx access.log file in the container.
NGINX_ERROR_LOG_PATH
String
Path
Path to the Nginx error.log file in the container
NGINX_LOCATION_INCLUDE_PATH
String
Path
Path of the .location and .upstream files.
Certbot environment variables.
Certbot sets a number of environment variables during the auth process to communicate to the Auth and Cleanup hooks. You don't need to set this but if you are writing a custom auth or cleanup hook they are available to the hook.
Name
Type
Domain
Description
CERTBOT_TOKEN
String
Filename
Used only by HTTP01Auth. This is the name of the file that the CERTBOT_VALIDATION string must be written into e.g. .well-known/acme-challenge/$CERTBOT_TOKEN
CERTBOT_VALIDATION
String
Generated by Certbot
This is the validation string Certbot generates to verify ownership of your domain. For DNS Auth Providers this is written into a TXT record on your DNS server. For HTTP01Auth this is written int the CERTBOT_TOKEN file.
CERTBOT_DOMAIN
String
Domain name
Will be the same as DOMAIN but required by Certbot

Environment variables

Auth Providers

Last modified 2yr ago

Name	Type	Domain	Description
LOG_FILE	String	Path	The name of the logfile that certbot writes to. We also redirect the auth providers to write to this log file.
CERTBOT_ROOT_PATH	String	Path	Path to the letsencrypt root directory which defaults to: `/etc/letsencrypt`. You don't normally need to alter this. Its primary purpose is for Unit Testing.
CERTBOT_VERBOSE	String	true \| false	Used by the `acquire` command to control the log level of the Certbot Auth and Cleanup hooks.
CERTBOT_AUTH_HOOK_PATH	String	Path	Path to the auth_hook script provided as part of nginx-le. The auth hook is called by certbot at the start of an attempt to acquire or renew a certificate.
CERTBOT_CLEANUP_HOOK_PATH	String	Path	Path to the cleanup_hook script provided as part of nginx-le. The cleanup hook is called by certbot when completing an attempt to acquire or renew a certificate.
CERTBOT_DEPLOY_HOOK	String	Path to the deploy_hook script provided as part of nginx-le. The deploy hook is called by certbot to deploy certificates into nginx. Its is only called when a certificate is sucessfully renewed or acquired.
DNS_RETRIES	int	Integer	The number of times the DNS Auth Hook will check the DNS for the required TXT record.
NGINX_CERT_ROOT_OVERWRITE	String	Path	Only used for Unit Testing. Sets the path where certbot saves certificates to.
NGINX_ACCESS_LOG_PATH	String	Path	Path to the Nginx access.log file in the container.
NGINX_ERROR_LOG_PATH	String	Path	Path to the Nginx error.log file in the container
NGINX_LOCATION_INCLUDE_PATH	String	Path	Path of the .location and .upstream files.