From 8f4b9944e76e4b31235ef396ade910f136271224 Mon Sep 17 00:00:00 2001 From: Riley Apeldoorn Date: Thu, 21 Jul 2022 13:56:11 +0200 Subject: [PATCH] Update readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 33b4887..e8cc41c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Proxima -Proxima is a simple gateway server. +Proxima is a simple gateway server. It supports reverse proxying to a different +port on `0.0.0.0` and responding to requests with a `308 Permanent Redirect` +response code. ## Configuring @@ -14,3 +16,14 @@ hostname and a portspec) and an effect: either a number indicating a port on `0.0.0.0` to proxy the request to or a string that is used as the `location` header's value. If the latter effect is specified, Proxima redirects clients to that location. + +### Examples + +The following config defines two rules: the first one redirects all requests +to `git.riley.lgbt` to `https://im.badat.dev`. The second rule passes each +request to `riley.lgbt` to port `3000`. + +``` +git.riley.lgbt : * ==> https://im.badat.dev + riley.lgbt : * --> 3000 +```