You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Matthew Holt 1698838685
tls: Few minor improvements/simplifications
5 years ago
.github/workflows ci: Improve build artifact file names (#3168) 5 years ago
caddyconfig httpcaddyfile: Allow php_fastcgi to be used in route directive 5 years ago
caddytest ci: test local CA and update SNI tests (#3145) 5 years ago
cmd tls: Few minor improvements/simplifications 5 years ago
modules tls: Few minor improvements/simplifications 5 years ago
.gitignore Add missing fuzzer (#2844) 5 years ago
.golangci.yml v2: Project-and-CI-wide linter config (#2812) 5 years ago
AUTHORS Add authors file 6 years ago
LICENSE Add license 6 years ago
README.md v2: update CI badge on README (#3162) 5 years ago
admin.go caddyconfig: register adapters as Caddy modules (#3132) 5 years ago
admin_test.go admin: POST /... expands and appends all array elements 5 years ago
caddy.go Merge branch 'certmagic-refactor' into v2 5 years ago
context.go tls/http: Fix auto-HTTPS logic w/rt default issuers (fixes #3164) 5 years ago
context_test.go core: Add godoc examples for LoadModule 5 years ago
go.mod go.mod: Update some deps; add new Strings lib to CEL matcher 5 years ago
go.sum go.mod: Update some deps; add new Strings lib to CEL matcher 5 years ago
listeners.go caddyhttp: Add support for listener wrapper modules 5 years ago
listeners_fuzz.go core: Use port ranges to avoid OOM with bad inputs (#2859) 5 years ago
listeners_test.go Don't append port to unix sockets 5 years ago
logging.go Use JSON format for logs if not interactive terminal 5 years ago
modules.go Refactor for CertMagic v0.10; prepare for PKI app 5 years ago
modules_test.go Couple of minor fixes, update readme 5 years ago
replacer.go v2: Implement 'pki' app powered by Smallstep for localhost certificates (#3125) 5 years ago
replacer_fuzz.go fuzz: introduce continuous fuzzing for Caddy (#2723) 5 years ago
replacer_test.go Fix #3130: Crash at fuzzing target replacer (#3133) 5 years ago
sigtrap.go v2: Logging! (#2831) 5 years ago
sigtrap_nonposix.go Standardize exit codes and improve shutdown handling; update gitignore 6 years ago
sigtrap_posix.go Refactor for CertMagic v0.10; prepare for PKI app 5 years ago
storage.go Refactor for CertMagic v0.10; prepare for PKI app 5 years ago
usagepool.go Minor cleanups 5 years ago

README.md

Caddy 2

This is the development branch for Caddy 2, the web server of the Go community.

Caddy 2 is production-ready, but there may be breaking changes before the stable 2.0 release. Please test it and deploy it as much as you are able, and submit your feedback!


Caddy

Every site on HTTPS

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


@caddyserver on Twitter Caddy Forum Caddy on Sourcegraph

Download · Documentation · Community

Menu

Powered by
CertMagic

Build from source

Requirements:

For development

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

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

With version information and/or plugins

  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. Pin Caddy version: go get github.com/caddyserver/caddy/v2@TAG replacing TAG with a git tag or commit.
  6. Compile: go build

Quick start

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

We recommend that all users 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 the 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

  • We strongly recommend that all professionals or companies using Caddy get a support contract through Ardan Labs before help is needed.

  • Individuals can exchange help for free on our community forum at https://caddy.community. Remember that people give help out of their spare time and good will. The best way to get help is to give it first!

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

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 Light Code Labs, LLC.