About Caddy
Caddy is a web server and reverse proxy. It obtains and renews TLS certificates for the site names in its configuration. One process can serve static files and proxy to the other applications on this list.
Why it exists
Putting HTTPS in front of every internal app meant renewing certificates by hand. Caddy makes that the default.
Who uses it
People who host the other tools on this list, and anyone serving a site from a small server.
What it is used for
TLS termination, reverse proxy and static files. It is not an application platform by itself.
Open source behind the product
The server is Apache-2.0. You do not buy an edition to turn HTTPS on. Certificates come from a public authority, often Let's Encrypt, under that authority's limits. Commercial support is a separate offer from the project.
How to run it on a server
- Install the binary or the official container on the host that owns ports 80 and 443.
- Point each site name at an upstream, such as Superset, Grafana or a static folder.
- Keep port 80 reachable. Certificate issuance uses it.
- Back up the Caddyfile and the data directory that stores certificates.
Follow the project's own guide for the version you install. Commands and file names change between releases.
How to contribute
The caddyserver/caddy repository takes bug reports and pull requests. Read the contributing guide. A config example belongs in the docs, not only in a comment.
- Read the project's guidelines. Open the repository and look for CONTRIBUTING, the code of conduct and the README.
- Find something to work on. Browse good first issues or all open issues. Documentation and bug reports count.
- Make a small change. Fork the repository, work on a branch, and keep the change focused.
- Open a pull request. Say what changed and why, and link the issue. See open pull requests.
Contributions are accepted under the project's own licence (Apache-2.0). Some projects also ask you to sign a contributor agreement. A doc fix or a reproduced bug is a real contribution.
Licence: Apache-2.0
Permissive. You can use, modify and distribute it, including commercially, keeping the licence and notices. It includes an express patent grant.
This is a plain-English guide, not legal advice. Read the licence in the repository before you ship it or sell a service on top of it.