README
¶
Caddy is a lightweight, general-purpose web server for Windows, Mac, Linux, BSD, and Android. It is a capable alternative to other popular web servers.
The most notable features are HTTP/2, Virtual Hosts, TLS + SNI, and easy configuration with a Caddyfile. Usually, you have one Caddyfile per site. Most directives for the Caddyfile invoke a layer of middleware which can be used in your own Go programs.
Menu
Getting Caddy
Caddy binaries have no dependencies and are available for nearly every platform.
Running from Source
$ go get github.com/mholt/caddycdinto your website's directory- Run
caddy(assumes$GOPATH/binis in your$PATH)
If you're tinkering, you can also use go run main.go.
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.
3rd-party libraries
Although Caddy's binaries are completely static, Caddy relies on some excellent libraries that really make the project possible.
- bradfitz/http2 for HTTP/2 support
- russross/blackfriday for Markdown rendering
- dustin/go-humanize for pleasant times and sizes
- flynn/go-shlex to parse shell commands properly
This list may not be comprehensive, but godoc.org will list all packages that any given package imports.
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 an echo server for WebSocket connections at /echo, logs accesses 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:
http://mysite.com,
http://www.mysite.com {
redir https://mysite.com
}
https://mysite.com {
tls mysite.crt mysite.key
# ...
}
Note that the secure host will automatically be served with HTTP/2 if the client supports it.
For more documentation, please view the website. You may also be interested in the developer guide on this project's GitHub wiki.
Contributing
This project gladly accepts contributions. Interested users are encouraged to get involved by opening issues with their ideas, questions, and bug reports. Bug reports should contain clear instructions to reproduce the problem and state expected behavior.
For small tweaks and bug fixes, feel free to submit pull requests at any time. For new features or to change existing behavior, please open an issue first to discuss it and claim it. This prevents overlapping efforts and also keeps the project in-line with its goals.
Thanks for making Caddy -- and the Web -- better!
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 nginx, lighttpd, Websocketd, and Vagrant, and provides a pleasant mixture of features from each of them.
Twitter: @mholt6
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config contains utilities and types necessary for launching specially-configured server instances.
|
Package config contains utilities and types necessary for launching specially-configured server instances. |
|
Package middleware provides some types and functions common among middleware.
|
Package middleware provides some types and functions common among middleware. |
|
basicauth
Package basicauth implements HTTP Basic Authentication.
|
Package basicauth implements HTTP Basic Authentication. |
|
browse
Package browse provides middleware for listing files in a directory when directory path is requested instead of a specific file.
|
Package browse provides middleware for listing files in a directory when directory path is requested instead of a specific file. |
|
errors
Package errors implements an HTTP error handling middleware.
|
Package errors implements an HTTP error handling middleware. |
|
extensions
Package extension is middleware for clean URLs.
|
Package extension is middleware for clean URLs. |
|
fastcgi
Package fastcgi has middleware that acts as a FastCGI client.
|
Package fastcgi has middleware that acts as a FastCGI client. |
|
gzip
Package gzip provides a simple middleware layer that performs gzip compression on the response.
|
Package gzip provides a simple middleware layer that performs gzip compression on the response. |
|
headers
Package headers provides middleware that appends headers to requests based on a set of configuration rules that define which routes receive which headers.
|
Package headers provides middleware that appends headers to requests based on a set of configuration rules that define which routes receive which headers. |
|
log
Package log implements basic but useful request (access) logging middleware.
|
Package log implements basic but useful request (access) logging middleware. |
|
markdown
Package markdown is middleware to render markdown files as HTML on-the-fly.
|
Package markdown is middleware to render markdown files as HTML on-the-fly. |
|
proxy
Package proxy is middleware that proxies requests.
|
Package proxy is middleware that proxies requests. |
|
redirect
Package redirect is middleware for redirecting certain requests to other locations.
|
Package redirect is middleware for redirecting certain requests to other locations. |
|
rewrite
Package rewrite is middleware for rewriting requests internally to a different path.
|
Package rewrite is middleware for rewriting requests internally to a different path. |
|
templates
Package templates implements template execution for files to be dynamically rendered for the client.
|
Package templates implements template execution for files to be dynamically rendered for the client. |
|
websockets
Package websockets implements a WebSocket server by executing a command and piping its input and output through the WebSocket connection.
|
Package websockets implements a WebSocket server by executing a command and piping its input and output through the WebSocket connection. |
|
Package server implements a configurable, general-purpose web server.
|
Package server implements a configurable, general-purpose web server. |