From e21267342c74927a1f9255b4ea02fac32961031a Mon Sep 17 00:00:00 2001 From: metamuffin Date: Tue, 18 Mar 2025 23:16:42 +0100 Subject: limits module --- readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 3b2b5d0..56a47b3 100644 --- a/readme.md +++ b/readme.md @@ -219,6 +219,8 @@ themselves; in that case the request is passed on. - `bin`: Path to the CGI binary (string) - `user`: User that the script is executed as. Requires to run gnix as root. (optional string) + - `args`: List of arguments. (list of string) + - `env`: Environment variables. (map from string to string) - **module `cache`** - Caches requests. **This is experimental! Don't use this.** @@ -240,6 +242,20 @@ themselves; in that case the request is passed on. this. **TODO request size limit** - Takes a sequence of handlers. +- **module `limits`** + - Limits size and transmission rate of request and response bodies. The limit + is enforced on an internal data frame level and does therefore not exactly + reach the specified limits, but never exceeds them. + - `{request,response}.rate` Maximum transmission rate in bytes per second. + (number) + - `{request,response}.rate_buffer` How much transmission time can be + accumulated by not reading for some time in milliseconds. (number) + - `{request,response}.rate_buffer_filled` If the rate buffer is filled up + initially. (boolean) + - `{request,response}.size` Maximum total body size. The body is cut off + before the frame that exceeds this limit. Therefore the body is up to one + frame size smaller than allowed. + - **module `debug`** - Replies with information about the request to debug. Includes source address, HTTP version, URI and headers. -- cgit v1.2.3-70-g09d2