fancy
/
charon
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add readme with usage

This commit is contained in:
fancy 2024-11-30 11:01:19 +00:00
parent d80c4d3e88
commit 964c77f848
Signed by: fancy
GPG Key ID: CDC20AFC36C69246
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# Charon (WIP)
Charon is an anti-DDoS reverse proxy. [Learn more here](http://yqx6hygykwc45mzjzjfiuruqzrdbhcxjx2mcdrg65v4p7r5rujkrkeqd.onion/blog/01-writing-charon).
# USAGE
Charon follows the UNIX philosophy (do one thing and do it well), so, by design, it doesn't provide an overwhelming amount of configuration. It's configured through environment variables.
`PORT: Integer`, Default: `8080`, determines what port charon listens on
`HOST: IP`, Default `127.0.0.1`, determines the IP address charon listens on
`RUST_LOG`, Default `none`, determines the verbosity of charon's logs