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

add server readme

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

9
server/README.md Normal file
View file

@ -0,0 +1,9 @@
# `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).
## 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).

2
server/src/config.rs
View file

@ -295,7 +295,7 @@ pub enum ConfigFormat {
Yaml,
}
/// Server implementation of the Wisp protocol in Rust, made for epoxy.
/// Performant server implementation of the Wisp protocol in Rust, made for epoxy.
#[derive(Parser)]
#[command(version = clap::crate_version!())]
pub struct Cli {