ngdio/dehydrated repository overview

⁠Docker-Dehydrated

This Docker image containerizes dehydrated, a Let's Encrypt/ACME client implemented as a shell script.

⁠Features

• Based on Alpine Linux, which results in very small images
• Available on arm architectures

⁠How to run

Command line:

docker volume create dehydrated_data
docker volume create dehydrated_certs
docker volume create dehydrated_www
docker run -d \
    -v /etc/dehydrated:/dehydrated/config:ro
    -v dehydrated_data:/dehydrated/data
    -v dehydrated_certs:/dehydrated/certs
    -v dehydrated_www:/dehydrated/www
    ngdio/dehydrated

docker-compose:

version: "2"
containers:
  dehydrated:
    image: ngdio/dehydrated
    restart: always
    volumes:
    - /etc/dehydrated:/dehydrated/config:ro
    - dehydrated_data:/dehydrated/data
    - dehydrated_certs:/dehydrated/certs
    - dehydrated_www:/dehydrated/www

volumes:
  dehydrated_data:
  dehydrated_certs:
  dehydrated_www:

⁠Volumes

The /dehydrated folder consists of four subfolders:

• /dehydrated/config: contains the configuration files (see below). Please make sure the mounted folder contains the configuration files. You can find the standard configuration in the repository⁠, please adapt them to your needs.
• /dehydrated/www: dehydrated will put the ACME challenges in this folder. Since dehydrated does not include a web server, you will have to mount this folder to a volume and share the challenges with a web server such as nginx or Apache. The folder must be made available to the public at /.well-known/acme-challenge/ via HTTP.
• /dehydrated/certs: contains the certs obtained from Let's Encrypt. Each certificate is located in its own subfolder named after the first domain of its line in domains.txt.
• /dehydrated/data: data including leases and lock files which the user usually doesn't need to access. It is recommended to use a Docker volume for this folder.

⁠Configuration Files

The configuration folder (/dehydrated/config) usually contains three different files:

• /dehydrated/config/config: the main configuration file. Adapt this to your needs. (link to standard config)⁠
• /dehydrated/config/domains.txt: specifies for which domains certificates will be requested. dehydrated creates one certificate for each line, which can contain multiple domains seperated by spaces. (link to standard domains.txt)⁠
• /dehydrated/config/hook.sh: shell script containing multiple functions which will be executed at specific times during the creation of certificates. For further information, take a look at the file. (link to standard hook.sh)⁠

⁠Contributions

• The automated build was adapted from marthoc⁠'s deconz docker image⁠.
• The Dockerfile is based on NGINX Inc.'s official Docker image for nginx⁠.

⁠Quick reference

• Where to file issues:
  https://github.com/ngdio/docker-dehydrated/issues⁠

• Maintained by:
  Niklas (ngdio)⁠

• Supported architectures:
  amd64⁠, i386⁠, armhf⁠, aarch64⁠

• License:
  The content of this repository is licensed under the GPL 2-clause license⁠. dehydrated is licensed under the MIT license⁠.