Build from source
Requirements:
- Go 1.16 or newer
Clone the repository:
git clone "https://github.com/caddyserver/caddy.git"
If you don't have git, you can download the source code as a file archive from GitHub. Each release also has source snapshots.
Build:
cd caddy/cmd/caddy/
go build
xcaddy
The xcaddy
command is the easiest way to build Caddy with version information and/or plugins.
Requirements:
- Go installed (see above)
- Make sure
xcaddy
is in your PATH
You do not need to download the Caddy source code (it will do that for you).
Then building Caddy (with version information) is as easy as:
xcaddy build
To build with plugins, use --with
:
xcaddy build \
--with github.com/caddyserver/nginx-adapter
--with github.com/caddyserver/ntlm-transport@v0.1.1
As you can see, you can customize the versions of plugins with @
syntax. Versions can be a tag name, commit SHA, or branch.
Cross-platform compilation with xcaddy
works the same as with the go
command (see below).
Cross-platform
Go programs are easy to compile for other platforms. Just set the GOOS
, GOARCH
, and/or GOARM
environment variables that are different. (See the go documentation for details.)
For example, to compile Caddy for Windows when you're not on Windows:
GOOS=windows go build
Or similarly for Linux ARMv6 when you're not on Linux or on ARMv6:
GOOS=linux GOARCH=arm GOARM=6 go build
The same works for xcaddy
. To cross-compile for macOS:
GOOS=darwin xcaddy build
Package support files for custom builds for Debian/Ubuntu/Raspbian
This procedure aims to simplify running custom caddy
binaries while keeping support files from the caddy
package.
This procedure allows users to take advantage of the default configuration, systemd service files and bash-completion from the official package.
Requirements:
- Install
caddy
package according to these instructions - Build your custom
caddy
binary according to the procedure listed in this document. (see above) - Your custom
caddy
binary should be located in the current directory.
Procedure:
dpkg-divert --divert /usr/bin/caddy.default --rename /usr/bin/caddy
mv ./caddy /usr/bin/caddy.custom
update-alternatives --install /usr/bin/caddy caddy /usr/bin/caddy.default 10
update-alternatives --install /usr/bin/caddy caddy /usr/bin/caddy.custom 50
dpkg-divert
will move /usr/bin/caddy
binary to /usr/bin/caddy.default
and put a diversion in place in case any package want to install a file to this location.
update-alternatives
will create a symlink from the desired caddy binary to /usr/bin/caddy
You can change between the custom and default caddy
binaries by executing
update-alternatives --config caddy
and following the on screen information.