Getting Caddy Quick Start Running from Source Contributing About the Project

mholt / caddy Watch 250 Star 5,536 Fork 358

Code Issues 62 Pull requests 5 Wiki Pulse Graphs

Fast, cross-platform HTTP/2 web server with automatic HTTPS https://caddyserver.com

1,208 commits 4 branches 17 releases 75 contributors

master New pull request New file Find file HTTPS https://github.com/mholt/cadd y .gDitownload ZIP

mholt Merge pull request #760 from Burmudar/hostname-placeholder … Latest commit da016f8 9 hours ago

caddy Better error message. (#768) a day ago

dist Minor changes 16 hours ago

middleware Merge pull request #760 from Burmudar/hostname-placeholder 9 hours ago

server Tell usage of 'path' from 'filepath' and fix *path checking 2 days ago

.gitattributes Revert undesired changes to shell scripts 29 days ago

.gitignore Bumped version to 0.7.5 9 months ago

.travis.yml Apparently vet ships with Go now 12 days ago

CONTRIBUTING.md Update contributing notes a month ago

ISSUE_TEMPLATE Update contributing doc and add issue template a month ago

LICENSE.txt License is a text file 9 months ago

README.md updated README to include ZZROT's docker container that runs caddy on… 14 days ago

appveyor.yml Apparently vet ships with Go now 12 days ago

build.bash Allow git repo as argument to build script 13 days ago

main.go Add -restart=inproc flag for in process restart 29 days ago

main_test.go Implant version information with -ldflags with help of build script 2 months ago

README.md

dev chat gitter godoc reference linux build failing windows build passing

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

Getting Caddy Quick Start Running from Source Contributing About the Project

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 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:

abiosoft/caddy darron/caddy joshix/caddy jumanjiman/caddy zenithar/nano-caddy zzrot/alpine-caddy

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 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