install.md

Title: Install - Caddy Documentation

URL Source: https://caddyserver.com/docs/install

Markdown Content: This page describes various methods for installing Caddy on your system.

Official:

Community-maintained:

Static binaries🔗

If installing onto a production system, we recommend using our official package for your distro if available below.

Obtain a Caddy binary: * from releases on GitHub (expand "Assets")
- Refer to Verifying Asset Signatures for how to verify the asset signature

*   [from our download page](https://caddyserver.com/download)
*   [by building from source](https://caddyserver.com/docs/build) (either with `go` or `xcaddy`)

Install Caddy as a system service. This is strongly recommended, especially for production servers.

Place the binary in one of your $PATH (or %PATH% on Windows) directories so you can run caddy without typing the full path of the executable file. (Run echo $PATH to see the list of directories that qualify.)

You can upgrade static binaries by replacing them with newer versions and restarting Caddy. The caddy upgrade command can make this easy.

Debian, Ubuntu, Raspbian🔗

Installing this package automatically starts and runs Caddy as a systemd service named caddy. It also comes with an optional caddy-api service which is not enabled by default, but should be used if you primarily configure Caddy via its API instead of config files.

After installing, please read the service usage instructions.

Stable releases:

sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
chmod o+r /usr/share/keyrings/caddy-stable-archive-keyring.gpg
chmod o+r /etc/apt/sources.list.d/caddy-stable.list
sudo apt update
sudo apt install caddy

Testing releases (includes betas and release candidates):

sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/testing/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-testing-archive-keyring.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/testing/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-testing.list
chmod o+r /usr/share/keyrings/caddy-testing-archive-keyring.gpg
chmod o+r /etc/apt/sources.list.d/caddy-testing.list
sudo apt update
sudo apt install caddy

View the Cloudsmith repos

If you wish to use the packaged support files (systemd services, bash completion and default configuration) with a custom Caddy build, instructions can be found here.

Fedora, RedHat, CentOS🔗

This package comes with both of Caddy's systemd service unit files, but does not enable them by default. Using the service is recommended. If you do, please read the service usage instructions.

Fedora:

dnf install dnf5-plugins
dnf copr enable @caddy/caddy
dnf install caddy

CentOS/RHEL:

dnf install dnf-plugins-core
dnf copr enable @caddy/caddy
dnf install caddy

View the Caddy COPR

Arch Linux, Manjaro, Parabola🔗

This package comes with heavily modified versions of both of Caddy's systemd service unit files, but does not enable them by default. Those modifications include a custom start/stop behavior and additional sandboxing flags which are explained in systemd's exec documentation, which may lead to certain host directories not being available to the Caddy process.

pacman -Syu caddy View Caddy in the Arch Linux repositories and the Arch Linux Wiki