aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-11-11 15:14:29 +0100
committermetamuffin <metamuffin@disroot.org>2024-11-11 15:14:29 +0100
commitc59e34ac28b8af16c522b6f685015770c0be7223 (patch)
tree928c6cbfce301e89937b91bc0a46fd2d528e47ae /readme.md
parentef1ed0beb17649e7c65eee7081c605282bae8111 (diff)
downloadgnix-c59e34ac28b8af16c522b6f685015770c0be7223.tar
gnix-c59e34ac28b8af16c522b6f685015770c0be7223.tar.bz2
gnix-c59e34ac28b8af16c522b6f685015770c0be7223.tar.zst
list undocumented modules
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 53f54f5..7508767 100644
--- a/readme.md
+++ b/readme.md
@@ -9,7 +9,7 @@ a simple stupid reverse proxy
- Somewhat fast (about 150k req/s on a rpi5 for simple routes)
- Composable modules
- Handles connection upgrades correctly by default (websocket, etc.)
-- TLS support
+- TLS support with automatic certificate selection
- Configuration hot-reloading
- Client authentification (http basic auth, cookie)
- _TODO: h3; connection pooling_
@@ -203,12 +203,22 @@ themselves; in that case the request is passed on.
- Takes the location to redirect to. (string)
- **module `cgi`**
- - Runs a CGI script on the request. **This is experimental and probably
- vulnerable! Don't use this.**
+ - Runs a CGI script on the request. **This is experimental! Don't use this.**
- `bin`: Path to the CGI binary
- `user`: User that the script is executed as. Requires to run gnix as root.
(optional string)
+- **module `cache`**
+ - Caches requests. **This is experimental! Don't use this.**
+ - Not documented yet
+
+- **module `loadbalance`**
+ - Balances load across multiple modules (presumably proxied backends). The
+ current implementation selects the least busy handler for each request and
+ does not scale well to many modules. **This is experimental! Don't use
+ this.**
+ - Takes a set of handlers. (sequence of module)
+
- **module `debug`**
- Replies with information about the request to debug. Includes source
address, HTTP version, URI and headers.