tracker/README.md
Jimmy Zelinskie dfcc04b38b readme: basic getting started
[skip ci]
2016-03-05 11:09:35 -05:00

2.3 KiB

Chihaya

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

Chihaya is an open source BitTorrent tracker written in Go.

Differentiating features include:

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

Getting Started

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

$ go get github.com/chihaya/chihaya
$ go install github.com/chihaya/chihaya/cmd/chihaya

Development

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.

  • 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.