tracker/README.md
2016-04-02 19:35:04 -04:00

3.5 KiB

Chihaya

Build Status Docker Repository on Quay.io GoDoc License IRC Channel

Note: The master branch may be in an unstable or even broken state during development. Please use releases instead of the master branch in order to get stable binaries.

Chihaya is an open source BitTorrent tracker written in Go.

Differentiating features include:

  • Protocol-agnostic, middleware-composed logic
  • Low resource consumption and fast, asynchronous request processing
  • Unified IPv4 and IPv6 swarms
  • YAML configuration
  • Optional metrics via Prometheus

Development

Getting Started

In order to compile the project, the latest stable version of Go and a working Go environment are required.

$ go get -t -u github.com/chihaya/chihaya
$ go install github.com/chihaya/chihaya/cmd/chihaya

Contributing

Long-term discussion and bug reports are maintained via GitHub Issues. Code review is done via GitHub Pull Requests. Real-time discussion is done via freenode IRC.

For more information read CONTRIBUTING.md.

Production Use

Facebook

Facebook uses BitTorrent to deploy new versions of their software. In order to optimize the flow of traffic within their datacenters, Chihaya is configured to prefer peers within the same subnet. Because Facebook organizes their network such that server racks are allocated IP addresses in the same subnet, the vast majority of deployment traffic never impacts the congested areas of their network.

CoreOS

Quay is a container registry that offers the ability to download containers via BitTorrent in order to speed up large or geographically distant deployments. Announce URLs from Quay's torrent files contain a JWT in order to allow Chihaya to verify that an infohash was approved by the registry. By verifying the infohash, Quay can be sure that only their content is being shared by their tracker.

  • OpenTracker: a popular BitTorrent tracker written in C
  • Ocelot: a private BitTorrent tracker written in C++

License

Chihaya is distributed under the 2-Clause BSD license that can be found in the LICENSE file.