**Attend the [Caddy launch event](https://www.facebook.com/events/1413078512092363/) on April 20! It's free, and we will try to get a live stream going.**
<a href="https://twitter.com/caddyserver" title="@caddyserver on Twitter"><img src="https://img.shields.io/badge/twitter-@caddyserver-55acee.svg" alt="@caddyserver on Twitter"></a>
<ahref="https://sourcegraph.com/github.com/mholt/caddy?badge"title="Caddy on Sourcegraph"><imgsrc="https://sourcegraph.com/github.com/mholt/caddy/-/badge.svg"alt="Caddy on Sourcegraph"></a>
Caddy is fast, easy to use, and makes you more productive.
Available for Windows, Mac, Linux, BSD, Solaris, and [Android](https://github.com/mholt/caddy/wiki/Running-Caddy-on-Android).
## Menu
-[Features](#features)
-[Install](#install)
-[Quick Start](#quick-start)
-[Running from Source](#running-from-source)
-[Running in Production](#running-in-production)
-[Contributing](#contributing)
-[Donors](#donors)
-[About the Project](#about-the-project)
## Features
-**Easy configuration** with Caddyfile
-**Automatic HTTPS** via [Let's Encrypt](https://letsencrypt.org); Caddy
obtains and manages all cryptographic assets for you
-**HTTP/2** enabled by default (powered by Go standard library)
-**Virtual hosting** for hundreds of sites per server instance, including TLS
SNI
-**Easy configuration** with the Caddyfile
-**Automatic HTTPS** on by default (via [Let's Encrypt](https://letsencrypt.org))
-**HTTP/2** by default
-**Virtual hosting** so multiple sites just work
- Experimental **QUIC support** for those that like speed
- TLS session ticket **key rotation** for more secure connections
-**Brilliant extensibility** so Caddy can be customized for your needs
-**Extensible with plugins** because a convenient web server is a helpful one
-**Runs anywhere** with **no external dependencies** (not even libc)
There's way more, too! [See all features built into Caddy.](https://caddyserver.com/features) On top of all those, Caddy does even more with plugins: choose which plugins you want at [download](https://caddyserver.com/download).
## Quick Start
## Install
Caddy binaries have no dependencies and are available for every platform.
Install Caddy any one of these ways:
Caddy binaries have no dependencies and are available for every platform. Get Caddy any one of these ways:
-**[Download page](https://caddyserver.com/download)** allows you to
customize your build in the browser
-**[Latest release](https://github.com/mholt/caddy/releases/latest)** for
pre-built binaries
-**curl [getcaddy.com](https://getcaddy.com)** for auto install:
`curl https://getcaddy.com | bash`
pre-built, vanilla binaries
-**go get** to build from source: `go get github.com/mholt/caddy/caddy` (requires Go 1.8 or newer)
Then make sure the `caddy` binary is in your PATH.
## Quick Start
To serve static files from the current working directory, run:
```
caddy
```
Once `caddy` is in your PATH, you can `cd` to your website's folder and run
`caddy` to serve it. By default, Caddy serves the current directory at
[localhost:2015](http://localhost:2015).
Caddy's default port is 2015, so open your browser to [http://localhost:2015](http://localhost:2015).
To customize how your site is served, create a file named Caddyfile by your
site and paste this into it:
### Go from 0 to HTTPS in 5 seconds
If the `caddy` binary has permission to bind to low ports and your domain name's DNS records point to the machine you're on:
```
caddy -host example.com
```
This command serves static files from the current directory over HTTPS. Certificates are automatically obtained and renewed for you!
### Customizing your site
To customize how your site is served, create a file named Caddyfile by your site and paste this into it:
```plain
localhost
gzip
push
browse
websocket /echo cat
ext .html
...
...
@@ -76,93 +98,59 @@ proxy /api 127.0.0.1:7005
header /api Access-Control-Allow-Origin *
```
When you run `caddy` in that directory, it will automatically find and use
that Caddyfile to configure itself.
When you run `caddy` in that directory, it will automatically find and use that Caddyfile.
This simple file enables compression, allows directory browsing (for folders
without an index file), hosts a WebSocket echo server at /echo, serves clean
URLs, logs requests to access.log, proxies all API requests to a backend on
port 7005, and adds the coveted `Access-Control-Allow-Origin: *` header for
all responses from the API.
This simple file enables server push (via Link headers), allows directory browsing (for folders without an index file), hosts a WebSocket echo server at /echo, serves clean URLs, logs requests to an access log, proxies all API requests to a backend on port 7005, and adds the coveted `Access-Control-Allow-Origin: *` header for all responses from the API.
Wow! Caddy can do a lot with just a few lines.
To host multiple sites and do more with the Caddyfile, please see the
contributed by the community that you may find helpful for running Caddy in
production.
Caddy is production-ready if you find it to be a good fit for your site and workflow.
How you choose to run Caddy is up to you. Many users are satisfied with
`nohup caddy &`. Others use `screen`. Users who need Caddy to come back up
after reboots either do so in the script that caused the reboot, add a command
to an init script, or configure a service with their OS.
**Running as root:** We advise against this. You can still listen on ports < 1024 on Linux using setcap like so: `sudo setcap cap_net_bind_service=+ep ./caddy`
The Caddy project does not officially maintain any system-specific integrations nor suggest how to administer your own system. But your download file includes [unofficial resources](https://github.com/mholt/caddy/tree/master/dist/init) contributed by the community that you may find helpful for running Caddy in production.
How you choose to run Caddy is up to you. Many users are satisfied with `nohup caddy &`. Others use `screen`. Users who need Caddy to come back up after reboots either do so in the script that caused the reboot, add a command to an init script, or configure a service with their OS.
## Contributing
**[Join our community](https://forum.caddyserver.com) where you can chat with
other Caddy users and developers!**
**[Join our forum](https://forum.caddyserver.com) where you can chat with other Caddy users and developers!**
Please see our [contributing guidelines](https://github.com/mholt/caddy/blob/master/CONTRIBUTING.md)
and check out the [developer wiki](https://github.com/mholt/caddy/wiki).
Please see our [contributing guidelines](https://github.com/mholt/caddy/blob/master/CONTRIBUTING.md). If you want to write a plugin, check out the [developer wiki](https://github.com/mholt/caddy/wiki).
We use GitHub issues and pull requests only for discussing bug reports and
the development of specific changes. We welcome all other topics on the
[forum](https://forum.caddyserver.com)!
We use GitHub issues and pull requests only for discussing bug reports and the development of specific changes. We welcome all other topics on the [forum](https://forum.caddyserver.com)!
If you want to contribute to the documentation, please submit pull requests to [caddyserver/caddyserver.com](https://github.com/caddyserver/caddyserver.com).
If you want to contribute to the documentation, please submit pull requests to [caddyserver/website](https://github.com/caddyserver/website).
which provides a pleasant mixture of features from each of them.
**The name "Caddy":** 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". See [brand guidelines](https://caddyserver.com/brand).
Caddy was born out of the need for a "batteries-included" web server that runs anywhere and doesn't have to take its configuration with it. Caddy took inspiration from [spark](https://github.com/rif/spark), [nginx](https://github.com/nginx/nginx), lighttpd,
[Websocketd](https://github.com/joewalnes/websocketd) and [Vagrant](https://www.vagrantup.com/), which provides a pleasant mixture of features from each of them.
**The name "Caddy":** 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". See [brand guidelines](https://caddyserver.com/brand).
*Author on Twitter: [@mholt6](https://twitter.com/mholt6)*
