From caefac9b5115acbff5ddb27c3904e73d3fa20d52 Mon Sep 17 00:00:00 2001 From: Nicola Piccinini Date: Thu, 19 Nov 2020 20:04:39 +0100 Subject: [PATCH] docs: request_body Caddyfile directive (#104) * Add documentation about request_body directive in Caddyfile * Add note about matchers support Co-authored-by: Francis Lavoie * Improve description of max_size parameter Co-authored-by: Matt Holt * Improve text Co-authored-by: Matt Holt * Improve description of request_body directive Co-authored-by: Matt Holt Co-authored-by: Francis Lavoie Co-authored-by: Matt Holt --- src/docs/markdown/caddyfile/directives.md | 2 ++ .../caddyfile/directives/request_body.md | 29 +++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 src/docs/markdown/caddyfile/directives/request_body.md diff --git a/src/docs/markdown/caddyfile/directives.md b/src/docs/markdown/caddyfile/directives.md index 276c01b..849a7cc 100644 --- a/src/docs/markdown/caddyfile/directives.md +++ b/src/docs/markdown/caddyfile/directives.md @@ -23,6 +23,7 @@ Directive | Description **[php_fastcgi](/docs/caddyfile/directives/php_fastcgi)** | Serve PHP sites over FastCGI **[push](/docs/caddyfile/directives/push)** | Push content to the client using HTTP/2 server push **[redir](/docs/caddyfile/directives/redir)** | Issues an HTTP redirect to the client +**[request_body](/docs/caddyfile/directives/request_body)** | Manipulates request body **[request_header](/docs/caddyfile/directives/request_header)** | Manipulates request headers **[respond](/docs/caddyfile/directives/respond)** | Writes a hard-coded response to the client **[reverse_proxy](/docs/caddyfile/directives/reverse_proxy)** | A powerful and extensible reverse proxy @@ -75,6 +76,7 @@ Many directives manipulate the HTTP handler chain. The order in which those dire root header +request_body redir rewrite diff --git a/src/docs/markdown/caddyfile/directives/request_body.md b/src/docs/markdown/caddyfile/directives/request_body.md new file mode 100644 index 0000000..552117e --- /dev/null +++ b/src/docs/markdown/caddyfile/directives/request_body.md @@ -0,0 +1,29 @@ +--- +title: request_body (Caddyfile directive) +--- + +# request_body + +Manipulates or sets restrictions on the bodies of incoming requests. + + +## Syntax + +```caddy-d +request_body [] { + max_size +} +``` + +- **max_size** is the maximum size in bytes allowed for the request body. It accepts all formats supported by [go-humanize](https://github.com/dustin/go-humanize/blob/master/bytes.go). + + +## Examples + +Limit request body sizes to 10 megabytes: + +```caddy-d +request_body { + max_size 10MB +} +```