mirror of
https://github.com/MercuryWorkshop/epoxy-tls.git
synced 2025-05-12 22:10:01 -04:00
19 lines
906 B
Markdown
19 lines
906 B
Markdown
# `epoxy-server`
|
|
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`.
|
|
|
|
The defaults can be printed with the command line option `--default-config` and the configuration file format can be changed from the default of TOML with the command line option `--format`. Documentation for the available configuration options is in [`src/config.rs`](src/config.rs).
|