Caddy 是一个 Go 编写的 Web 服务器，类似于 Nginx

Caddy 是一个 Go 编写的 Web 服务器，类似于 Nginx

Caddy 是一个 Go 编写的 Web 服务器，类似于 Nginx，Caddy 提供了更加强大的功能，随着 v2 版本发布 Caddy 已经可以作为中小型站点 Web 服务器的另一个选择；相较于 Nginx 来说使用 Caddy 的优势如下:


自动的 HTTPS 证书申请(ACME HTTP/DNS 挑战)


自动证书续期以及 OCSP stapling 等


更高的安全性包括但不限于 TLS 配置以及内存安全等


友好且强大的配置文件支持


支持 API 动态调整配置(有木有人可以搞个 Dashboard)


支持 HTTP3(QUIC)


支持动态后端，例如连接 Consul、作为 k8s ingress 等


后端多种负载策略以及健康检测等


本身 Go 编写，高度模块化的系统方便扩展(CoreDNS 基于 Caddy1 开发)


……


就目前来说，Caddy 对于我个人印象唯一的缺点就是性能没有 Nginx 高，但是这是个仁者见仁智者见智的问题；相较于提供的这些便利性，在性能可接受的情况下完全有理由切换到 Caddy。


编译 Caddy2


注意: 在 Caddy1 时代，Caddy 官方发布的预编译二进制文件是不允许进行商业使用的，Caddy2 以后已经全部切换到 Apache 2.0 License，具体请参考 issue#2786。


在默认情况下 Caddy2 官方提供了预编译的二进制文件，以及自定义 build 下载页面，不过对于需要集成一些第三方插件时，我们仍需采用官方提供的 xcaddy 来进行自行编译；以下为具体的编译过程:

1.1、Golang 环境安装


本部分编译环境默认为 Ubuntu 20.04 系统，同时使用 root 用户，其他环境请自行调整相关目录以及配置；编译时自行处理好科学上网相关配置，也可以直接用国外 VPS 服务器编译。


首先下载 go 语言的 SDK 压缩包，其他平台可以从 https://golang.org/dl/ 下载对应的压缩包:


wget https://golang.org/dl/go1.15.6.linux-amd64.tar.gz

Caddy 是一个 Go 编写的 Web 服务器，类似于 Nginx

下载完成后解压并配置相关变量:


# 解压


tar -zxvf go1.15.6.linux-amd64.tar.gz


# 移动到任意目录


mkdir -p /opt/devtools


mv go /opt/devtools/go


# 创建 go 相关目录


mkdir -p ${HOME}/gopath/{src,bin,pkg}


# 调整变量配置，将以下变量加入到 shell 初始化配置中


# bash 用户请编辑 ~/.bashrc


# zsh 用户请编辑 ~/.zshrc


exportGOROOT= '/opt/devtools/go'


exportGOPATH= " ${HOME}/gopath"


exportGOPROXY= 'https://goproxy.cn'# 如果已经解决了科学上网问题，GOPROXY 变量可以删除，否则可能会起反作用


exportPATH= " ${GOROOT}/bin: ${GOPATH}/bin: ${PATH}"


# 让配置生效


# bash 用户替换成 ~/.basrc


# 重新退出登录也可以


source~/.zshrc


配置完成后，应该在命令行执行 go version 并有以下成功返回:


bleem ➜ ~ go version


go version go1.15.6 linux/amd64


1.2、安装 xcaddy


按照官方文档直接命令行执行 go get -u github.com/caddyserver/xcaddy/cmd/xcaddy 安装即可:


bleem ➜ ~ go get -u github.com/caddyserver/xcaddy/cmd/xcaddy


go: downloading github.com/caddyserver/xcaddy v0.1.7


go: found github.com/caddyserver/xcaddy/cmd/xcaddy ingithub.com/caddyserver/xcaddy v0.1.7


go: downloading github.com/Masterminds/semver/v3 v3.1.0


go: github.com/Masterminds/semver/v3 upgrade => v3.1.1


go: downloading github.com/Masterminds/semver/v3 v3.1.1


.....


安装完成后应当在命令行可以直接执行 xcaddy 命令:


# xcaddy 并没有提供完善的命令行支持，所以 `--help` 报错很正常


bleem ➜ ~ xcaddy -- help


go: cannot match "all": working directory is not part of a module


2021/01/07 12:15:56 [ERROR] exec[go list -m -f={{if .Replace}}{{.Path}} => {{.Replace}}{{end}} all]: exitstatus 1:


1.3、编译 Caddy2


编译之前系统需要安装 jq 、 curl 、 git 命令，没有的请使用 apt install -y curl git jq 命令安装；


自行编译的目的是增加第三方插件方便使用，其中官方列出的插件可以从 Download 页面获取到:




其他插件可以从 GitHub 上寻找或者自行编写，整理好这些插件列表以后只需要使用 xcaddy 编译即可:


# 获取最新版本号，其实直接去 GitHub realse 页复制一下就行


# 这里转化为脚本是为了方便自动化


exportversion=$(curl -s "https://api.github.com/repos/caddyserver/caddy/releases/latest"| jq -r .tag_name)


# 使用 xcaddy 编译


xcaddy build ${version}--output ./caddy_ ${version}


--with github.com/abiosoft/caddy-exec


--with github.com/caddy-dns/cloudflare


--with github.com/caddy-dns/dnspod


--with github.com/caddy-dns/duckdns


--with github.com/caddy-dns/gandi


--with github.com/caddy-dns/route53


--with github.com/greenpau/caddy-auth-jwt


--with github.com/greenpau/caddy-auth-portal


--with github.com/greenpau/caddy-trace


--with github.com/hairyhenderson/caddy-teapot-module


--with github.com/kirsch33/realip


--with github.com/porech/caddy-maxmind-geolocation


--with github.com/caddyserver/format-encoder


--with github.com/mholt/caddy-webdav


编译过程日志如下所示，稍等片刻后将会生成编译好的二进制文件:




编译成功后可以通过 list-modules 子命令查看被添加的插件是否成功编译到了 caddy 中:


bleem ➜ ~ ./caddy_v2.3.0 list-modules


admin.api.load


admin.api.metrics


caddy.adapters.caddyfile


caddy.listeners.tls


caddy.logging.encoders.console


caddy.logging.encoders.filter


caddy.logging.encoders.filter.delete


caddy.logging.encoders.filter.ip_mask


caddy.logging.encoders.formatted


caddy.logging.encoders.json


caddy.logging.encoders.logfmt


caddy.logging.encoders.single_field


caddy.logging.writers.discard


caddy.logging.writers.file


caddy.logging.writers.net


caddy.logging.writers.stderr


caddy.logging.writers.stdout


caddy.storage.file_system


dns.providers.cloudflare


dns.providers.dnspod


dns.providers.duckdns


dns.providers.gandi


dns.providers.route53


exec


http


http.authentication.hashes.bcrypt


http.authentication.hashes.scrypt


http.authentication.providers.http_basic


http.authentication.providers.jwt


......


安装 Caddy22.1、宿主机安装


宿主机安装 Caddy2 需要使用 systemd 进行守护，幸运的是 Caddy2 官方提供了各种平台的安装包以及 systemd 配置文件仓库；目前推荐的方式是直接采用包管理器安装标准版本的 Caddy2，然后替换自编译的可执行文件:


# 安装标准版本 Caddy2


sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https


curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/cfg/gpg/gpg.155B6D79CA56EA34.key'| sudo apt-key add -


curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/cfg/setup/config.deb.txt?distro=debian&version=any-version'| sudo tee -a /etc/apt/sources.list.d/caddy-stable.list


sudo apt update


sudo apt install caddy


# 替换二进制文件


systemctl stop caddy


rm -f /usr/bin/caddy


mv ./caddy_v2.3.0 /usr/bin/caddy


2.2、Docker 安装


Docker 用户可以通过 Dockerfile 自行编译 image，目前我编写了一个基于 xcaddy 的 Dockerfile，如果有其他插件需要集成自行修改重新编译即可；当前 Dockerfile 预编译的镜像已经推送到了 Docker Hub 中，镜像名称为 mritd/caddy 。


配置 Caddy2


Caddy2 的配置文件核心采用 json，但是 json 可读性不强，所以官方维护了一个转换器，抽象出称之为 Caddyfile 的新配置格式；关于 Caddyfile 的完整语法请查看官方文档 https://caddyserver.com/docs/caddyfile，本文仅做一些基本使用的样例。


3.1、配置片段


Caddyfile 支持类似代码中 function 一样的配置片段，这些配置片段可以在任意位置被 import ，同时可以接受参数，以下为配置片断示例:


# 括号内为片段名称，可以自行定义


(TLS) {


protocols tls1.2 tls1.3


ciphers TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256


}


# 在任意位置可以引用此片段从而达到配置复用


import TLS


3.2、配置模块化


import 指令除了支持引用配置片段以外，还支持引用外部文件，同时支持通配符，有了这个命令以后我们就可以方便的将配置文件进行模块化处理:


# 引用外部的 /etc/caddy/*.caddy


import /etc/caddy/*.caddy


3.3、站点配置


针对于站点域名配置，Caddyfile 比较自由化，其格式如下:


地址 {


站点配置


}


关于这个 “地址” 接受多种格式，以下都为合法的地址格式:


localhost


example.com


:443


http://example.com


localhost:8080


127.0.0.1


[::1]:2015


example.com/foo/*


*.example.com


http://


3.4、环境变量

Caddyfile 支持直接引用系统环境变量，通过此功能可以将一些敏感信息从配置文件中剔除:


# 引用环境变量 GANDI_API_TOKEN


dns gandi { $GANDI_API_TOKEN}


3.5、配置片段参数支持


针对于配置片段，Caddyfile 还支持类似于函数代码的参数支持，通过参数支持可以让外部引用时动态修改配置信息:


(LOG) {


log{


format json {


time_format "iso8601"


}


# "{args.0}" 引用传入的第一个参数，此处用于动态传入日志文件名称


output file "{args.0}"{


roll_size 100mb


roll_keep 3


roll_keep_for 7d


}


}


}


# 引用片段


import LOG "/data/logs/mritd.com.log"