Commit graph

40 commits

Author SHA1 Message Date
Francis Lavoie
655786d85e
docs: Some random polish (#241)
* docs: Some random polish

Just a bunch of little things that I think would help users from frequently asked forum questions.

* Adjustments, fix `tls_server_name` docs

* Update src/docs/markdown/caddyfile/concepts.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2022-06-06 12:36:50 -06:00
otbutz
8f61c3c71f
reverse_proxy: Document header policy fallback (#237)
* reverse_proxy: Document header policy fallback

* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2022-06-01 16:04:13 -06:00
Francis Lavoie
f6ac9b025e
docs: Changes for v2.5.1 release (#228)
* docs: Changes for v2.5.1 release

* Remove path from addresses doc

* Fix www redirect pattern
2022-05-17 12:32:11 -06:00
Francis Lavoie
0aa19eef44
Elaborate on log formats, proxy headers and examples (#225)
* Elaborate on log formats, proxy headers and examples

* Document HTTP transport resolvers
2022-04-07 11:43:39 -06:00
Francis Lavoie
a1ddadf798
Docs for upcoming v2.5.0 release (#216)
* docs: new `log` filters in Caddyfile

* docs: `renew_interval` global option

* docs: Update access log example

* docs: `log_credentials` global option

* docs: `vars`, `vars_regexp` matchers

* docs: `roll_uncompressed`, `roll_local_time`

* docs: `http_redirect` listener wrapper

* docs: `pki` app

* docs: `strict_sni_host` options

* docs: `default_bind` option

* docs: `method` directive

* docs: `tls internal` subdirectives

* Apply suggestions from code review

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

* Matchers, options, file_server, reverse_proxy

* More clarifications / corrections

* Corrections from review

* Typo fix

* One more note about dynamic upstreams

* Tab -> space

* Update module namespaces

* Update some docs about logging

* `copy_response`, `copy_response_headers`, `replace_status`

* `dns_challenge_domain_override`

* `caddy trust`, API endpoints

* `trusted_proxies`

* Note about `pass_thru` being only useful inside `route`

* Improve logging docs to clarify the difference

* A bit of polish on patterns

* request_body: Clarify error behavior

* review

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2022-03-11 14:26:00 -07:00
Francis Lavoie
daafd77ef1
Fix incorrect option name in load balancing 2022-03-07 12:39:19 -05:00
Simon Legner
a9a2bd3ae4
reverse_proxy: document how to strip a path prefix (#203) 2022-01-08 12:43:39 -05:00
Francis Lavoie
ca9b5b0d46
docs: Mention the timeout/buffer defaults for the proxy transports (#199)
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? 😅
2021-12-02 14:07:39 -07:00
Paulo Vieira
578394fc5f
docs: Mention compression header behaviour in reverse_proxy (#193)
* 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>
2021-09-13 18:35:13 -06:00
Francis Lavoie
c5e3aef0a2
docs: Dynamically turn subdirectives into links to anchors (#190)
* docs: Dynamically turn subdirectives into links to anchors

* Make entire rows clickable on directive page's table
2021-08-31 12:50:01 -06:00
Francis Lavoie
3dac36ebc8
docs: Updates for Caddy v2.4.4 (#189)
* docs: Updates for Caddy v2.4.4

* Adjust wording

* Clarify HTTPS proxy usage, reorder lb policies for clarity

* Reorder directives, add comments
2021-08-31 11:39:15 -06:00
Jon Cram
60bc4ee7c3
docs: reverse_proxy typo "tranport" -> "transport" (#182)
The reverse_proxy directive docs contained a TOC featuring the line "The fastcgi tranport". Changed "tranport" to "transport".
2021-07-07 10:20:59 -04:00
Matthew Holt
85dbc186c2
docs: Minor updates to file_server and reverse_proxy 2021-06-17 14:12:56 -06:00
Matthew Holt
09c3a73299
docs: dial_timeout for log net writer
And minor fix for reverse proxy example
2021-05-25 17:26:54 -06:00
Mohammed Al Sahaf
2827d46774
Fix example of rewrite in handle_response (#166) 2021-05-14 07:52:53 -04:00
Francis Lavoie
e30f3f8330
docs: Fixup handle_response for fixes landing in 2.4.1 (#165) 2021-05-13 11:11:10 -06:00
Francis Lavoie
9b4599eec9
docs: A few fixes, one more example (#164)
- 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
2021-05-12 13:21:32 -06:00
Matthew Holt
10f700ad19
docs: A few more updates for v2.4.0 2021-05-10 13:43:20 -06:00
Francis Lavoie
c1383e7981
docs: status option for file_server, health_uri for reverse_proxy (#156) 2021-05-02 12:19:48 -06:00
Francis Lavoie
3f3e0fb9f8
docs: Some cleanup, some v2.4.0 additions (#139)
* 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
2021-02-22 13:11:21 -07:00
Francis Lavoie
a05f559c12
docs: Update reverse_proxy examples (#119)
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2020-12-02 13:38:23 -05:00
Francis Lavoie
bc64f3acc0
docs: Add missing proxy and fastcgi options (#108)
* docs: Add missing proxy and fastcgi options

* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2020-11-24 15:19:46 -07:00
Francis Lavoie
5bfa8266d4
docs: Add cookie hash policy for proxy (#110)
* docs: Add cookie hash policy for proxy

* Update src/docs/markdown/caddyfile/directives/reverse_proxy.md

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2020-11-24 14:27:23 -07:00
Francis Lavoie
64664222fa
docs: Add h2c scheme shortcut to Caddyfile proxy docs (#111) 2020-11-24 14:20:05 -07:00
Francis Lavoie
828e4a4eb4
docs: Add new proxy transport options, fix buffer_requests location (#103) 2020-11-02 16:06:20 -07:00
Matthew Holt
af3676862b
docs: Update for v2.2 2020-09-25 12:53:11 -06:00
Matthew Holt
7da129a23a
docs: Add reverse_proxy compression subdirective 2020-08-31 18:39:56 -06:00
Francis Lavoie
8e777706f9
docs: Add headers to reverse_proxy docs for anchor linking (#77) 2020-08-17 14:12:20 -06:00
Daniel Santos
b68b16f044
docs: reverse_proxy: Fix srv address syntax (#56) 2020-06-11 11:33:11 -06:00
Matthew Holt
db18a5d4c8
docs: Numerous various updates for v2.1 2020-06-08 14:56:20 -06:00
Francis Lavoie
1367aebe20
docs: Add a few code lang labels, minor cleanup 2020-06-01 21:52:14 -04:00
Matthew Holt
fa3b5f6699
docs: Update a variety of docs for upcoming 2.1 betas 2020-06-01 21:52:14 -04:00
Francis Lavoie
e0f5ee1bb9
docs: Add Caddyfile syntax highlighting (#41) 2020-05-17 14:32:12 -06:00
Matthew Holt
e52e32ba7d
Update site for 2.0; add v2 landing page with asciinema video; docs 2020-05-04 19:39:11 -06:00
Matthew Holt
86df96a069
docs: A few minor updates / clarifications 2020-04-22 16:31:30 -06:00
Francis Lavoie
9d18f10f62
docs: Remove NTLM transport from the docs (#24)
* docs: Note that NTLM is now a separate module

* Update reverse_proxy.md
2020-04-09 17:54:36 -06:00
Matthew Holt
836e15afbc
docs: Minor tweaks, clarifications. 2020-04-01 11:09:26 -06:00
Matthew Holt
aea9c986d1
docs: Update for beta 15 2020-02-28 11:16:45 -07:00
Matthew Holt
2abf8549a7
docs: Update root, reverse_proxy, and shorthand placeholders 2020-02-04 13:33:48 -07:00
Matthew Holt
03b6fddeb0
Initial commit 2020-01-24 12:47:52 -07:00