Commit graph

203 commits

Author SHA1 Message Date
Daniel Abromeit aka Abro
e24691fe37
docs: Fix two little typos (header, metrics) (#179) 2021-07-01 12:39:27 -04:00
Francis Lavoie
1ff5103c73
docs: Clarify uri syntax, replacement variables (#173)
- 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`?
2021-06-21 11:50:32 -06:00
Matthew Holt
85dbc186c2
docs: Minor updates to file_server and reverse_proxy 2021-06-17 14:12:56 -06:00
Francis Lavoie
fb298b3317
docs: Add propagation_timeout to tls issuer options (#172) 2021-06-15 14:10:08 -06:00
Klooven
1957b7f536
docs: caddyfile: preferred_chains issuer and global config (#169) 2021-06-09 09:53:50 -06:00
favonia
4491b9ef3b
docs: tls: revise doc of trusted_* directives (#168)
1. The *_file directives expects a regular PEM file, not a DER- or base64-encoded one.
2. The rejection condition was condensed.
2021-06-07 12:24:27 -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
a223b5ed55
docs: Warn about the behaviour of ? in multi-line header handlers (#155)
* 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>
2021-05-02 12:51:11 -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
975e06ee99
docs: Add php_fastcgi's index off option (#160)
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.
2021-04-27 18:53:13 -06:00
Francis Lavoie
6d648596ee
docs: Clarify file_server behaviour inside handle_errors (#159)
This was part of https://github.com/caddyserver/website/pull/154 which was incorrect, but I realized I had this part in it which is still relevant to keep.
2021-04-26 16:07:04 -04:00
Francis Lavoie
9dc0156ceb
docs: Add error caddyfile directive (#143)
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)
2021-04-16 11:37:53 -06:00
Francis Lavoie
b0324a9470
docs: Add path_regexp option for uri directive (#144)
ad8d01cb66
2021-04-16 11:36:54 -06:00
Kévin Dunglas
371993227e
docs: explain how to disabl FLoC (#152) 2021-04-16 11:36:28 -06:00
Aaron Taylor
bd9d8eaf71
docs: add replace log format directive, global log option (#147)
* caddyfile/directives/log: add docs for new replace directive

This commit corresponds with the functionality added in this PR:
https://github.com/caddyserver/caddy/pull/4029

* caddyfile: add documentation for new global log option

This corresponds with the changes in this PR:
https://github.com/caddyserver/caddy/pull/4028
2021-04-08 12:29:15 -06:00
Steffen Brüheim
f01036964f
docs: encode and file_server enhancements (content negotiation) (#148)
* docs: encode: add new subdirectives

* minimum_length
* prefer
* match

* docs: file_server: add precompressed subdirectives
2021-04-05 15:24:54 -06:00
Francis Lavoie
d3013905cb
docs: Add map regexp capture groups (#145)
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.
2021-04-05 15:20:09 -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
Matthew Holt
57b3739a21
docs: Various updates for 2.3, 2.4 beta, and Go 1.16
Steps on #139 (sorry)
2021-02-17 11:34:28 -07:00
Francis Lavoie
b33d40f15c
docs: Shorten the try_files expanded form too (#133) 2021-02-02 13:11:31 -07:00
Francis Lavoie
74db4350eb
docs: Shorten the php_fastcgi expanded form a bit (#131)
Just making use of the matcher shortcuts we have available to make it look a little less fluffy.
2021-01-27 11:32:30 -07:00
Luo Peng
a8700f7a04
docs: caddyfile: Minor grammar fix (closes #126) (#127) 2021-01-15 10:26:22 -07:00
Klooven
1019b7be50
docs: Escape < and > characters (#125) 2021-01-07 07:06:52 -07:00
Dave Henderson
54d309cc34
docs: metrics directive: Document disable_openmetrics (#123)
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
2020-12-30 11:01:37 -07:00
Matthew Holt
4827cff659
docs: Update for v2.3; refactor install information
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.
2020-12-30 07:37:15 -07:00
Matthew Holt
9dd9309a9b
docs: Add map directive 2020-12-14 18:25:35 -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
e2a6e4e212
docs: Mention the auth placeholder in basicauth docs (#117) 2020-11-26 12:20:14 -07:00
Matthew Holt
94a7c5f1cd docs: Minor improvements/clarifications 2020-11-25 10:47:01 -07:00
Gilbert Gilb's
8084cba78b
docs: header default values (#98)
see https://github.com/caddyserver/caddy/pull/3807
2020-11-24 15:32:42 -07: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
Simon Ser
2d417f3661
docs: Add network example to bind directive (#99) 2020-11-23 15:23:50 -07:00
Andy Pilate
570488d7f6
docs: Replaced http.cat example with single line respond (#106)
* Fix http.cat example with Host

* Add simpler example using respond
2020-11-23 11:22:19 -07:00
Nicola Piccinini
caefac9b51
docs: request_body Caddyfile directive (#104)
* Add documentation about request_body directive in Caddyfile

* Add note about matchers support

Co-authored-by: Francis Lavoie <lavofr@gmail.com>

* Improve description of max_size parameter

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

* Improve text

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

* Improve description of request_body directive

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

Co-authored-by: Francis Lavoie <lavofr@gmail.com>
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2020-11-19 12:04:39 -07:00
Francis Lavoie
828e4a4eb4
docs: Add new proxy transport options, fix buffer_requests location (#103) 2020-11-02 16:06:20 -07:00
Francis Lavoie
84ced83c0b
docs: Improve the log example to cover hiding IPs (#101) 2020-11-02 16:03:28 -07:00
Francis Lavoie
08533f5045
docs: Add filter encoder to Caddyfile docs (#90) 2020-10-01 12:27:14 -06:00
Kiran Thomas
51cacc7e4d
docs: clarify that default log format is console if TTY, otherwise JSON (#89) 2020-09-29 09:17:27 -06:00
Matthew Holt
af3676862b
docs: Update for v2.2 2020-09-25 12:53:11 -06:00
Dave Henderson
30084b98b0
docs: Monitoring and metrics (#86)
* metrics: Adding docs for metrics

Signed-off-by: Dave Henderson <dhenderson@gmail.com>

* Addressing review comments

Signed-off-by: Dave Henderson <dhenderson@gmail.com>

* Apply suggestions from code review

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

* Update src/docs/markdown/metrics.md

Co-authored-by: Dave Henderson <dhenderson@gmail.com>

Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
2020-09-22 20:12:24 -06:00
Matthew Holt
7da129a23a
docs: Add reverse_proxy compression subdirective 2020-08-31 18:39:56 -06:00
Matthew Holt
db56448157
docs: Add tls eab subdirective 2020-08-31 18:39:37 -06:00
Francis Lavoie
f1d0d13522
docs: Clarify file imports are relative to curr file, more cross-linking (#78) 2020-08-20 12:08:40 -06:00
Francis Lavoie
8e777706f9
docs: Add headers to reverse_proxy docs for anchor linking (#77) 2020-08-17 14:12:20 -06:00