* docs: Add cert getters to tls (tailscale, http)
* Rename "getter" modules to "manager" modules
* Fix ID
* Add note on automatic-https page
* loopback -> local
* Minor tweaks
* Clarify that enabling tailscale is not necessary
* More clarifications
* Add documentation for tracing directive
* Update header in tracing.md
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
* Update documentation in tracing.md
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
* add link to the repository
* add link to gRPC repo and w3c specification
Co-authored-by: Andrii Kushch <>
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
Pairs with https://github.com/caddyserver/caddy/pull/4436.
I could split these changes in two, some changes should only land in 2.5.0, but others are pure documentation that could be pushed live now. But 🤷♂️ I think it's fine for these to wait until 2.5.0, what's another month or whatever? 😅
* docs: Adjustments to global options docs, for clarification
* Apply suggestions from code review
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
* Update reverse_proxy.md
Documantion says: "By default, Caddy passes thru incoming headers [...], with two exceptions:". But technically there is another another header that is added (if not present): `Accept-Encoding`.
When the client is a web browser this header should be already set. But for curl or similar tools, that might not be the case.
* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md
Perfect!
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
- The syntax definition was confusing because it was mixing one-of options and optional arguments which are only relevant for certain options.
- Add notes about replacement capture groups. Wording could probably be improved here. Point is, capture groups are supported, using Golang's syntax (doesn't use Caddy's placeholder syntax, which can be a gotcha)
- Add similar directives section, mainly to point out that `handle_path` can be used instead in many situations to save a line. The note about `rewrite` is kinda redundant with the small paragraph at the top though. Should we move that explanation down into `Similar directives`?
- Change wildcard certs patterns from h3 to h2 header
- Clean up `encode.md` a bit
- Add TOC entry for `handle_response`
- Add response matcher docs for `handle_response` (copied from `encode.md`)
- Add example for `handle_response` for handling by status code
* Added documentation for snippet arguments
Added documentation, the only resource available for this feature, a post on the forum and the PR : https://github.com/caddyserver/caddy/pull/3423
* Update src/docs/markdown/caddyfile/concepts.md
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
* Update src/docs/markdown/caddyfile/concepts.md
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
* Change for more generic example
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
* docs: Warn about the behaviour of `?` in multi-line `header` handlers
* Apply suggestions from code review
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
I somehow forgot to add this to the docs when I implemented it a while back. Someone asked a question on the forums where this was the solution, and I noticed it wasn't documented.
We did recently add a similar example to the `abort` directive docs, but I feel this is a good fit in this page as well since it's a commonly repeated pattern we respond with when answering forum questions.
Docs for the new directive in https://github.com/caddyserver/caddy/pull/4034.
Also adding a bit in `handle_errors` mentioning that `reverse_proxy` doesn't trigger errors when a response has an "error" HTTP status; not sure how to word this clearly, cause `reverse_proxy` still can trigger errors if there's no upstream or whatever. We should probably add examples for that later, and augment this paragraph to mention `handle_response` once that's merged (https://github.com/caddyserver/caddy/pull/4021)
