使用 Caddy 代替 Nginx

2017-12-03

3分钟阅读时长

提醒：本文最后更新于 2321 天前，文中所描述的信息可能已发生改变，请谨慎使用。

Caddy 是一款由 Go 编写的 Web Server 工具，在折腾 Drone 的时候，我最终就是使用的它提供 Web 服务。回到标题，为什么要用 Caddy 替换掉 Nginx 呢？最主要的原因是 Caddy 能让网站自动支持 HTTPS。同样是使用 Let’s Encrypt，换成 Nginx 我们就必须手工操作，并且还需要设置三个月更新证书的计划任务。而且默认还支持 http/2，很多事情都不需要我们再配置了。另外它的配置文件也比 Nginx 的要简单很多，几十行的 Nginx 配置文件 Caddy 仅需要几行就可以搞定了。

安装 Caddy

Caddy 提供了一键安装命令生成功能，访问 https://caddyserver.com/download 选择对应的平台，插件可默认为空，最后选择对应的协议后下方即会生成一键安装命令，例如：

$ curl https://getcaddy.com | bash -s personal

安装后执行 which caddy 你会发现 Caddy 已经安装到了 /usr/local/bin/caddy 位置。

caddy命令生成

$ echo 'localhost:8000' >> Caddyfile
$ caddy

执行如上命令在浏览器中访问 http://localhost:8000 发现 Caddy 启动了一个简单的 HTTP 服务器。

后台启动

首先我们为 Caddy 创建一个配置目录，这里以 /etc/caddy 为例。同时我们还需要生成一个目录用来给 Caddy 放置网站证书。

$ sudo mkdir /etc/caddy
$ sudo mkdir /etc/caddy/conf
$ echo 'import ./conf/*' >> /etc/caddy/Caddyfile
$ sudo mkdir /etc/ssl/caddy

从官方仓库中下载 caddy 的 systemctl 守护脚本并对其挂载启动。

$ sudo curl -s https://raw.githubusercontent.com/mholt/caddy/master/dist/init/linux-systemd/caddy.service -o /etc/systemd/system/caddy.service
$ sudo systemctl daemon-reload
$ sudo systemctl enable caddy
$ sudo systemctl start caddy

这样我们就完成 caddy 后台启动任务，可以使用 status 命令查看 caddy 的状态：

$ sudo systemctl status caddy

Caddyfile

Caddyfile 是 Caddy 的配置文件，刚才我们写入了一条 import ./conf/* 命令，表示将 /etc/caddy/conf/ 下的所有文件都导入到配置文件中。下面我就以几个大家常见的需求列举一下如何编写 Caddfile 配置。

静态资源

和 Nginx 一样，Caddy 也有一个 root 配置。静态资源的访问只要设置到对应的 root 即可。同时我们也为资源配置了 gzip 压缩功能。

$ sudo cat << EOF > /etc/caddy/conf/static.example.com
static.example.com {
    gzip
    root    /var/www/static.example.com
}
EOF
$ sudo systemctl restart caddy

反向代理

反向代理请求到另外的端口算是我们比较常见的需求了，通过 proxy 指令我们可以非常简单的做到。以 ThinkJS 的配置为例，我们在静态资源配置的基础之上，增加了 proxy 指令将请求反向代理到了 http://127.0.0.1:8360 端口。由于反向代理后丢失了原始请求的 HOST，我们使用 transparent 指令增加 X-* 头。最后我们使用 except 指令排除了 /static 的请求，因为这些请求是静态资源的不需要反代。

$ sudo cat << EOF > /etc/caddy/conf/thinkjs.example.com
thinkjs.example.com {
    gzip
    root /var/www/thinkjs.example.com/www
    proxy / http://127.0.0.1:8360 {
        transparent
        except static
    }
}
$ sudo systemctl restart caddy

我们可以对比下 ThinkJS Nginx 的配置文件，以下还仅仅只是 HTTP 的配置，没有加上 HTTPS 以及 HTTP/2 的配置。所以 Caddy 的简单性不言而喻。

server {
    listen 80;
    server_name example.com www.example.com;
    root <%= ROOT_PATH %>;
    set $node_port 8360;

    index index.js index.html index.htm;
    if ( -f $request_filename/index.html ){
        rewrite (.*) $1/index.html break;
    }
    if ( !-f $request_filename ){
        rewrite (.*) /index.js;
    }
    location = /index.js {
        proxy_http_version 1.1;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_pass http://127.0.0.1:$node_port$request_uri;
        proxy_redirect off;
    }

    location ~ /static/ {
        etag         on;
        expires      max;
    }
}

Websocket

Caddy 配置 WebSocket 也非常简单，使用 websocket 指令即可。

$ sudo cat << EOF > /etc/caddy/conf/thinkjs.example.com
ws.example.com {
    gzip
    root /var/www/ws.example.com/www
    proxy / http://127.0.0.1:8360 {
        websocket
        transparent
        except static
    }
}
$ sudo systemctl restart caddy