1
0
Fork 0
docker-easy-haproxy/docs/acme.md
Joao Gilberto Magalhaes 4bb1c7931d Added Retry Count
2023-07-02 11:19:51 -05:00

5.2 KiB

SSL - Automatic Certificate Management Environment (ACME)

The Automatic Certificate Management Environment (ACME) protocol allow automating interactions between certificate authorities and their users' servers, allowing the automated deployment of public key infrastructure.

Most of the issuers offers Automatic Issuing free of cost.

To enable the ACME protocol we need to enable Certbot in EasyHAProxy by setting up to 4 environment variables:

  • EASYHAPROXY_CERTBOT_AUTOCONFIG (optional): Will use pre-sets for your Certificate Authority (CA). See table below.
  • EASYHAPROXY_CERTBOT_EMAIL (required): Your email in the certificate authority.
  • EASYHAPROXY_CERTBOT_SERVER (optional): The ACME Endpoint of your certificate authority. If you use AUTOCONFIG, it is set automatically. See table below.
  • EASYHAPROXY_CERTBOT_EAB_KID (optional): External Account Binding (EAB) Key Identifier (KID) provided by your certificate authority. Some CA require it. See table below.
  • EASYHAPROXY_CERTBOT_EAB_HMAC_KEY (optional): External Account Binding (EAB) HMAC Key provided by your certificate authority. Some CA require it. See table below.
  • EASYHAPROXY_CERTBOT_RETRY_COUNT (optional): Wait 'n' requests before retrying issue invalid requests. Default 60.

Here are detailed instructions per Certificate Authority (CA). If anyone is missing, please let's know.

CA Auto Config Free? Account Required? EAB KID? EAB HMAC Key? More Info
Let's Encrypt - Yes No No No Link
Let's Encrypt (Test) letsencrypt_test Yes No No No Link
ZeroSSL zerossl Yes No No No Link
BuyPass buypass Yes No No No Link
BuyPass (test) buypass_test Yes No No No Link
Google google Yes Yes Yes Yes Link
Google Test google_test Yes Yes Yes Yes Link
SSLCOM RCA sslcom_rca Yes No. Keys by email. Yes Yes Link
SSLCOM ECC sslcom_ecc Yes No. Keys by email. Yes Yes Link
Digicert - No Yes Yes Yes Link
Entrust - No Yes Yes Yes Link
Sectigo - No Yes Yes Yes Link

This configuration is global. After set up ACME properly, is necessary enable for each domain the certificate request.

To do that add the label: easyhaproxy.<definition>.certbot=true. See the method of installation you are using to learn how to set up properly.