* 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)
https://github.com/caddyserver/caddy/pull/3991
The `outputs` bit was getting a bit long so I split it up into multiple paragraphs.
The capture group explanation is copied from the `path_regexp` matcher docs.
Added bullets in front of the example cases, because the newlines get collapsed in markdown otherwise, unless we either add bullets or double newlines. I think bullets work better here.
* docs: Some cleanup, some v2.4.0 additions
- Add `abort` directive docs
- Add a note in `handle` to cross-link to `handle_path`
- Add another example in `handle_errors` that shows how an `expression` matcher can be used to pair with it
- Add a cat emoji to handle_errors because 😸
- Add `file_server` to one of the `php_fastcgi` examples, it's rare that you'll ever use it without `file_server` so might as well include it there
- Add a TOC to `reverse_proxy` cause it's such a long page. Maybe we'll add one to other pages as well, but TBD
- Clarify the upstream address stuff a bit after some discussion in https://caddy.community/t/reverse-proxy-with-multiple-different-upstreams-with-paths/11512/12 and mention `rewrite` as the alternative
- Use the `{re.*.*}` shortcut in the Caddyfile matcher docs, links to the placeholder mapping to let people trace where that comes from
* docs: Revise the `handle` cross-linking, add another example
* docs: Bump minimum Go version to 1.15
* docs: A bunch more additions since v2.3.0
I went through the whole list of commits here: https://github.com/caddyserver/caddy/compare/v2.3.0...ec3ac84
* docs: Review feedback
* docs: Link to https://golang.org/doc/install, better instructions
We now have only 1 download page, yay. Install docs are organized better. Less confusing.
Automatic HTTPS docs improved, and menu added.
Other minor updates to bring up to speed for v2.3.
