btracker/README.md
2025-08-07 16:19:28 +03:00

2.5 KiB

btracker

Linux Dependencies crates.io

βtracker is a BitTorrent aggregator based on the aquatic-crawler API and Rocket web-framework

btracker

Roadmap

  • RSS feeds
  • Torrents listing
    • Basic metainfo
    • Pagination
    • Search filter
    • Results order
  • Torrent details page
    • Files list
    • Background image (from the files asset)
  • Common features
    • Scrape peers/seeders/leechers
      • UDP
      • TCP
    • Download
      • Magnet
      • Torrent

Install

  1. git clone https://github.com/yggverse/btracker.git && cd btracker
  2. cargo build --release
  3. sudo install target/release/btracker /usr/local/bin/btracker

Usage

btracker --preload=/path/to/aquatic-crawler/preload\
         --scrape=udp://127.0.0.1:6969\
         --tracker=udp://[302:68d0:f0d5:b88d::fdb]:6969\
         --tracker=udp://tracker.ygg:6969
  • The --preload argument specifies the location of the crawled torrents (see aquatic-crawler)
  • The --scrape argument is optional and enables statistics for peers, seeders, and leechers
    • it is recommended to use the local address for faster performance
    • this argument supports multiple definitions for both the IPv4 and IPv6 protocols, parsed from the URL value
    • take a look at the --udp option if you want to customize the default binding for UDP scrapes
  • Define as many --tracker(s) as required
  • Append RUST_LOG=debug for detailed information output; use --debug to configure as rocket::Config::debug_default()
  • See the project Wiki for more details (including systemd and nginx examples)

Options

btracker --help

Live