aquatic/README.md
2024-03-30 10:51:37 +01:00

2.8 KiB

aquatic: high-performance open BitTorrent tracker

CI

High-performance open BitTorrent tracker, consisting of sub-implementations for different protocols:

Name Protocol OS requirements
aquatic_udp BitTorrent over UDP Unix-like
aquatic_http BitTorrent over HTTP, optionally over TLS Linux 5.8 or later
aquatic_ws WebTorrent, optionally over TLS Linux 5.8 or later

Features at a glance:

  • Multithreaded design for handling large amounts of traffic
  • All data is stored in-memory (no database needed)
  • IPv4 and IPv6 support
  • Supports forbidding/allowing info hashes
  • Prometheus metrics
  • Automated CI testing of full file transfers

Known users:

Performance of the UDP implementation

UDP BitTorrent tracker throughput

More benchmark details are available here.

Usage

Please refer to the README pages for the respective implementations listed in the table above.

Support software

There are also some auxiliary applications and libraries.

Protocol-specific

Protocol Tracker load testing Client ⇄ tracker communication
UDP aquatic_udp_load_test aquatic_udp_protocol
HTTP aquatic_http_load_test aquatic_http_protocol
WebTorrent aquatic_ws_load_test aquatic_ws_protocol

General

Copyright (c) Joakim Frostegård

Distributed under the terms of the Apache License, Version 2.0. Please refer to the LICENSE file in the repository root directory for details.

Trivia

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