Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 2.72 KB

README.md

File metadata and controls

48 lines (39 loc) · 2.72 KB
Raw

le-dns-updater - Update LE certs with DNS challenge

This is a simple tool wrapping lego to update LE certs with DNS challenge. It is intended to be used in a docker container to automate the process of issuing and updating LE certificates.

Usage

  • Create a docker-compose.yml file with the following service:
 le-dns-updater:
        image: umputun/le-dns-updater:master
        container_name: le-dns-updater
        hostname: le-dns-updater
        restart: always

        logging:
          driver: json-file
          options:
              max-size: "10m"
              max-file: "5"
        volumes:
            - ./var:/srv/var
            - /var/run/docker.sock:/var/run/docker.sock:ro # to allow access to nginx container for cert update hook (optional)
        environment: # all env variables for the selected provider. See https://github.com/go-acme/lego#dns-providers for details
            - "AWS_REGION=eu-west-1"
            - "AWS_ACCESS_KEY_ID=xxxxxxxxxxxxxxxxxxxx"
            - "AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
            - "DNS_RESOLVER=1.1.1.1" # optional, use custom DNS resolver
        command:
            - someuser@example.com # email
            - route53              # provider
            - "test.example.com test2.example.com" # domains, separated by space
            - docker restart nginx # hook command to run on certificate update (optional)
  • Update compose file with your email, provider, domain(s) and hook command (optional)
  • See the list of supported providers here
  • In case if generated certificates are used by other containers and needed to be relocated, you can use hook command to copy them to the desired location. In the example above, certificates will be copied to /etc/certificates directory on the host machine.

Technical details

  • The container is based on alpine image and available on docker hub (umputun/le-dns-updater) as well as on github (ghcr.io/umputun/le-dns-updater)
  • Stable container is built from the tagged revision and tagged with :latest tag
  • Unstable container is built from master branch and tagged with :master tag
  • Certificates are stored in /srv/var/certificates directory inside the container and should be mapped to the host machine or docker volume
  • Certificates are checked and updated every 10 days, if needed
  • Hook command is executed every time certificates are updated, and can be used to copy certificates to the desired location or/and restart other containers