The Caddyfile

The Caddyfile is a convenient Caddy configuration format for humans. It is most people's favorite way to use Caddy because it is easy to write, easy to understand, and expressive enough for most use cases.

It looks like this:

example.com {
	root * /var/www/wordpress
	encode gzip
	php_fastcgi unix//run/php/php-version-fpm.sock
	file_server
}

(That's a real, production-ready Caddyfile that serves WordPress with fully-managed HTTPS.)

The basic idea is that you first type the address of your site, then the features or functionality you need your site to have. View more common patterns.

Menu

• Quick start guide

  A good place to begin getting familiar with the Caddyfile.

• Full Caddyfile tutorial

  Learn to do a variety of common things with the Caddyfile.

• Caddyfile concepts

  Required reading! Structure, site addresses, matchers, placeholders, and more.

• Directives

  Keywords at the beginning of lines that enable features for your sites.

• Request matchers

  Filter requests by using matchers with your directives.

• Global options

  Settings that apply to the whole server rather than individual sites.

• Common patterns

  Simple ways to do common things.

Note

The Caddyfile is just a config adapter for Caddy. It is usually preferred when manually crafting configurations by hand, but is not as expressive, flexible, or programmable as Caddy's native JSON structure. If you are automating your Caddy configurations/deployments, you may wish to use JSON with Caddy's API. (You can actually use the Caddyfile with the API too, just to a limited extent.)