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

README: various fixes and improvements

Browse source
This commit is contained in:
Joakim Frostegård 2021-11-08 12:48:38 +01:00
parent 956a725ac6
commit a88c9e0ca9
1 changed files with 4 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -67,9 +67,9 @@ Begin by generating configuration files. They differ between protocols.
Make adjustments to the files. You will likely want to adjust `address` Make adjustments to the files. You will likely want to adjust `address`
(listening address) under the `network` section. (listening address) under the `network` section.
Both `aquatic_http` and `aquatic_ws` requires configuring a TLS certificate `aquatic_http` requires configuring a TLS certificate file as well as a
file as well as a private key file to run. More information is available private key file to run. More information is available in the
in the `aquatic_http` subsection of this document. corresponding subsection of this document.
Once done, run the tracker: Once done, run the tracker:
@ -122,8 +122,6 @@ except that it:
Supports IPv4 and IPv6 (BitTorrent UDP protocol doesn't support IPv6 very well, Supports IPv4 and IPv6 (BitTorrent UDP protocol doesn't support IPv6 very well,
however.) however.)
For optimal performance, enable setting of core affinities in configuration.
#### Alternative implementation using io_uring #### Alternative implementation using io_uring
[io_uring]: https://en.wikipedia.org/wiki/Io_uring [io_uring]: https://en.wikipedia.org/wiki/Io_uring
@ -132,7 +130,7 @@ For optimal performance, enable setting of core affinities in configuration.
There is an alternative implementation that utilizes [io_uring] by running on There is an alternative implementation that utilizes [io_uring] by running on
[glommio]. It only runs on Linux and requires a recent kernel (version 5.8 or later). [glommio]. It only runs on Linux and requires a recent kernel (version 5.8 or later).
#### Benchmarks #### Performance
![UDP BitTorrent tracker throughput comparison](./documents/aquatic-udp-load-test-illustration-2021-11-08.png) ![UDP BitTorrent tracker throughput comparison](./documents/aquatic-udp-load-test-illustration-2021-11-08.png)