mirror of https://github.com/YGGverse/aquatic.git synced 2026-03-31 17:55:36 +00:00

High-performance open BitTorrent tracker (UDP, HTTP, WebTorrent)

Find a file

Joakim Frostegård 2967129c1f aquatic_ws: network: streamline handshake handlers		2020-05-13 18:44:10 +02:00
aquatic_common	Move some code from aquatic_udp into aquatic_common	2020-05-11 17:06:37 +02:00
aquatic_udp	Move some code from aquatic_udp into aquatic_common	2020-05-11 17:06:37 +02:00
aquatic_udp_bench	rename aquatic to aquatic_udp, same for bench and load test crates	2020-05-11 16:55:46 +02:00
aquatic_udp_load_test	rename aquatic to aquatic_udp, same for bench and load test crates	2020-05-11 16:55:46 +02:00
aquatic_ws	aquatic_ws: network: streamline handshake handlers	2020-05-13 18:44:10 +02:00
bittorrent_udp	Decide to use Apache 2.0 license, add file and update Cargo.toml's	2020-04-20 16:54:43 +02:00
cli_helpers	Decide to use Apache 2.0 license, add file and update Cargo.toml's	2020-04-20 16:54:43 +02:00
documents	Add load test pdf, remove load test details from README	2020-04-19 20:58:05 +02:00
scripts	rename aquatic to aquatic_udp, same for bench and load test crates	2020-05-11 16:55:46 +02:00
.gitignore	Add load test pdf, remove load test details from README	2020-04-19 20:58:05 +02:00
Cargo.lock	WIP: aquatic_ws: start work on wss (ws with tls)	2020-05-12 18:48:50 +02:00
Cargo.toml	Move some code from aquatic_udp into aquatic_common	2020-05-11 17:06:37 +02:00
deny.toml	Add cargo deny file deny.toml, check dependency licenses	2020-04-20 16:49:40 +02:00
LICENSE	Decide to use Apache 2.0 license, add file and update Cargo.toml's	2020-04-20 16:54:43 +02:00
README.md	Update README to reflect reorganisation & aquatic_ws	2020-05-11 17:57:07 +02:00
TODO.md	aquatic_ws: add setting for using tls; update TODO	2020-05-13 16:43:23 +02:00

README.md

aquatic

Blazingly fast, multi-threaded BitTorrent tracker written in Rust.

Consists of separate executables:

aquatic_udp: UDP BitTorrent tracker
aquatic_ws: WebTorrent tracker (experimental)

Distributed under Apache 2.0 license (details in LICENSE file.)

aquatic_udp

Aims to implements the UDP BitTorrent protocol, except that it:

Doesn't care about IP addresses sent in announce requests. The packet source IP is always used.
Doesn't track of the number of torrent downloads (0 is always sent).

Supports IPv4 and IPv6.

Installation and usage

Install rust with rustup, cmake with your package manager and clone the repository. Then, compile and run aquatic_udp:

./scripts/run-aquatic-udp.sh

To print default configuration as toml, pass the "-p" flag to the binary:

./scripts/run-aquatic-udp.sh -p

Example output:

socket_workers = 1
request_workers = 1

[network]
address = '127.0.0.1:3000'
max_scrape_torrents = 255
max_response_peers = 255
peer_announce_interval = 900
socket_recv_buffer_size = 524288
poll_event_capacity = 4096

[handlers]
max_requests_per_iter = 10000
channel_recv_timeout_microseconds = 200

[statistics]
interval = 5

[cleaning]
interval = 30
max_peer_age = 1200
max_connection_age = 300

[privileges]
drop_privileges = false
chroot_path = '.'
user = 'nobody'

To adjust the settings, save this text to a file and make your changes. The values you will most likely want to adjust are socket_workers (number of threads reading from and writing to sockets) and network.address. (Some documentation of the various options is available in source code file aquatic_udp/src/lib/config.rs.) Then run aquatic with a "-c" argument pointing to the file, e.g.:

./scripts/run-aquatic-udp.sh -c "tmp/aquatic-udp.toml"

Benchmarks

Performance was compared to opentracker using aquatic_udp_load_test.

Server responses per second, best result in bold:

workers	aquatic	opentracker
1	n/a	177k
2	168k	98k
3	187k	118k
4	216k	127k
6	309k	109k
8	408k	96k

(See documents/aquatic-load-test-2020-04-19.pdf for details.)

aquatic_ws

Experimental WebTorrent tracker.

Run aquatic_ws:

./scripts/run-aquatic-ws.sh

Trivia

The tracker is called aquatic because it thrives under a torrent of bits ;-)