Commit graph

160 commits

Author SHA1 Message Date
Jack Bailey
ed0ea7c6ff
Fix link to global trusted proxies page (#309) 2023-03-17 20:33:05 -04:00
Matt Holt
cae970833f
reverseproxy: Update buffering docs (#301)
Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2023-02-16 11:28:41 -05:00
Francis Lavoie
b58f576478
log: Clarify header examples for sensitive headers 2023-02-16 04:14:39 -05:00
Francis Lavoie
7c99a9ab17
Docs for v2.6.3 (#296) 2023-02-08 17:10:09 -05:00
rusty-snake
0956f710c1
typo: Fix double not in tls directive (#295) 2023-02-05 16:08:31 -05:00
Moritz Poldrack
91e80a9d18
Add additional references to the directive order (#294) 2023-01-27 23:16:21 -05:00
Francis Lavoie
90d9425f23
PHP 7.4 is no longer supported, bump example to latest version 2023-01-21 21:44:40 -05:00
Francis Lavoie
755413601d
reverse_proxy: Elaborate on upstream defaults, scheme defaults (#288)
* reverse_proxy: Elaborate on upstream defaults, scheme defaults

* Additional adjustments to hopefully make upstreams as clear as possible
2023-01-19 12:41:48 -05:00
Kyle McCullough
a2742d8d8d
pki: document certificate lifetime options (#283)
Signed-off-by: Kyle McCullough <kylemcc@gmail.com>

Signed-off-by: Kyle McCullough <kylemcc@gmail.com>
2022-12-06 18:53:42 -07:00
Francesco
fec22eb15d
Fix reverseproxy http transport dial_timeout default value (#280) 2022-11-17 18:44:28 -05:00
Wooseop Kim
89c547708b docs: fix typo 2022-10-23 01:24:30 +09:00
Francis Lavoie
0d05c7bf19
docs: v2.6.2 changes 2022-10-17 13:53:08 -04:00
Tobias Gruetzmacher
5282fbd6ff
Add another handle_errors example (#273) 2022-10-17 11:24:39 -06:00
Francis Lavoie
af47d0574b
docs: Various updates since 2.5.2 that got missed (#274)
* docs: Various updates since 2.5.2 that got missed

* Cleanup protocols global options

* Sort caddyfile placeholder shortcuts alphabetically for now
2022-10-17 11:23:48 -06:00
Eddie Lebow
cec799bd2f
root: Fix typo and change word (#272) 2022-09-30 00:14:24 -06:00
Malloc Voidstar
2541c63775
log: ip_mask works on bits, not bytes (#270) 2022-09-22 11:43:36 -04:00
Matthew Holt
685dfc83c1
docs: Update info about metrics for 2.6
Also add events.handlers namespace and fix dhall link.
2022-09-20 13:27:27 -06:00
Alex Bradbury
a87295bf0b
docs: Clarify how handle directives may be re-ordered (#264)
As discussed in <https://github.com/caddyserver/caddy/issues/5037>.
2022-09-13 22:06:00 -06:00
Matthew Holt
2ab3061111
Update docs for 2.6 2022-09-06 13:57:07 -06:00
Matthew Holt
c67668615e
map: Fix example typo (close #258) 2022-09-05 16:42:48 -06:00
Matthew Holt
be47c4989f reverseproxy: Clarify flush behavior (fix #261) 2022-09-05 13:31:47 -06:00
Matthew Holt
8f8a09fcad
reverse_proxy: Clarify streaming/buffering 2022-08-29 10:15:26 -06:00
Dan Farino
dd191b380f
remove extra word (#252) 2022-08-16 21:58:40 -04:00
Matthew Holt
499644a8a3
caddyfile: Update rewrite and path matcher docs
Regarding URI encoding and path cleaning
2022-08-12 16:40:17 -06:00
Francis Lavoie
68a8219fa4
tls: Clarify internal shortcut limitations (#251) 2022-08-09 22:08:12 -06:00
Matthew Holt
cddded78a7
file_server: Add docs for virtual file system support. 2022-07-31 21:39:58 -06:00
Matthew Holt
e14f50d148
Improve docs for file_server and add caddy.fs namespace 2022-07-24 22:29:33 -06:00
Matthew Holt
bb37b39a0e
request_header: Link to proxy header manipulation
For some header fields, it matters that the header manipulation is aware
of the proxying context, for example with hop-by-hop headers.
2022-07-19 12:18:09 -06:00
Francis Lavoie
0f35ad14b1
forward_auth: Typo fix, minor clarification callout 2022-07-14 00:25:47 -04:00
Matt Holt
7819a84e59
2.5.2 docs (#247)
* docs: Changes for v2.5.2 release

* docs: Remove -X POST

Curl automatically uses POST for -d and --data-binary.

I intentionally left it in to be explicit to learners, but
maybe best practices are better.

* api: /adapt endpoint and Etag usage

* api: Minor tweaks

* Alright fine

* Clarify Etag usage

* CEL embedded matchers

* Oops

* Lots more adjustments

Co-authored-by: Francis Lavoie <lavofr@gmail.com>
2022-07-12 12:52:18 -06:00
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
Patrycja
2335afaee0
docs: Correct IPv6 syntax in bind directive (#227) 2022-04-25 21:58:27 -04:00
Francis Lavoie
eaf0aae816
docs: More changes for upcoming v2.5.0 release (#226) 2022-04-25 10:51:42 -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
Bruce Johnson
60323a9e83
file_server: clarify precompressed (#224) 2022-04-01 20:36:24 -04:00
Matt Holt
d0317c0a1c
tls: get_certificates & manager modules (tailscale, http) (#207)
* 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
2022-03-17 11:59:08 -06:00
IndeedNotJames
8e6482173f
docs: fix dns_challenge_override_domain typo (#218) 2022-03-14 03:08:45 -04: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
Andrii Kushch
c734cc3e64
caddyfile: tracing directive (#205)
* 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>
2022-03-09 10:42:06 -07:00
Francis Lavoie
daafd77ef1
Fix incorrect option name in load balancing 2022-03-07 12:39:19 -05:00
pyfisch
3f97d611b4
Correct inconsistency in ip masking example (#209) 2022-02-03 08:36:51 -05:00
Luo Peng
b01f645d7d
docs: Fix a broken markdown link (#204) 2022-01-17 19:33:13 -07:00
Simon Legner
a9a2bd3ae4
reverse_proxy: document how to strip a path prefix (#203) 2022-01-08 12:43:39 -05:00
Francis Lavoie
d57f7319bb
docs: Fix broken markdown link in route directive 2021-12-09 15:43:04 -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
Francis Lavoie
28e13597de
docs: Elaborate on how the php_fastcgi directive works (#197)
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2021-11-22 15:33:50 -05:00
Jeremy Lin
b4f2b47adc
docs: Update location of default browse template (#196)
Ref: caddyserver/caddy#4417
2021-11-22 12:33:10 -07:00
Francis Lavoie
e253d8efc9
docs: Adjustments for v2.4.6 2021-11-08 20:39:44 -05:00