YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-03-31 17:55:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve README

Browse source
This commit is contained in:
Joakim Frostegård 2023-03-09 23:19:40 +01:00
parent 5c3c2b42ac
commit 5633a889a2
1 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -27,6 +27,7 @@ Features at a glance:
- Supports forbidding/allowing info hashes - Supports forbidding/allowing info hashes
- Built-in TLS support (no reverse proxy needed) - Built-in TLS support (no reverse proxy needed)
- Automated CI testing of full file transfers - Automated CI testing of full file transfers
- Prometheus metrics
Known users: Known users:
@ -192,10 +193,9 @@ This is the most mature of the implementations. I consider it ready for producti
#### io_uring #### io_uring
An experimental io_uring backend can be enabled by passing the `io-uring` An experimental io_uring backend is available. It currently requires Linux
feature when compilinig. Currently, Linux 6.0 or later is required. The 6.0 or later and will attempt to fall back to the [mio] backend if run with
application will attempt to fall back to the [mio] backend if your kernel is older kernels. To enable it, pass the `io-uring` feature when compiling:
not supported.
```sh ```sh
cargo build --release -p aquatic_udp --features "io-uring" cargo build --release -p aquatic_udp --features "io-uring"
@ -205,7 +205,9 @@ cargo build --release -p aquatic_udp --features "io-uring"
![UDP BitTorrent tracker throughput comparison](./documents/aquatic-udp-load-test-illustration-2023-01-11.png) ![UDP BitTorrent tracker throughput comparison](./documents/aquatic-udp-load-test-illustration-2023-01-11.png)
More details are available [here](./documents/aquatic-udp-load-test-2023-01-11.pdf). The mio backend was used. The mio backend was used. More details are available [here](./documents/aquatic-udp-load-test-2023-01-11.pdf).
---
### aquatic_http: HTTP BitTorrent tracker ### aquatic_http: HTTP BitTorrent tracker
@ -237,6 +239,8 @@ without knowing the exact setup.
More details are available [here](./documents/aquatic-http-load-test-2023-01-25.pdf). More details are available [here](./documents/aquatic-http-load-test-2023-01-25.pdf).
---
### aquatic_ws: WebTorrent tracker ### aquatic_ws: WebTorrent tracker
Aims for compatibility with [WebTorrent](https://github.com/webtorrent) Aims for compatibility with [WebTorrent](https://github.com/webtorrent)