mirror of
https://github.com/MercuryWorkshop/epoxy-tls.git
synced 2025-05-13 06:20:02 -04:00
redirect user to server readme
This commit is contained in:
parent
9c49e68daf
commit
9aa294ce70
2 changed files with 12 additions and 25 deletions
27
README.md
27
README.md
|
@ -23,35 +23,12 @@ console.log(await response.text());
|
||||||
See `client/demo.js` for more examples.
|
See `client/demo.js` for more examples.
|
||||||
|
|
||||||
## Using the server
|
## Using the server
|
||||||
```
|
See the [server readme](server/README.md).
|
||||||
$ 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"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
> [!IMPORTANT]
|
|
||||||
> Rust nightly is required.
|
|
||||||
|
|
||||||
### Server
|
### Server
|
||||||
```
|
See the [server readme](server/README.md).
|
||||||
cargo b -r --bin epoxy-server
|
|
||||||
```
|
|
||||||
The executable will be placed at `target/release/epoxy-server`.
|
|
||||||
|
|
||||||
### Client
|
### Client
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
|
|
|
@ -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).
|
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
|
## 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`.
|
`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`.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue