YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-04-02 10:45:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: update to account for removal of mio version of aquatic_ws

Browse source
This commit is contained in:
Joakim Frostegård 2022-03-18 15:18:13 +01:00
parent 667cf04085
commit b4c07e5005
1 changed files with 8 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -13,11 +13,11 @@ of sub-implementations for different protocols:
[mio]: https://github.com/tokio-rs/mio [mio]: https://github.com/tokio-rs/mio
[glommio]: https://github.com/DataDog/glommio [glommio]: https://github.com/DataDog/glommio
| Name | Protocol | OS requirements | | Name | Protocol | OS requirements |
|--------------|--------------------------------------------|------------------------------------------------------------| |--------------|--------------------------------------------|------------------------------|
| aquatic_udp | [BitTorrent over UDP] | Unix-like | | aquatic_udp | [BitTorrent over UDP] | Unix-like (using [mio]) |
| aquatic_http | [BitTorrent over HTTP] with TLS ([rustls]) | Linux 5.8+ | | aquatic_http | [BitTorrent over HTTP] with TLS ([rustls]) | Linux 5.8+ (using [glommio]) |
| aquatic_ws | [WebTorrent] over TLS ([rustls]) | Unix-like with [mio] (default) / Linux 5.8+ with [glommio] | | aquatic_ws | [WebTorrent] over TLS ([rustls]) | Linux 5.8+ (using [glommio]) |
## Usage ## Usage
@ -25,10 +25,9 @@ of sub-implementations for different protocols:
- Install Rust with [rustup](https://rustup.rs/) (stable is recommended) - Install Rust with [rustup](https://rustup.rs/) (stable is recommended)
- Install cmake with your package manager (e.g., `apt-get install cmake`) - Install cmake with your package manager (e.g., `apt-get install cmake`)
- Unless you're planning to only run the cross-platform mio based - Unless you're planning to only run `aquatic_udp`, make sure locked memory
implementations, make sure locked memory limits are sufficient. limits are sufficient. You can do this by adding the following lines to
You can do this by adding the following lines to `/etc/security/limits.conf`, `/etc/security/limits.conf`, and then logging out and back in:
and then logging out and back in:
``` ```
* hard memlock 512 * hard memlock 512
@ -50,7 +49,6 @@ Compile the implementations that you are interested in:
cargo build --release -p aquatic_udp cargo build --release -p aquatic_udp
cargo build --release -p aquatic_http cargo build --release -p aquatic_http
cargo build --release -p aquatic_ws cargo build --release -p aquatic_ws
cargo build --release -p aquatic_ws --features "with-glommio" --no-default-features
``` ```
### Running ### Running