Examples to add to the docs

We are planning to add a large repository of examples to the docs.

However, the breadth of use cases is nearly infinite and there are only a few of us maintainers, so we need your help by posting your configs for your use cases here.

Please post your examples here. Doesn't matter how niche; let us decide that. If you think it's useful, or something you wish you had when you were starting, share it!

We are accepting both JSON and Caddyfile configurations. Note that we may revise examples when posting them to our site. Feel free to reply here with your examples to contribute.

Instructions

• Describe the use case (could be a backend app name, a specific config task, an integration, something to do with auto HTTPS/TLS, a clever solution, etc.)
• Include at least the minimal config needed. You may include variations of your example, or additional configuration that may be "recommended," but please annotate them as optional and explain what they do in comments.
• Comments are useful, but some things are obvious and don't need comments.
• Link to any source if you got the example from a web page (e.g. if a third-party app shows how to integrate with Caddy on their docs, please link to that page).

I would love to see 100+ examples posted here from all of you.

Thank you!

Here's an example 😉

WordPress

example.com

root * /var/www/wordpress
php_fastcgi unix//run/php/php-version-fpm.sock
file_server

# block access to sensitive paths (optional, recommended)
@blocked path /xmlrpc.php *.sql /wp-content/uploads/*.php
rewrite @blocked /index.php

# enable compression (optional)
encode gzip

No target file or test is named; start by reading the issue instructions and reviewing the requested example format. A contribution is complete when it describes a use case, includes the minimal JSON or Caddyfile configuration, labels optional variations, and links any external source.