Home/Config Files/Caddyfile
Config File Wiki

Caddyfile config guide

Caddy site blocks, automatic HTTPS, reverse proxy, headers, and file server config.

Field explanations

  • Top-level settings define the tool behavior
  • Environment-specific blocks override defaults
  • Paths are usually relative to the config file or project root
  • Secrets should be referenced, not committed

Minimal template

{
  "name": "example",
  "enabled": true
}

Common usage patterns

  • Keep Caddyfile small and reviewable
  • Use comments only when the format supports them
  • Commit example files with placeholder values
  • Validate locally before deploying

Common errors

  • Wrong site address
  • Proxy target unreachable
  • TLS challenge blocked
  • Header directive in wrong block

Online validation

Validate syntax first, then compare behavior against your deploy target. For JSON-based configs, use the JSON formatter before debugging tool-specific behavior.

Related tools