Torrust Tracker

Project Description

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

Features

• [X] Multiple UDP server and HTTP(S) server blocks for socket binding possible
• [X] Full IPv4 and IPv6 support for both UDP and HTTP(S)
• [X] Private & Whitelisted mode
• [X] Built-in API
• [X] Torrent whitelisting
• [X] Peer authentication using time-bound keys
• [X] newTrackon check supported for both HTTP, UDP, where IPv4 and IPv6 is properly handled
• [X] SQLite3 Persistent loading and saving of the torrent hashes and completed count
• [X] MySQL support added as engine option
• [X] Periodically saving added, interval can be configured

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. bash git clone https://github.com/torrust/torrust-tracker.git cd torrust-tracker

2. Build the source code. bash cargo build --release

Usage

• Run the torrust-tracker once to create the config.toml file: bash ./target/release/torrust-tracker

• Edit the newly created config.toml file according to your liking, see configuration documentation. Eg: ```toml loglevel = "info" mode = "public" dbdriver = "Sqlite3" dbpath = "data.db" announceinterval = 120 minannounceinterval = 120 maxpeertimeout = 900 onreverseproxy = false externalip = "0.0.0.0" trackerusagestatistics = true persistenttorrentcompletedstat = false inactivepeercleanupinterval = 600 removepeerless_torrents = true

[[udptrackers]] enabled = false bindaddress = "0.0.0.0:6969"

[[httptrackers]] enabled = true bindaddress = "0.0.0.0:7070" sslenabled = false sslcertpath = "" sslkey_path = ""

[httpapi] enabled = true bindaddress = "127.0.0.1:1212"

[httpapi.accesstokens] admin = "MyAccessToken" ```

• Run the torrust-tracker again: bash ./target/release/torrust-tracker

Tracker URL

Your tracker announce URL will be udp://{tracker-ip:port} and/or http://{tracker-ip:port}/announce and/or https://{tracker-ip:port}/announce depending on your bindings. 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. Further added features and functions thanks to Power2All.