Fast and extensible multi-platform HTTP/1-2-3 web server with automatic HTTPS
Go to file
2016-05-01 16:45:24 -07:00
caddy Merge branch 'master' into md_changes 2016-04-30 13:33:47 -07:00
dist Little bit of housekeeping 2016-04-27 12:52:00 -06:00
middleware Fix headers and unexport plaintext renderer. 2016-05-01 16:45:24 -07:00
server tls: Prevent Go stdlib from overwriting our very first tls ticket key (#785) 2016-04-23 17:49:48 +02:00
.gitattributes Catch whitespace code style violations locally (#774) 2016-04-20 16:56:57 +02:00
.gitignore Bumped version to 0.7.5 2015-08-05 13:26:12 -06:00
.travis.yml Apparently vet ships with Go now 2016-04-06 17:29:53 -06:00
appveyor.yml Apparently vet ships with Go now 2016-04-06 17:29:53 -06:00
build.bash Fix build script with default git repo path (cwd) 2016-04-25 22:10:16 -06:00
CONTRIBUTING.md Little bit of housekeeping 2016-04-27 12:52:00 -06:00
ISSUE_TEMPLATE Little bit of housekeeping 2016-04-27 12:52:00 -06:00
LICENSE.txt License is a text file 2015-08-01 16:07:59 -06:00
main_test.go Implant version information with -ldflags with help of build script 2016-02-26 00:26:31 -07:00
main.go Add -restart=inproc flag for in process restart 2016-03-22 02:25:32 +08:00
README.md updated README to include ZZROT's docker container that runs caddy on Alpine Linux inside of a Docker Container. 2016-04-05 03:11:55 -04:00

Caddy

Dev Chat
Documentation
Linux Build Status
Windows Build Status

Caddy is a lightweight, general-purpose web server for Windows, Mac, Linux, BSD
and Android.
It is a capable alternative to other popular and easy to use web servers.
(@caddyserver on Twitter)

The most notable features are HTTP/2, Let's Encrypt
support, Virtual Hosts, TLS + SNI, and easy configuration with a
Caddyfile. In development, you usually
put one Caddyfile with each site. In production, Caddy serves HTTPS by default
and manages all cryptographic assets for you.

Download ·
User Guide

Menu

Getting Caddy

Caddy binaries have no dependencies and are available for nearly every platform.

Latest release

Quick Start

The website has full documentation but this will
get you started in about 30 seconds:

Place a file named "Caddyfile" with your site. Paste this into it and save:

localhost

gzip
browse
ext .html
websocket /echo cat
log ../access.log
header /api Access-Control-Allow-Origin *

Run caddy from that directory, and it will automatically use that Caddyfile to
configure itself.

That simple file enables compression, allows directory browsing (for folders
without an index file), serves clean URLs, hosts a WebSocket echo server at
/echo, logs requests to access.log, and adds the coveted
Access-Control-Allow-Origin: * header for all responses from some API.

Wow! Caddy can do a lot with just a few lines.

Defining multiple sites

You can run multiple sites from the same Caddyfile, too:

site1.com {
	# ...
}

site2.com, sub.site2.com {
	# ...
}

Note that all these sites will automatically be served over HTTPS using Let's
Encrypt as the CA. Caddy will manage the certificates (including renewals) for
you. You don't even have to think about it.

For more documentation, please view the website.
You may also be interested in the [developer guide]
(https://github.com/mholt/caddy/wiki) on this project's GitHub wiki.

Running from Source

Note: You will need Go 1.6 or newer.

  1. $ go get github.com/mholt/caddy
  2. cd into your website's directory
  3. Run caddy (assumes $GOPATH/bin is in your $PATH)

If you're tinkering, you can also use ./build.bash && ./ecaddy.

By default, Caddy serves the current directory at
localhost:2015. You can place a Caddyfile to configure
Caddy for serving your site.

Caddy accepts some flags from the command line. Run caddy -h to view the help
for flags or see the CLI documentation.

Running as root: We advise against this; use setcap instead, like so:
setcap cap_net_bind_service=+ep ./caddy This will allow you to listen on
ports < 1024 like 80 and 443.

Docker Container

Caddy is available as a Docker container from any of these sources:

3rd-party dependencies

Although Caddy's binaries are completely static, Caddy relies on some excellent
libraries. Godoc.org shows the
packages that each Caddy package imports.

Contributing

Join our dev chat on Gitter to chat with
other Caddy developers! (Dev chat only; try our
support room for help or
general for anything else.)

This project would not be what it is without your help. Please see the
contributing guidelines
if you haven't already.

Thanks for making Caddy -- and the Web -- better!

Special thanks to
DigitalOcean
for hosting the Caddy project.

About the project

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,
nginx, lighttpd,
Websocketd
and Vagrant,
which provides a pleasant mixture of features from each of them.

Twitter: @mholt6