brahmadev/acme-lego-cron

acme-lego-cron

https://github.com/brahma-dev/acme-lego-cron/workflows/build/badge.svg](https://github.com/brahma-dev/acme-lego-cron/actions)

镜像概述

acme-lego-cron是Docker化的https://go-acme.github.io/lego/%E5%B7%A5%E5%85%B7%EF%BC%8C%E9%9B%86%E6%88%90cron%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1%EF%BC%8C%E4%B8%93%E4%B8%BADNS ACME挑战设计，用于自动获取和续期Let's Encrypt SSL证书。其他类型的ACME挑战可通过LEGO_ARGS环境变量进行配置。

核心功能和特性

• 定时自动续期：通过cron任务定期执行证书申请和续期流程，无需手动干预
• 多DNS提供商支持：兼容超过100种DNS提供商，满足不同基础设施需求
• 环境灵活切换：可在生产/测试（staging）Let's Encrypt端点间切换，便于开发调试
• 自定义密钥配置：支持指定密钥类型，满足不同安全需求
• 证书钩子机制：支持挂载自定义脚本，在证书颁发后自动执行后续操作（如服务重启）
• 参数扩展能力：通过LEGO_ARGS传递额外参数，支持高级配置

环境变量

通过环境变量控制自动化流程的各个环节，以下是Lego相关的核心配置：

Lego配置参数

Hooks

可将自定义shell脚本挂载到容器的/app/hook.sh路径，脚本将在证书成功颁发后自动执行。镜像预装了bash、curl、wget和jq工具，便于编写功能丰富的钩子脚本（如证书部署、服务重启等操作）。

使用示例

基础示例：使用Cloudflare DNS获取证书

以下示例通过Cloudflare DNS提供商获取example.com和*.example.com的SSL证书，并使用测试环境进行开发调试：

yaml
services:
  lego:
    image: brahmadev/acme-lego-cron:latest
    environment:
      STAGING: 1  # 使用测试环境端点，避免生产环境请求限制
      DOMAINS: "example.com;*.example.com"  # 主域名和通配符域名，使用分号分隔
      EMAIL_ADDRESS: user@example.com  # 用于注册的联系邮箱
      CLOUDFLARE_DNS_API_TOKEN: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX  # Cloudflare API令牌
      PROVIDER: cloudflare  # 指定DNS提供商为Cloudflare
      LEGO_ARGS: "--dns.disable-cp --dns.resolvers 1.1.1.1"  # 禁用CP或指定DNS解析器
    volumes:
      - ./letsencrypt:/letsencrypt  # 挂载本地目录存储证书文件

高级示例：带钩子脚本的Nginx集成

以下示例包含Nginx服务和lego服务，当证书更新时，钩子脚本将自动重启Nginx服务以应用新证书。查看https://github.com/brahma-dev/acme-lego-cron/blob/main/app/hook.sh%E8%8E%B7%E5%8F%96%E6%9B%B4%E5%A4%9A%E7%BB%86%E8%8A%82%EF%BC%9A

yaml
services:
  nginx:
    container_name: nginx01
    image: nginx:alpine
    ports:
      - mode: host
        published: 443
        target: 443
      - mode: host
        published: 80
        target: 80
    volumes:
      - ./html/:/var/www/html  # 网站根目录
      - ./nginx-example.conf:/etc/nginx/conf.d/default.conf  # Nginx配置
      - ./letsencrypt:/letsencrypt  # 共享证书目录给Nginx
  lego:
    image: brahmadev/acme-lego-cron:latest
    environment:
      STAGING: 1  # 开发阶段使用测试环境
      DOMAINS: "example.com;*.example.com"  # 域名配置
      EMAIL_ADDRESS: ***  # 注册***
      CLOUDFLARE_DNS_API_TOKEN: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX  # Cloudflare API凭证
      PROVIDER: cloudflare  # DNS提供商
      LEGO_ARGS: "--dns.disable-cp"  # 额外lego参数
    volumes:
      - ./hook.sh:/app/hook.sh  # 挂载钩子脚本，证书更新后执行
      - /var/run/docker.sock:/var/run/docker.sock  # 允许钩子脚本操作Docker服务
      - ./letsencrypt:/letsencrypt  # 证书存储目录