Torrust Tracker

![containerwfb] ![coveragewfb] ![deploymentwfb] ![testingwfb]

Torrust Tracker, is a BitTorrent Tracker (a service that matchmakes peers and collects statistics) written in Rust Language and [axum] (a modern web application framework). This tracker aims to be respectful to established standards, (both formal and otherwise).

This is a Torrust project and is in active development. It is community supported as well as sponsored by Nautilus Cyberneering.

• We have a container guide for those who wish to get started with Docker or Podman

Key Features

• [x] High Quality and Modern Rust Codebase.
• x Generated from Code Comments.
• [x] [Comprehensive Suit][coverage] of Unit and Functional Tests.
• [x] Good Performance in Busy Conditions.
• [x] Support for UDP, HTTP, and TLS Sockets.
• [x] Native IPv4 and IPv6 support.
• [x] Private & Whitelisted mode.
• [x] Tracker Management API.
• [x] Support newTrackon checks.
• [x] Persistent SQLite3 or MySQL Databases.

Implemented BitTorrent Enhancement Proposals (BEPs)

Learn more about BitTorrent Enhancement Proposals

• [BEP 03] : The BitTorrent Protocol.
• [BEP 07] : IPv6 Support.
• [BEP 15] : UDP Tracker Protocol for BitTorrent.
• [BEP 23] : Tracker Returns Compact Peer Lists.
• [BEP 27] : Private Torrents.
• [BEP 48] : Tracker Protocol Extension: Scrape.

Getting Started

Container Version

The Torrust Tracker is deployed to DockerHub, you can run a demo immediately with the following commands:

Docker:

sh docker run -it torrust/tracker:develop

Please read our container guide for more information.

Podman:

sh podman run -it torrust/tracker:develop

Please read our container guide for more information.

Development Version

• Please assure you have the latest stable (or nightly) version of rust.
• Please assure that you computer has enough ram. Recommended 16GB.

Checkout, Test and Run:

```sh

Checkout repository into a new folder:

git clone https://github.com/torrust/torrust-tracker.git

Change into directory and create a empty database file:

cd torrust-tracker mkdir -p ./storage/tracker/lib/database/ touch ./storage/tracker/lib/database/sqlite3.db

Check all tests in application:

cargo test --tests --benches --examples --workspace --all-targets --all-features

Run the tracker:

cargo run ```

Customization:

```sh

Copy the default configuration into the standard location:

mkdir -p ./storage/tracker/etc/ cp ./share/default/config/tracker.development.sqlite3.toml ./storage/tracker/etc/tracker.toml

Customize the tracker configuration (for example):

vim ./storage/tracker/etc/tracker.toml

Run the tracker with the updated configuration:

TORRUSTTRACKERPATH_CONFIG="./storage/tracker/etc/tracker.toml" cargo run ```

Optionally, you may choose to supply the entire configuration as an environmental variable:

```sh

Use a configuration supplied on an environmental variable:

TORRUSTTRACKERCONFIG=$(cat "./storage/tracker/etc/tracker.toml") cargo run ```

For deployment you should override the api_admin_token by using an environmental variable:

```sh

Generate a Secret Token:

gpg --armor --gen-random 1 10 | tee ./storage/tracker/lib/trackerapiadmintoken.secret chmod go-rwx ./storage/tracker/lib/trackerapiadmintoken.secret

Override secret in configuration using an environmental variable:

TORRUSTTRACKERCONFIG=$(cat "./storage/tracker/etc/tracker.toml") \ TORRUSTTRACKERAPIADMINTOKEN=$(cat "./storage/tracker/lib/trackerapiadmin_token.secret") \ cargo run ```

Please view our crate documentation for more detailed instructions.

Services

The following services are provided by the default configuration:

• UDP (tracker)
  • udp://127.0.0.1:6969/announce.
• HTTP (tracker)
  • http://127.0.0.1:6969/announce.
• API (management)
  • http://127.0.0.1:1212/api/v1/stats?token=MyAccessToken.

Documentation

• Management API (Version 1)
• Tracker (HTTP/TLS)
• Tracker (UDP)

Contributing

This is an open-source community supported project.
We welcome contributions from the community!

How can you contribute?

• Bug reports and feature requests.
• Code contributions. You can start by looking at the issues labeled "[good first issues]".
• Documentation improvements. Check the [documentation] and [API documentation] for typos, errors, or missing information.
• Participation in the community. You can help by answering questions in the [discussions].

License

The project is licensed under a dual license. See [COPYRIGHT].

Acknowledgments

This project was a joint effort by Nautilus Cyberneering GmbH and [Dutch Bits]. Also thanks to [Naim A.] and [greatest-ape] for some parts of the code. Further added features and functions thanks to [Power2All].