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>
This commit is contained in:
Nicola Piccinini 2020-11-19 20:04:39 +01:00 committed by GitHub
parent 6b4998a5dc
commit caefac9b51
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 0 deletions

View file

@ -23,6 +23,7 @@ Directive | Description
**[php_fastcgi](/docs/caddyfile/directives/php_fastcgi)** | Serve PHP sites over FastCGI **[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 **[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 **[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 **[request_header](/docs/caddyfile/directives/request_header)** | Manipulates request headers
**[respond](/docs/caddyfile/directives/respond)** | Writes a hard-coded response to the client **[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 **[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 root
header header
request_body
redir redir
rewrite rewrite

View file

@ -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 [<matcher>] {
max_size <value>
}
```
- **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
}
```