mirror of
https://github.com/caddyserver/website.git
synced 2025-06-22 14:10:32 -04:00
168 lines
5.8 KiB
Markdown
168 lines
5.8 KiB
Markdown
---
|
|
title: "Install"
|
|
---
|
|
|
|
# Install
|
|
|
|
This page describes various methods for installing Caddy on your system.
|
|
|
|
**Official:**
|
|
|
|
- [Static binaries](#static-binaries)
|
|
- [Debian, Ubuntu, Raspbian](#debian-ubuntu-raspbian)
|
|
- [Fedora, RedHat, CentOS](#fedora-redhat-centos)
|
|
- [Arch Linux, Manjaro, Parabola](#arch-linux-manjaro-parabola)
|
|
- [Docker](#docker)
|
|
- [DigitalOcean](#digitalocean)
|
|
|
|
<aside class="tip">
|
|
Our <a href="https://github.com/caddyserver/dist">official packages</a> come only with the standard modules. If you need third-party plugins, <a href="/docs/build#xcaddy">build from source with <code>xcaddy</code></a> or use <a href="/download">our download page</a>.
|
|
</aside>
|
|
|
|
|
|
**Community-maintained:**
|
|
|
|
- [Homebrew](#homebrew)
|
|
- [Webi](#webi)
|
|
- [Chocolatey](#chocolatey)
|
|
- [Ansible](#ansible)
|
|
- [Scoop](#scoop)
|
|
- [Termux](#termux)
|
|
|
|
|
|
## Static binaries
|
|
|
|
Simply downloading a Caddy binary does not [install it as a service](/docs/running#manual-installation), but can be useful in dev or when upgrading an existing installation.
|
|
|
|
- [**View releases on GitHub**](https://github.com/caddyserver/caddy/releases) (expand "Assets")
|
|
- [**Use our download page**](/download)
|
|
|
|
|
|
## Debian, Ubuntu, Raspbian
|
|
|
|
Installing this package automatically starts and runs Caddy as a [systemd service](/docs/running#linux-service) named `caddy`, and also comes with a `caddy-api` service which is _not_ enabled by default, should you need it.
|
|
|
|
Stable releases:
|
|
|
|
<pre><code class="cmd"><span class="bash">sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https</span>
|
|
<span class="bash">curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg</span>
|
|
<span class="bash">curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list</span>
|
|
<span class="bash">sudo apt update</span>
|
|
<span class="bash">sudo apt install caddy</span></code></pre>
|
|
|
|
Testing releases (includes betas and release candidates):
|
|
|
|
<pre><code class="cmd"><span class="bash">sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https</span>
|
|
<span class="bash">curl -1sLf 'https://dl.cloudsmith.io/public/caddy/testing/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-testing-archive-keyring.gpg</span>
|
|
<span class="bash">curl -1sLf 'https://dl.cloudsmith.io/public/caddy/testing/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-testing.list</span>
|
|
<span class="bash">sudo apt update</span>
|
|
<span class="bash">sudo apt install caddy</span></code></pre>
|
|
|
|
[**View the Cloudsmith repos**](https://cloudsmith.io/~caddy/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](https://caddyserver.com/docs/build#package-support-files-for-custom-builds-for-debianubunturaspbian).
|
|
|
|
|
|
## Fedora, RedHat, CentOS
|
|
|
|
This package comes with both of Caddy's [systemd service](/docs/running#linux-service) unit files, but does not enable them by default.
|
|
|
|
Fedora or RHEL/CentOS 8:
|
|
|
|
<pre><code class="cmd"><span class="bash">dnf install 'dnf-command(copr)'</span>
|
|
<span class="bash">dnf copr enable @caddy/caddy</span>
|
|
<span class="bash">dnf install caddy</span></code></pre>
|
|
|
|
RHEL/CentOS 7:
|
|
|
|
<pre><code class="cmd"><span class="bash">yum install yum-plugin-copr</span>
|
|
<span class="bash">yum copr enable @caddy/caddy</span>
|
|
<span class="bash">yum install caddy</span></code></pre>
|
|
|
|
[**View the Caddy COPR**](https://copr.fedorainfracloud.org/coprs/g/caddy/caddy/)
|
|
|
|
|
|
## Arch Linux, Manjaro, Parabola
|
|
|
|
This package comes with both of Caddy's [systemd service](/docs/running#linux-service) unit files, but does not enable them by default.
|
|
|
|
<pre><code class="cmd"><span class="bash">pacman -Syu caddy</span></code></pre>
|
|
|
|
[**View Caddy in the Arch Linux repositories**](https://archlinux.org/packages/community/x86_64/caddy/)
|
|
|
|
|
|
## Docker
|
|
|
|
<pre><code class="cmd bash">docker pull caddy</code></pre>
|
|
|
|
[**View on Docker Hub**](https://hub.docker.com/_/caddy)
|
|
|
|
|
|
## DigitalOcean
|
|
|
|
[**Deploy a Caddy droplet on DigitalOcean**](https://marketplace.digitalocean.com/apps/caddy)
|
|
|
|
The droplet is preconfigured to run Caddy as a [systemd service](/docs/running#linux-service) via being installed with the [`apt` repo](#debian-ubuntu-raspbian).
|
|
|
|
|
|
## Homebrew
|
|
|
|
_Note: This is a community-maintained installation method._
|
|
|
|
<pre><code class="cmd bash">brew install caddy</code></pre>
|
|
|
|
[**View the Homebrew formula**](https://formulae.brew.sh/formula/caddy)
|
|
|
|
|
|
## Webi
|
|
|
|
_Note: This is a community-maintained installation method._
|
|
|
|
Linux and macOS:
|
|
|
|
<pre><code class="cmd bash">curl -sS https://webinstall.dev/caddy | bash</code></pre>
|
|
|
|
Windows:
|
|
|
|
<pre><code class="cmd">curl.exe -A MS https://webinstall.dev/caddy | powershell</code></pre>
|
|
|
|
You may need to adjust the Windows firewall rules to allow non-localhost incoming connections.
|
|
|
|
[**View on Webi**](https://webinstall.dev/caddy)
|
|
|
|
|
|
## Chocolatey
|
|
|
|
_Note: This is a community-maintained installation method._
|
|
|
|
<pre><code class="cmd">choco install caddy</code></pre>
|
|
|
|
[**View the Chocolatey package**](https://chocolatey.org/packages/caddy)
|
|
|
|
|
|
## Ansible
|
|
|
|
_Note: This is a community-maintained installation method._
|
|
|
|
<pre><code class="cmd bash">ansible-galaxy install nvjacobo.caddy</code></pre>
|
|
|
|
[**View the Ansible role repository**](https://github.com/nvjacobo/caddy)
|
|
|
|
|
|
## Scoop
|
|
|
|
_Note: This is a community-maintained installation method._
|
|
|
|
<pre><code class="cmd">scoop install caddy</code></pre>
|
|
|
|
[**View the Scoop manifest**](https://github.com/ScoopInstaller/Main/blob/master/bucket/caddy.json)
|
|
|
|
|
|
## Termux
|
|
|
|
_Note: This is a community-maintained installation method._
|
|
|
|
<pre><code class="cmd">pkg install caddy</code></pre>
|
|
|
|
[**View the Termux build.sh file**](https://github.com/termux/termux-packages/blob/master/packages/caddy/build.sh)
|
|
|