caddy README

The project's README from github.com/caddyserver/caddy. As one markdown file: README.md.

Caddy

a project

Every site on HTTPS

Caddy is an extensible server platform that uses TLS by default.

Releases · Documentation · Get Help

      @caddyserver on Twitter   Caddy Forum
Caddy on Sourcegraph   Cloudsmith

Powered by
CertMagic

Special thanks to:
Warp sponsorship

Warp, built for coding with multiple AI agents

Available for MacOS, Linux, & Windows

Menu

Features

Install

The simplest, cross-platform way to get started is to download Caddy from GitHub Releases and place the executable file in your PATH.

See our online documentation for other install instructions.

Build from source

Requirements:

For development

Note: These steps will not embed proper version information. For that, please follow the instructions in the next section.

$ git clone "https://github.com/caddyserver/caddy.git"
$ cd caddy/cmd/caddy/
$ go build

When you run Caddy, it may try to bind to low ports unless otherwise specified in your config. If your OS requires elevated privileges for this, you will need to give your new binary permission to do so. On Linux, this can be done easily with: sudo setcap cap_net_bind_service=+ep ./caddy

If you prefer to use go run which only creates temporary binaries, you can still do this with the included setcap.sh like so:

$ go run -exec ./setcap.sh main.go

If you don't want to type your password for setcap, use sudo visudo to edit your sudoers file and allow your user account to run that command without a password, for example:

username ALL=(ALL:ALL) NOPASSWD: /usr/sbin/setcap

replacing username with your actual username. Please be careful and only do this if you know what you are doing! We are only qualified to document how to use Caddy, not Go tooling or your computer, and we are providing these instructions for convenience only; please learn how to use your own computer at your own risk and make any needful adjustments.

Then you can run the tests in all modules or a specific one:

$ go test ./...
$ go test ./modules/caddyhttp/tracing/

With version information and/or plugins

Using our builder tool, xcaddy...

$ xcaddy build

...the following steps are automated:

  1. Create a new folder: mkdir caddy
  2. Change into it: cd caddy
  3. Copy Caddy's main.go into the empty folder. Add imports for any custom plugins you want to add.
  4. Initialize a Go module: go mod init caddy
  5. (Optional) Pin Caddy version: go get github.com/caddyserver/caddy/v2@version replacing version with a git tag, commit, or branch name.
  6. (Optional) Add plugins by adding their import: _ "import/path/here"
  7. Compile: go build -tags=nobadger,nomysql,nopgx

Quick start

The Caddy website has documentation that includes tutorials, quick-start guides, reference, and more.

We recommend that all users -- regardless of experience level -- do our Getting Started guide to become familiar with using Caddy.

If you've only got a minute, the website has several quick-start tutorials to choose from! However, after finishing a quick-start tutorial, please read more documentation to understand how the software works. 🙂

Overview

Caddy is most often used as an HTTPS server, but it is suitable for any long-running Go program. First and foremost, it is a platform to run Go applications. Caddy "apps" are just Go programs that are implemented as Caddy modules. Two apps -- tls and http -- ship standard with Caddy.

Caddy apps instantly benefit from automated documentation, graceful on-line config changes via API, and unification with other Caddy apps.

Although JSON is Caddy's native config language, Caddy can accept input from config adapters which can essentially convert any config format of your choice into JSON: Caddyfile, JSON 5, YAML, TOML, NGINX config, and more.

The primary way to configure Caddy is through its API, but if you prefer config files, the command-line interface supports those too.

Caddy exposes an unprecedented level of control compared to any web server in existence. In Caddy, you are usually setting the actual values of the initialized types in memory that power everything from your HTTP handlers and TLS handshakes to your storage medium. Caddy is also ridiculously extensible, with a powerful plugin system that makes vast improvements over other web servers.

To wield the power of this design, you need to know how the config document is structured. Please see our documentation site for details about Caddy's config structure.

Nearly all of Caddy's configuration is contained in a single config document, rather than being scattered across CLI flags and env variables and a configuration file as with other web servers. This makes managing your server config more straightforward and reduces hidden variables/factors.

Full documentation

Our website has complete documentation:

https://caddyserver.com/docs/

The docs are also open source. You can contribute to them here: https://github.com/caddyserver/website

Getting help

Please use our issue tracker only for bug reports and feature requests, i.e. actionable development items (support questions will usually be referred to the forums).

About

Matthew Holt began developing Caddy in 2014 while studying computer science at Brigham Young University. (The name "Caddy" was chosen because this software helps with the tedious, mundane tasks of serving the Web, and is also a single place for multiple things to be organized together.) It soon became the first web server to use HTTPS automatically and by default, and now has hundreds of contributors and has served trillions of HTTPS requests.

The name "Caddy" is trademarked. The name of the software is "Caddy", not "Caddy Server" or "CaddyServer". Please call it "Caddy" or, if you wish to clarify, "the Caddy web server". Caddy is a registered trademark of Stack Holdings GmbH.

Caddy is a project of ZeroSSL, an HID Global company.

Debian package repository hosting is graciously provided by Cloudsmith. Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that enables your organization to create, store and share packages in any format, to any place, with total confidence.

caddy (caddyserver/caddy)

Searching Database…

78.1K ·GitHub
Caddy
Что это такое?Caddy — это быстрый расширяемый веб-сервер на Go, который по умолчанию автоматически включает HTTPS. Он может работать как HTTP/1-2-3 сервер, обратный прокси и общая платформа для запуска «приложений» (модулей) на Go.
Это библиотека, которую я подключаю в код, или отдельный сервер, который я запускаю?Это отдельный бинарный файл сервера, который запускается напрямую. Это также платформа для программ на Go, реализованных как модули Caddy, которые настраиваются через нативный JSON API или более простой формат Caddyfile.
Как его запустить?Скачайте исполняемый файл Caddy со страницы GitHub Releases, поместите его в PATH и запустите. Также можно собрать его из исходников с Go 1.25.0+ или добавить плагины с помощью инструмента сборки xcaddy.
Нужен ли мне Go для использования Caddy или он нужен только для сборки?Go (версии 1.25.0 или новее) нужен только если вы собираете из исходников или добавляете свои плагины через xcaddy. Готовые бинарные файлы работают без внешних зависимостей, даже без libc.
Есть ли подводные камни при установке, о которых стоит знать?В Linux Caddy может потребовать повышенных привилегий для привязки к низким портам (например, 80/443). Это можно выдать с помощью setcap вместо запуска от имени root.
Для кого это и насколько хорошо это масштабируется?Caddy подходит как энтузиастам, так и крупным промышленным развёртываниям. Известно, что он масштабируется до сотен тысяч сайтов и обработал триллионы запросов в продакшене.
Отправляет ли автоматический HTTPS в Caddy мои данные куда-либо?Для публичных доменных имён он использует ZeroSSL и Let's Encrypt (публичные центры сертификации) для автоматического выпуска сертификатов. Для внутренних имён и IP-адресов он вместо этого работает со своим полностью управляемым локальным CA.
Чем отличаются Caddyfile и конфигурация в JSON?JSON — это нативный язык конфигурации Caddy, дающий полный контроль над каждой настройкой. Caddyfile — это более простой, удобный для человека адаптер конфигурации, который преобразуется в JSON. Другие адаптеры поддерживают YAML, TOML, JSON5 и даже синтаксис конфигурации NGINX.
Можно ли изменить конфигурацию Caddy без перезапуска?Да, основной способ настройки Caddy — живой JSON API, поэтому можно отправлять изменения конфигурации работающему экземпляру на лету.
Почему Caddy считается более устойчивым, чем другие веб-серверы?Он написан на Go, который даёт более надёжные гарантии безопасности работы с памятью, чем серверы на C. Кроме того, он спроектирован так, чтобы оставаться в сети даже тогда, когда проблемы с TLS, OCSP или сертификатами обычно вывели бы другие серверы из строя.
Как добавить плагины в Caddy?Используйте инструмент сборки xcaddy, который автоматизирует создание модуля Go, подключение выбранных плагинов и компиляцию собственного бинарного файла Caddy с ними.
What are similar projects?nginx, tengine, chisel, nps, h2o, nginx-proxy, frankenphp, goproxy
Which topics is it in?acme, caddy, http3, http-server, https, web-server, reverse-proxy, tls, http, golang, proxy, networking
Creator
caddyserver
Size
20.6 MB
Stars
78.1K
Updated
CommitOct 17Releasev2.11.7Oct 03
Age
11y
Commits · 90 Days