Caddy配置指南

---

start

下载安装

从Github的release页下载相应操作系统的最新版本，使用dpkg安装

wget https://github.com/caddyserver/caddy/releases/download/v2.7.6/caddy_2.7.6_linux_amd64.deb
sudo dpkg -i caddy_2.7.6_linux_amd64.deb

验证是否正确安装

1. 二进制文件位置

   which caddy
   # /usr/bin/caddy

1. caddy用户 （若未建立请手动添加👉添加用户）

   id caddy
   # uid=998(caddy) gid=998(caddy) groups=998(caddy),33(www-data)

2. systemd配置文件

安装完成后会自动生成systemd配置文件，位于/lib/systemd/system/caddy.service，内容如下：

[Unit]
Description=Caddy
Documentation=https://caddyserver.com/docs/
After=network.target network-online.target
Requires=network-online.target

[Service]
Type=notify
User=caddy
Group=caddy
ExecStart=/usr/bin/caddy run --environ --config /etc/caddy/Caddyfile
ExecReload=/usr/bin/caddy reload --config /etc/caddy/Caddyfile --force
TimeoutStopSec=5s
LimitNOFILE=1048576
LimitNPROC=512
PrivateTmp=true
ProtectSystem=full
AmbientCapabilities=CAP_NET_ADMIN CAP_NET_BIND_SERVICE

[Install]
WantedBy=multi-user.target

可见caddy默认加载的Caddyfile配置文件位于/etc/caddy/Caddyfile，在后续配置站点的过程中，也只需要编辑该文件即可。

添加用户（可选）

添加一个名为caddy的用户用于运行Caddy程序。

sudo groupadd --system caddy
sudo useradd --system \
    --gid caddy \
    --create-home \
    --home-dir /var/lib/caddy \
    --shell /usr/sbin/nologin \
    --comment "Caddy web server" \
    caddy

注意：caddy用户的home目录位于/var/lib/caddy，静态文件需要放在这个目录下才能访问。

配置文件

vim /etc/caddy/Caddyfile

# To use your own domain name (with automatic HTTPS), first make
# sure your domain's A/AAAA DNS records are properly pointed to
# this machine's public IP, then replace ":80" below with your
# domain name.

:80 {
        # Set this path to your site's directory. if your root path starts with /, you'll need to add a * matcher token to distinguish it from a path matcher.
        root * /usr/share/caddy

        # Enable the static file server.
        file_server

        # Another common task is to set up a reverse proxy:
        # reverse_proxy localhost:8080

        # Or serve a PHP site through php-fpm:
        # php_fastcgi localhost:9000
}

# Refer to the Caddy docs for more information:
# https://caddyserver.com/docs/caddyfile

常用配置

官方文档：https://caddyserver.com/docs/caddyfile

静态文件

加上brower可以显示文件列表，否则智能访问指定路径的文件。

:8005 {
  root * /var/lib/caddy
  file_server brower
}

反向代理

:8005 {
  reverse_proxy /v1/* localhost:9000
  reverse_proxy /v2/* localhost:9001
  @websockets {	# 通过header中的字段匹配websocket请求
    header Connection *Upgrade*
    header Upgrade    websocket
  }
  reverse_proxy @websockets localhost:6001
}

路径匹配

有时候会需要根据路径把请求转发给不同的服务器，比如将/v1/开头的转发给openai，把/v2/开头的转发给closeai，但转发给closeai接收的路径也需要是/v1/，这就需要先匹配/v2/再替换成/v1/再转发给closeai服务器。

:8080 {
  import log_file openai
  reverse_proxy /v1/* {
    to https://api.openai.com
    header_up Host api.openai.com
    
  }
  handle_path /v2/* {	# 注意：该操作会自动移除匹配到的前缀
    rewrite * /v1{uri}
    reverse_proxy {
      to https://api.closeai.com
      header_up Host api.closeai.com
    }
  }
}

错误码处理

:8080 {
	...
  handle_errors {
    @5xx `{err.status_code} >= 500 && {err.status_code} < 600`
    handle @5xx {
      respond "503 \{\"msg\": \"Proxy Server Error\"\}"
    }

    handle {
      respond "{err.status_code} {err.status_text}"
    }
  }
}

日志文件

为方便多站点复用配置，可以新建一个snippet：

(log_file) {
  log {
    format filter {
      wrap console
      fields {
        request>headers>User-Agent delete
      }
    }
    output file /var/log/caddy/{args[0]}.access.log {
       roll_size 10mb
       roll_keep 3
       roll_keep_for 7d    
      }
  }
}

在站点配置中引用log_file即可，后面加上一个参数，表示自定义的文件名，如：

gh.luzy.top {
  import log_file gh
  reverse_proxy * localhost:7703
}

其他

使用ufw管理防火墙

设置默认关闭所有端口

sudo apt-get install ufw
sudo ufw enable
sudo ufw default deny

设置启用端口（可用服务名或端口号）

sudo ufw allow 22/tcp
sudo ufw allow http
sudo ufw allow https

删除规则

sudo ufw delete allow https

查询状态

ufw status

重载firewall

ufw reload