diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 15 |
1 files changed, 12 insertions, 3 deletions
@@ -19,6 +19,11 @@ a simple stupid reverse proxy - [Matrix Room](https://matrix.to/#/#gnix:metamuffin.org) for questions, announcements and general discussion around the software. +## Installation + +On arch use `gnix` from the AUR; Otherwise install `rustup`, then run +`cargo install --git https://codeberg.org/metamuffin/gnix --tag v2.x.x`. + ## Quick Start Run the binary with the a path to the configuration as the first argument. The @@ -49,7 +54,7 @@ handler: !hosts # !hosts routes requests for different hostnames. next: !proxy { backend: "otherserver:80" } ``` -## Reference +## Configuration Reference The configuration uses YAML formatting. When the configuration file is changed, it will automatically be loaded and applied if valid. Configuration errors are @@ -71,6 +76,10 @@ reported in stderr and are only fatal at startup. is used when no other certificate seems appropriate. This is useful for testing locally with a self-signed subjectless certificate. (optional string) + - `disable_h1` Stops advertising HTTP/1.1 support but still continues to + support it. Default: false + - `disable_h2` Stops advertising HTTP/2 support. Default: false + - `disable_h3` Disables HTTP/3 support. Default: false - **section `limits`** - Note: Make sure you do not exceed the maximum file descriptor limit on your @@ -269,8 +278,8 @@ that contains that map in YALM format. Currently only `argon2id` is supported. ### Additional Notes -Internally gnix processes requests as they would be sent in HTTP/1.1. HTTP/2 is -translated on arrival. +Internally gnix processes requests as they would be sent in HTTP/1.1. HTTP/2 and +HTTP/3 is translated on arrival. Paths matching `/_gnix*` might be used internally in gnix for purposes like OpenID callback or login action endpoints. I hope your application doesn't rely |