diff options
| author | Runxi Yu <me@runxiyu.org> | 2025-03-23 11:52:35 +0800 |
|---|---|---|
| committer | Runxi Yu <me@runxiyu.org> | 2025-03-23 11:52:35 +0800 |
| commit | 1c36ef0dcdce773e04aea6d09cabae3d1dab661a (patch) | |
| tree | f351aae136ce34403e6812568a851a85e72eff59 | |
| parent | Remove the trivial habitual makefile (diff) | |
| download | powxy-1c36ef0dcdce773e04aea6d09cabae3d1dab661a.tar.gz powxy-1c36ef0dcdce773e04aea6d09cabae3d1dab661a.tar.zst powxy-1c36ef0dcdce773e04aea6d09cabae3d1dab661a.zip | |
Reorganize README
| -rw-r--r-- | README.md | 40 |
1 files changed, 35 insertions, 5 deletions
@@ -10,10 +10,6 @@ I intend to remove this in the near future and set up an actual demo instance on somewhere sensible; forge.runxiyu.org doesn't get much bot traffic so it's a bit unnecessary. -## Credits - -Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler. - ## Bugs - **The cryptography hasn't been audited.** I wrote this after a tiring school @@ -27,7 +23,37 @@ Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler. - Currently we round times to the nearest week for persistence, but this could cause issues if a user completes the challenge at the end of a rounded week. -## Contributing +## Installation + +You need a working Go installation. Then either + +``` +go install go.lindenii.runxiyu.org/powxy@latest +``` + +or + +``` +git clone ssh://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/ +cd powxy +go install +``` + +## Usage + +``` +Usage of ./powxy: + -difficulty uint + leading zero bits required for the challenge (default 17) + -listen string + address to listen on (default ":8081") + -secondary + trust X-Forwarded-For headers + -upstream string + destination url base to proxy to (default "http://127.0.0.1:8080") +``` + +## Contribute Create a branch that begins with `contrib/` and push to [the repo on our home forge](https://forge.lindenii.runxiyu.org/powxy/:/repos/powxy/) @@ -47,6 +73,10 @@ git push -u origin HEAD on [irc.runxiyu.org](https://irc.runxiyu.org/). +## Credits + +Inspired by [Anubis](https://github.com/TecharoHQ/anubis). But much simpler. + ## License We are currently using the |