riley
/
proxima
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

This commit is contained in:
Riley Apeldoorn 2022-07-21 13:56:11 +02:00
parent a6f9325e33
commit 8f4b9944e7
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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
```