diff --git a/README.md b/README.md index a789f9f..a859ab7 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ of sub-implementations for different protocols: |--------------|--------------------------------------------|------------------------------------------------------------| | aquatic_udp | [BitTorrent over UDP] | Unix-like with [mio] (default) / Linux 5.8+ with [glommio] | | aquatic_http | [BitTorrent over HTTP] with TLS ([rustls]) | Linux 5.8+ | -| aquatic_ws | [WebTorrent] with TLS (rustls) | Linux 5.8+ | +| aquatic_ws | [WebTorrent] | Unix-like with [mio] (default) / Linux 5.8+ with [glommio] | ## Usage @@ -182,17 +182,28 @@ tls_private_key_path = './key.pem' Aims for compatibility with [WebTorrent](https://github.com/webtorrent) clients, with some exceptions: - * Only runs over TLS (wss protocol) * 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 -The current glommio-based implementation currently has large performance -regressions compared to [the previous mio-based implementation](https://github.com/greatest-ape/aquatic/tree/30fa96a7f43eb7568b7df1e1fdb6e1885f3b4f58). -Use it instead if you want maximum performance now. -#### TLS +#### TLS: mio version -Please see `aquatic_http` TLS section above. +To run over TLS, a pkcs12 file (`.pkx`) is needed. It can be generated from +Let's Encrypt certificates as follows, assuming you are in the directory where +they are stored: + +```sh +openssl pkcs12 -export -out identity.pfx -inkey privkey.pem -in cert.pem -certfile fullchain.pem +``` + +Enter a password when prompted. Then move `identity.pfx` somewhere suitable, +and enter the path into the tracker configuration field `tls_pkcs12_path`. Set +the password in the field `tls_pkcs12_password` and set `use_tls` to true. + +#### TLS: glommio version + +The glommio version only runs over TLS. For setup instructions, please see +`aquatic_http` TLS section above. #### Benchmarks @@ -221,8 +232,7 @@ Server responses per second, best result in bold: Please refer to `documents/aquatic-ws-load-test-2021-08-18.pdf` for more details. -__Note__: these benchmarks were made with the previous mio-based -implementation. +__Note__: these benchmarks were made with the mio-based implementation. ## Load testing