Torrust Tracker

Project Description

Torrust Tracker is a lightweight but incredibly powerful and feature-rich BitTorrent tracker made using Rust.

Features

• UDP server
• HTTP (optional SSL) server
• Private & Whitelisted mode
• Built-in API
• Torrent whitelisting
• Peer authentication using time-bound keys

Implemented BEPs

• BEP 15: UDP Tracker Protocol for BitTorrent
• BEP 23: Tracker Returns Compact Peer Lists
• BEP 27: Private Torrents
• BEP 41: UDP Tracker Protocol Extensions
• BEP 48: Tracker Protocol Extension: Scrape

Getting Started

You can get the latest binaries from releases or follow the install from scratch instructions below.

Install From Scratch

1. Clone the repo.

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

2. Build the source code.

cargo build --release

3. Copy binaries: torrust-tracker/target/torrust-tracker to a new folder.

Usage

1. Navigate to the folder you put the torrust-tracker binaries in.

2. Run the torrust-tracker once to create the config.toml file:

./torrust-tracker

3. Edit the newly created config.toml file in the same folder as your torrust-tracker binaries according to your liking. See configuration documentation.

4. Run the torrust-tracker again:

./torrust-tracker

Tracker URL

Your tracker will be udp://tracker-ip:port/announce or https://tracker-ip:port/announce depending on your tracker mode. In private mode, tracker keys are added after the tracker URL like: https://tracker-ip:port/announce/tracker-key.

Built-in API

Read the API documentation here.

Credits

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.