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

Update README: mention difficulties with testing aquatic_ws

Browse source
This commit is contained in:
Joakim Frostegård 2021-02-10 23:33:11 +01:00
parent e6233b3aa0
commit 1f0fb07d0f
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -5,7 +5,7 @@ Blazingly fast, multi-threaded BitTorrent tracker written in Rust.
Consists of three sub-implementations for different protocols: Consists of three sub-implementations for different protocols:
* `aquatic_udp`: BitTorrent over UDP. Implementation achieves double the throughput * `aquatic_udp`: BitTorrent over UDP. Implementation achieves double the throughput
of opentracker (see benchmarks below) of opentracker (see benchmarks below)
* `aquatic_http`: BitTorrent over HTTP/TLS (experimental) * `aquatic_http`: BitTorrent over HTTP/TLS (slightly experimental)
* `aquatic_ws`: WebTorrent (experimental) * `aquatic_ws`: WebTorrent (experimental)
## Copyright and license ## Copyright and license
@ -146,12 +146,14 @@ exceptions:
* Doesn't track of the number of torrent downloads (0 is always sent). * Doesn't track of the number of torrent downloads (0 is always sent).
* Doesn't allow full scrapes, i.e. of all registered info hashes * Doesn't allow full scrapes, i.e. of all registered info hashes
`aquatic_ws` is not as well tested as `aquatic_udp`, but has been For information about running over TLS, please refer to the TLS subsection
successfully used as the tracker for a file transfer between two webtorrent of the `aquatic_http` section above.
peers.
For information about running over TLS (wss protocol), please refer to `aquatic_ws` is experimental software. Connections are established
the corresponding `aquatic_http` section above. successfully when using `aquatic_ws_load_test`, but so far, I haven't been able
to implement CI for testing if aquatic_ws works as the tracker for a full
file transfer session between two real-world clients. One reason for this
is the general lack of high-quality WebTorrent clients.
## Load testing ## Load testing