tracker

Installation

We have made the installation of the Tracker as easy and flexible as possible, offering multiple ways to set ip up. You can either compile from sources or use pre-built container images. For cloud deployments, we provide simple solutions to deploy the tracker across various hosting providers, wether you're using virtual machines or containers. Additionally, we've deployed a public tracker on cloud service (Digital Ocean) to gather feedback and ensure the application is production-ready. Out goal is to help system administrators by offering:

• Simple backup of the database and app configurations.
• Easy access to logs to monitor for errors.
• Quick access to running services.
• Automatic health checks to monitor services.

The application also allows configuration through TOML files or environment variables. We’ve focused on providing clear and actionable error messages to help admins quickly resolve any issues.

Software requirements

• Rust Stable 1.68 if you're compiling from source.
• SQLite 3 or MySQL 8.0. (only if persistence is enabled) .
• Some system dependencies. In Linux: pkg-config, make, libssl-dev, libsqlite3-dev.

For more detailed installation requirements, refer to the latest documentation for more details about installation and requirements.

Build from sources

Building the Rust app from source is simple using cargo.

git clone https://github.com/torrust/torrust-tracker.git \
  && cd torrust-tracker \
  && cargo build --release \
  && mkdir -p ./storage/tracker/lib/database \
  && mkdir -p ./storage/tracker/lib/tls

Once built, you can run it with:

Run with docker

You can use docker or podman to run the containerized application:

cd /tmp \
  && mkdir torrust-tracker \
  && cd torrust-tracker \
  && export USER_ID=1000 \
  && docker run -it \
    --env USER_ID="$USER_ID" \
    --publish 3001:3001/tcp \
    --volume "$(pwd)/storage/tracker/lib":"/var/lib/torrust/tracker" \
    --volume "$(pwd)/storage/tracker/log":"/var/log/torrust/tracker" \
    --volume "$(pwd)/storage/tracker/etc":"/etc/torrust/tracker" \
    torrust/tracker:develop

Please refer to the official documentation to learn more about running the index with docker.

Roadmap

The vision of Torrust is to provide a robust set of tools for the BitTorrent ecosystem. We recognize that this is a long-term effort, and we’ve planned ahead. Here’s a summary of what we’re working on:

You can participate in defining the future of Torrust. Join our public discussions on GitHub.

• Core
• New argument in announce requests: want_ip_from_query_string.
• Peer and torrents specific statistics
• Persistence
• Support other databases like PostgreSQL
• Performance
• More optimizations
• Protocols
• Webtorrent
• Integrations
• Monitoring (Prometheus)
• Utils
• Tracker checker
• Tracker client (an unified console client for the UDP and HTTP tracker clients)

License

We aim to make this software as accessible and widely used as possible.

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see www.gnu.org/licenses. Some files include explicit copyright notices and/or license notices.

Legacy Exception

For prosperity, versions of Torrust Tracker that are older than five years are automatically granted the MIT-0 license in addition to the existing AGPL-3.0-only license.