homeall/caddy-reverse-proxy-cloudflare

Caddy反向代理（含Cloudflare插件）

概述

本Docker镜像基于https://hub.docker.com/r/lucaslorentz/caddy-docker-proxy的Caddy-Docker-Proxy镜像构建，额外集成了https://github.com/caddy-dns/cloudflare。这是与原镜像的唯一区别。

该镜像主要用于结合https://caddyserver.com/反向代理、https://letsencrypt.org/证书服务和https://www.cloudflare.com/dns/进行DNS验证，特别适用于需要为**通配符域名**获取SSL证书的场景。此外，通过https://github.com/mholt/caddy-dynamicdns可保持IP地址自动更新。

如需详细使用方法，建议参考原镜像的https://github.com/lucaslorentz/caddy-docker-proxy。

核心功能与特性

• 基于Caddy反向代理：支持Docker环境下的动态服务发现与反向代理配置
• Cloudflare DNS集成：通过Cloudflare DNS验证方式自动获取Let's Encrypt证书
• 通配符域名支持：专为通配符域名（如*.example.com）的SSL证书签发设计
• 自动更新：通过GitHub Actions每周更新镜像及插件版本
• 多架构支持：兼容amd64、arm64（如树莓派）及arm32架构
• 健康检查：内置健康检查机制，确保服务正常运行

使用场景

• 需要通过Cloudflare DNS验证获取Let's Encrypt证书的HTTPS部署
• 通配符域名的SSL证书自动管理
• Docker环境下的动态反向代理配置（如多服务统一入口）

使用前提

• https://docs.docker.com/engine/install/ 环境
• https://docs.docker.com/compose/ 工具
• 已注册的域名（可通过Name Cheap等域名服务商获取）
• https://www.cloudflare.com/en-gb/learning/dns/glossary/dns-zone/（域名已接入Cloudflare DNS）
• Cloudflare Scoped API令牌（获取方法参考https://github.com/libdns/cloudflare#authenticating）

使用方法

Docker Compose配置

通过docker-compose.yml部署，使用标签（labels）定义Caddy配置。以下为基础示例：

yaml
version: "3.3"

services:
  caddy:
    container_name: caddy
    image: docker.xuanyuan.run/homeall/caddy-reverse-proxy-cloudflare:latest
    restart: unless-stopped
    environment:
      TZ: 'Europe/London'  # 时区设置
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"  # 需挂载Docker套接字以监听容器事件
      - "./caddy-data:/data"  # 持久化存储证书等数据
    ports:
      - "80:80"   # HTTP端口
      - "443:443" # HTTPS端口
    labels:  # 全局配置
      caddy.email: email@example.com  # 用于ACME证书注册的邮箱

  whoami0:  # 示例服务
    container_name: whoiam
    image: docker.xuanyuan.run/jwilder/whoami:latest
    hostname: YourBigBoss  # curl访问时的预期响应 hostname
    restart: unless-stopped
    labels:
      caddy: your.example.com  # Caddy监听的域名
      caddy.reverse_proxy: "{{upstreams 8000}}"  # 反向代理至容器的8000端口
      caddy.tls.protocols: "tls1.3"  # 可选：TLS协议版本（默认tls1.2）
      # 测试环境使用Let's Encrypt staging CA（正式环境需删除此行）
      caddy.tls.ca: "https://acme-staging-v02.api.letsencrypt.org/directory"
      caddy.tls.dns: "cloudflare $API-TOKEN"  # 替换$API-TOKEN为实际Cloudflare API令牌

配置说明

• Caddy服务标签：
  • caddy.email：Let's Encrypt证书注册***（必填）
• 后端服务标签：
  • caddy：指定Caddy监听的域名（如your.example.com）
  • caddy.reverse_proxy：定义反向代理目标，{{upstreams 8000}}表示自动发现容器的8000端口
  • caddy.tls.dns：Cloudflare DNS验证配置，需替换$API-TOKEN为实际Cloudflare API令牌

测试验证

服务可用性测试

部署后，可通过curl命令测试HTTPS是否正常工作：

bash
# 测试证书信息（--insecure用于测试环境，正式环境可移除）
curl --insecure -vvI https://your.example.com 2>&1 | awk 'BEGIN { cert=0 } /^\* Server certificate:/ { cert=1 } /^\*/ { if (cert) print }'

预期输出应包含证书信息，如：

* Server certificate:
*  subject: CN=your.example.com
*  start date: ... 
*  expire date: ...
*  issuer: CN=Fake LE Intermediate X1  # 测试环境CA，正式环境为Let's Encrypt

访问服务内容：

bash
curl -k https://your.example.com  # -k用于测试环境跳过证书验证

预期返回后端服务响应（如示例中的YourBigBoss主机名）。

健康检查验证

通过Docker命令检查Caddy服务健康状态：

bash
docker inspect --format "{{json .State.Health }}" caddy | jq

健康状态输出示例：

json
{
  "Status": "healthy",
  "FailingStreak": 0,
  "Log": [
    {
      "Start": "...",
      "End": "...",
      "ExitCode": 0,
      "Output": ""
    }
  ]
}

许可证

本项目基于MIT许可证开源，详情参见https://raw.githubusercontent.com/homeall/caddy-reverse-proxy-cloudflare/main/LICENSE。

联系方式

如有问题，建议在https://github.com/homeall/caddy-reverse-proxy-cloudflare提交issue。

致谢

• https://hub.docker.com/r/lucaslorentz/caddy-docker-proxy（原Caddy-Docker-Proxy镜像作者）
• https://caddyserver.com/ 及社区
• https://github.com/caddy-dns/cloudflare 开发者