diff --git a/readme.md b/readme.md index c90640d..a7063d8 100644 --- a/readme.md +++ b/readme.md @@ -15,7 +15,11 @@ Realm is a simple, high performance relay server written in rust. - Concurrency. Bidirectional concurrent traffic leads to high performance. - Low resources cost. -## Build +## Transports + +With `transport` feature, Realm is able to handle [ws/tls/wss] on both sides. This is powered by [libkaminari](https://github.com/zephyrchien/kaminari). + +## Build Guides Install rust toolchains with [rustup](https://rustup.rs/). @@ -37,7 +41,7 @@ git submodule sync && git submodule update --init --recursive cargo build --release ``` -### Build options +### Build Options - udp *(enabled by default)* - trust-dns *(enabled by default)* @@ -60,7 +64,7 @@ cargo build --release --no-default-features cargo build --release --no-default-features --features udp, tfo, zero-copy, trust-dns ``` -### Cross compile +### Cross Compile Please refer to [https://rust-lang.github.io/rustup/cross-compilation.html](https://rust-lang.github.io/rustup/cross-compilation.html). You may need to install cross-compilers or other SDKs, and specify them when building the project. @@ -84,13 +88,15 @@ FLAGS: -z, --splice force enable tcp zero copy OPTIONS: - -n, --nofile set nofile limit - -p, --page set pipe capacity - -c, --config use config file - -l, --listen
listen address - -r, --remote
remote address - -x, --through
send through ip or address - -i, --interface bind to interface + -n, --nofile set nofile limit + -p, --page set pipe capacity + -c, --config use config file + -l, --listen
listen address + -r, --remote
remote address + -x, --through
send through ip or address + -i, --interface bind to interface + -a, --listen-transport listen transport + -b, --remote-transport remote transport LOG OPTIONS: --log-level override log level @@ -116,7 +122,6 @@ TIMEOUT OPTIONS: SUBCOMMANDS: convert convert your legacy configuration into an advanced one - ``` Start from command line arguments: @@ -440,6 +445,18 @@ Supported formats: Bind to a specific interface +#### endpoint.listen_transport: string + +Require the `transport` feature + +See [Kaminari Options](https://github.com/zephyrchien/kaminari#options) + +#### endpoint.remote_transport: string + +Require the `transport` feature + +See [Kaminari Options](https://github.com/zephyrchien/kaminari#options) + #### endpoint.network The same as [network](#network), override global options.