文档
一个 项目

从源代码构建

如果您需要自定义构建（例如带有插件），有多种构建 Caddy 的选项：

  • Git：从 Git 仓库构建
  • xcaddy：使用 xcaddy 构建
  • Docker：构建自定义 Docker 镜像

要求：

  • Go 1.20 或更新版本

包支持文件部分包含了使用 APT 命令在基于 Debian 的系统上安装 Caddy 但需要自定义构建可执行文件的用户的说明。

Git

要求：

  • 安装 Go（见上文）

克隆仓库：

git clone "https://github.com/caddyserver/caddy.git"

如果您没有 git，您可以从 GitHub 下载源代码文件存档。每个发布版本也有源代码快照。

构建：

cd caddy/cmd/caddy/
go build

Go 程序很容易为其他平台编译。只需设置不同的 GOOS、GOARCH 和/或 GOARM 环境变量。（详见 go 文档。）

例如，当您不在 Windows 上时，要为 Windows 编译 Caddy：

GOOS=windows go build

或者类似地，当您不在 Linux 或 ARMv6 上时，为 Linux ARMv6 编译：

GOOS=linux GOARCH=arm GOARM=6 go build

xcaddy

xcaddy 命令是构建带有版本信息和/或插件的 Caddy 的最简单方法。

要求：

  • 安装 Go（见上文）
  • 确保 xcaddy 在您的 PATH 中

您不需要下载 Caddy 源代码（它会为您完成这个工作）。

然后构建 Caddy（带版本信息）就像这样简单：

xcaddy build

要构建带插件的版本，使用 --with：

xcaddy build \
    --with github.com/caddyserver/nginx-adapter
	--with github.com/caddyserver/ntlm-transport@v0.1.1

如您所见，您可以使用 @ 语法自定义插件的版本。版本可以是标签名、提交 SHA 或分支。

使用 xcaddy 的跨平台编译与 go 命令相同。例如，要为 macOS 交叉编译：

GOOS=darwin xcaddy build

Docker

您可以使用 :builder 镜像作为构建带有自定义模块的新 Caddy 二进制文件的捷径：

FROM caddy:<version>-builder AS builder

RUN xcaddy build \
    --with github.com/caddyserver/nginx-adapter \
    --with github.com/hairyhenderson/caddy-teapot-module@v0.0.3-0

FROM caddy:<version>

COPY --from=builder /usr/bin/caddy /usr/bin/caddy

确保将 <version> 替换为最新版本的 Caddy。

注意第二个 FROM 指令 — 这通过简单地将新构建的二进制文件覆盖在常规 caddy 镜像之上，生成一个小得多的镜像。

构建器使用 xcaddy 构建带有提供的模块的 Caddy，类似于上面概述的过程。

要使用 Docker Compose，请参见我们推荐的 compose.yml 和使用说明。

Debian/Ubuntu/Raspbian 的自定义构建的包支持文件

此过程旨在简化运行自定义 caddy 二进制文件，同时保留 caddy 包的支持文件。

此过程允许用户利用官方包的默认配置、systemd 服务文件和 bash 补全功能。

要求：

  • 按照这些说明安装 caddy 包
  • 构建您的自定义 caddy 二进制文件（见上述部分），或下载自定义构建
  • 您的自定义 caddy 二进制文件应位于当前目录

过程：

sudo dpkg-divert --divert /usr/bin/caddy.default --rename /usr/bin/caddy
sudo mv ./caddy /usr/bin/caddy.custom
sudo update-alternatives --install /usr/bin/caddy caddy /usr/bin/caddy.default 10
sudo update-alternatives --install /usr/bin/caddy caddy /usr/bin/caddy.custom 50
sudo systemctl restart caddy

说明：

  • dpkg-divert 会将 /usr/bin/caddy 二进制文件移至 /usr/bin/caddy.default，并在任何包想要在此位置安装文件时放置一个转移。

  • update-alternatives 将从所需的 caddy 二进制文件创建一个指向 /usr/bin/caddy 的符号链接。

  • systemctl restart caddy 将关闭默认版本的 Caddy 服务器并启动自定义版本。

您可以通过执行以下命令在自定义和默认 caddy 二进制文件之间切换，并按照屏幕上的信息操作。然后，重启 Caddy 服务。

update-alternatives --config caddy

在此之后要升级 Caddy，您可以运行 caddy upgrade。这尝试下载具有与当前构建相同插件的最新版本 Caddy 的构建，然后用新二进制文件替换当前二进制文件。