|Matthew Holt 97caf368ee||1 day ago|
|.github||2 weeks ago|
|caddyconfig||2 weeks ago|
|caddytest||1 week ago|
|cmd||1 month ago|
|modules||1 week ago|
|.gitignore||4 months ago|
|.golangci.yml||6 months ago|
|.goreleaser.yml||3 months ago|
|AUTHORS||1 year ago|
|LICENSE||1 year ago|
|README.md||1 day ago|
|admin.go||3 weeks ago|
|admin_test.go||10 months ago|
|caddy.go||2 months ago|
|caddy_test.go||5 months ago|
|context.go||5 months ago|
|context_test.go||10 months ago|
|go.mod||1 month ago|
|go.sum||1 month ago|
|listeners.go||6 months ago|
|listeners_fuzz.go||6 months ago|
|listeners_test.go||6 months ago|
|logging.go||6 months ago|
|metrics.go||3 weeks ago|
|modules.go||6 months ago|
|modules_test.go||9 months ago|
|replacer.go||3 months ago|
|replacer_fuzz.go||6 months ago|
|replacer_test.go||6 months ago|
|sigtrap.go||4 months ago|
|sigtrap_nonposix.go||1 year ago|
|sigtrap_posix.go||7 months ago|
|storage.go||6 months ago|
|usagepool.go||11 months ago|
Caddy is an extensible server platform that uses TLS by default.
You can install Caddy by downloading from the Github Releases and placing it in your PATH.
For other install options, see https://caddyserver.com/docs/download.
$ git clone "https://github.com/caddyserver/caddy.git" $ cd caddy/cmd/caddy/ $ go build
Note: These steps will not embed proper version information. For that, please follow the instructions below.
Using our builder tool,
$ xcaddy build
...the following steps are automated:
go mod init caddy
go get github.com/caddyserver/caddy/v2@versionreplacing
versionwith a git tag or commit.
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. 🙂
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 --
http -- ship standard with Caddy.
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.
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.
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.
Our website has complete documentation:
The docs are also open source. You can contribute to them here: https://github.com/caddyserver/website
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).
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 apilayer GmbH.