Blazingly fast, multi-threaded BitTorrent tracker written in Rust, consisting 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||Unix-like with mio (default) / Linux 5.8+ with glommio|
apt-get install cmake)
/etc/security/limits.conf, and then logging out and back in:
* hard memlock 512 * soft memlock 512
Compile the implementations that you are interested in:
# Tell Rust to enable support for all CPU extensions present on current CPU # except for those relating to AVX-512. This is necessary for aquatic_ws and # recommended for the other implementations. . ./scripts/env-native-cpu-without-avx-512 cargo build --release -p aquatic_udp cargo build --release -p aquatic_udp --features "with-glommio" --no-default-features cargo build --release -p aquatic_http cargo build --release -p aquatic_ws cargo build --release -p aquatic_ws --features "with-glommio" --no-default-features
Begin by generating configuration files. They differ between protocols.
./target/release/aquatic_udp -p > "aquatic-udp-config.toml" ./target/release/aquatic_http -p > "aquatic-http-config.toml" ./target/release/aquatic_ws -p > "aquatic-ws-config.toml"
Make adjustments to the files. You will likely want to adjust
(listening address) under the
aquatic_http requires configuring a TLS certificate file as well as a
private key file to run. More information is available in the
corresponding subsection of this document.
Once done, run the tracker:
./target/release/aquatic_udp -c "aquatic-udp-config.toml" ./target/release/aquatic_http -c "aquatic-http-config.toml" ./target/release/aquatic_ws -c "aquatic-ws-config.toml"
Starting a lot more socket workers than request workers is recommended. All
implementations are heavily IO-bound and spend most of their time reading from
and writing to sockets. This part is handled by the
also do parsing, serialisation and access control. They pass announce and
scrape requests to the
request_workers, which update internal tracker state
and pass back responses.
Access control by info hash is supported for all protocols. The relevant part of configuration is:
[access_list] mode = 'off' # Change to 'black' (blacklist) or 'white' (whitelist) path = '' # Path to text file with newline-delimited hex-encoded info hashes
The file is read on start and when the program receives
More documentation of the various configuration options might be available
src/lib/config.rs in directories
Aims to implements the UDP BitTorrent protocol, except that it:
Supports IPv4 and IPv6 (BitTorrent UDP protocol doesn't support IPv6 very well, however.)
More details are available here.
Aims for compatibility with the HTTP BitTorrent protocol, with some exceptions:
aquatic_http has not been tested as much as
aquatic_udp but likely works
A TLS certificate file (DER-encoded X.509) and a corresponding private key file (DER-encoded ASN.1 in either PKCS#8 or PKCS#1 format) are required. Set their paths in the configuration file, e.g.:
[network] address = '0.0.0.0:3000' tls_certificate_path = './cert.pem' tls_private_key_path = './key.pem'
Aims for compatibility with WebTorrent clients, with some exceptions:
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:
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
the password in the field
tls_pkcs12_password and set
use_tls to true.
The glommio version only runs over TLS. For setup instructions, please see
aquatic_http TLS section above.
The following benchmark is not very realistic, as it simulates a small number of clients, each sending a large number of requests. Nonetheless, I think that it gives a useful indication of relative performance.
Server responses per second, best result in bold:
* Using a VPS with 32 vCPUs. The other measurements were made using a 16 vCPU VPS.
Please refer to
documents/aquatic-ws-load-test-2021-08-18.pdf for more details.
Note: these benchmarks were made with the mio-based implementation.
There are load test binaries for all protocols. They use a CLI structure similar to the trackers and support generation and loading of configuration files.
To run, first start the tracker that you want to test. Then run the corresponding load test binary:
./scripts/run-load-test-udp.sh ./scripts/run-load-test-http.sh ./scripts/run-load-test-ws.sh
To fairly compare HTTP performance to opentracker, set keepalive to false in
Copyright (c) 2020-2021 Joakim Frostegård
Distributed under Apache 2.0 license (details in
The tracker is called aquatic because it thrives under a torrent of bits ;-)