redirect user to server readme

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

View file

@ -23,35 +23,12 @@ console.log(await response.text());
See `client/demo.js` for more examples.
## Using the server
```
$ cargo r -r --bin epoxy-server -- --help
Implementation of the Wisp protocol in Rust, made for epoxy.
Usage: epoxy-server [OPTIONS]
Options:
--prefix <PREFIX> [default: ]
-p, --port <PORT> [default: 4000]
-b, --host <HOST> [default: 0.0.0.0]
-u, --unix-socket
-h, --help Print help
-V, --version Print version
```
You can listen on a unix socket by passing the `--unix-socket` flag and the unix socket path in the `--host` flag. Example:
```
cargo r -r -- -u -b "/home/user/epoxy-socket"
```
See the [server readme](server/README.md).
## Building
> [!IMPORTANT]
> Rust nightly is required.
### Server
```
cargo b -r --bin epoxy-server
```
The executable will be placed at `target/release/epoxy-server`.
See the [server readme](server/README.md).
### Client
> [!IMPORTANT]

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`.