https://github.com/rea1shane/lego-docker-helper

Make Lego deploy certificates in Docker easier
https://github.com/rea1shane/lego-docker-helper

acme acme-client certificate docker docker-compose docker-image dockerfile go lego letsencrypt shell tls

Last synced: 14 days ago
JSON representation

Make Lego deploy certificates in Docker easier

• Host: GitHub
• URL: https://github.com/rea1shane/lego-docker-helper
• Owner: rea1shane
• Created: 2024-09-03T09:44:19.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T02:42:07.000Z (about 2 months ago)
• Last Synced: 2024-10-10T22:23:27.730Z (about 1 month ago)
• Topics: acme, acme-client, certificate, docker, docker-compose, docker-image, dockerfile, go, lego, letsencrypt, shell, tls
• Language: Shell
• Homepage: https://hub.docker.com/r/rea1shane/lego-docker-helper
• Size: 37.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [Lego](https://github.com/go-acme/lego) Docker helper

Use Docker label to determine which certificates should be deployed to which containers and deploy them via the Docker client.

No changes were made other than installing `docker-cli` and [`helper.sh`](https://github.com/rea1shane/lego-docker-helper/blob/main/helper.sh) on the original image. See [Dockerfile](https://github.com/rea1shane/lego-docker-helper/blob/main/Dockerfile).

Features:

- Use `crond` as daemon.

- Provide some useful functions ([demo](https://github.com/rea1shane/lego-docker-helper/tree/main/demo)):

  - `docker_copy_by_label`: Copy certificates to containers with specified Docker label.

  - `docker_exec_by_label`: Execute command in containers with specified Docker label.

  - `docker_restart_by_label`: Restart containers with specified Docker label.

## Usage

First, adding labels to containers where certificates need to be deployed, like [this](https://github.com/rea1shane/lego-docker-helper/blob/main/demo/docker-compose.yaml#L14). Then down and up containers to make labels take effect.

Second, make your own hook script, like [this](https://github.com/rea1shane/lego-docker-helper/blob/main/hook.sh.example).

Then, up `lego-docker-helper` container and mount `docker.sock` in it with `rw` permission, like [this](https://github.com/rea1shane/lego-docker-helper/blob/main/demo/docker-compose.yaml#L8). Also don't forget to mount your hook script into the container.

> [!IMPORTANT]

>

> By default, container use UTC. To set cron expressions by local time, specify your time zone with the environment variable `TZ` when start the container, like [this](https://github.com/rea1shane/lego-docker-helper/blob/main/demo/docker-compose.yaml#L6). See [list with all the timezones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).

Finally, do anything else as you did before with Lego.

> [!TIP]

>

> Edit cron jobs via `crontab -e` to ensure that `crond` can be reloaded.