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 3: The BitTorrent Protocol
• BEP 7: IPv6 Support
• 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

Usage

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

./target/release/torrust-tracker

• Edit the newly created config.toml file according to your liking, see configuration documentation. Eg:

log_level = "trace"
mode = "public"
db_path = "data.db"
cleanup_interval = 600
external_ip = "YOUR_EXTERNAL_IP"

[udp_tracker]
bind_address = "0.0.0.0:6969"
announce_interval = 120

[http_tracker]
enabled = true
bind_address = "0.0.0.0:6969"
on_reverse_proxy = false
announce_interval = 120
ssl_enabled = false
ssl_cert_path = ""
ssl_key_path = ""

[http_api]
enabled = true
bind_address = "127.0.0.1:1212"

[http_api.access_tokens]
admin = "MyAccessToken"

• Run the torrust-tracker again:

./target/release/torrust-tracker

Tracker URL

Your tracker announce URL will be udp://{tracker-ip:port} or https://{tracker-ip:port}/announce depending on your tracker mode. In private & private_listed mode, tracker keys are added after the tracker URL like: https://{tracker-ip:port}/announce/{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.