aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShav Kinderlehrer <[email protected]>2024-04-07 20:06:27 -0400
committerShav Kinderlehrer <[email protected]>2024-04-07 20:39:02 -0400
commit3b7d5454ccb2875fb45a46ea138d1bffec5b7542 (patch)
tree372304aee1540daa1b42767fa47b26886e432d9d /README.md
parentf080854b84d80f6063b4f9392d059a84ec09e66c (diff)
downloadchela-1.1.0.tar.gz
chela-1.1.0.zip
Add support for Unix sockets and custom alphabetv1.1.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2f24b88..60ba570 100644
--- a/README.md
+++ b/README.md
@@ -63,6 +63,12 @@ A page that Chela will redirect to when `/` is requested instead of replying wit
##### `CHELA_BEHIND_PROXY`
If this variable is set, Chela will use the `X-Real-IP` header as the client IP address rather than the connection address.
+##### `CHELA_UNIX_SOCKET`
+If you would like Chela to listen for HTTP requests over a Unix socket, set this variable to the socket path that it should use. By default, Chela will listen via a Tcp socket.
+
+##### `CHELA_ALPHABET`
+If this variable is set, Chela will use the characters in `CHELA_ALPHABET` to create IDs for URLs. The default alphabet is `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`. See [here](https://sqids.org/faq#unique)
+
### Manually
#### Build
```bash