mercuryworkshop-mirror/epoxy-tls
1
0
Fork 0
mirror of https://github.com/MercuryWorkshop/epoxy-tls.git synced 2025-05-12 22:10:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

redirect user to server readme

Browse source
This commit is contained in:
Toshit Chawda 2024-07-22 14:29:35 -07:00
parent 9c49e68daf
commit 9aa294ce70
No known key found for this signature in database
GPG key ID: 91480ED99E2B3D9D
2 changed files with 12 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

10
server/README.md
View file

@ -3,6 +3,16 @@ Performant server implementation of the Wisp protocol in Rust, made for epoxy.
You can view a recent flamegraph of the server under load [here](flamegraph.svg?raw=true).
## Building
> [!IMPORTANT]
> Rust nightly is required.
```
cargo b -r
```
The executable will be placed at `target/release/epoxy-server`.
You can optionally add the environment variable `RUSTFLAGS="-C target-cpu=native"` to optimize for the current CPU.
## Configuration
`epoxy-server` is configured through a configuration file in either TOML, JSON, or YAML. Pass the configuration file's path as an argument to `epoxy-server`.