LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity
tracker/README.md
Jimmy Zelinskie 130e186006 readme: fix broken build status badge 
The link and image source were reversed by accident.
2020-02-20 13:13:38 -05:00

3.9 KiB
Raw Blame History

Chihaya

Build Status Docker Repository on Quay.io Go Report Card GoDoc Lines of Code 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:

  • HTTP and UDP protocols
  • IPv4 and IPv6 support
  • Pre/Post middlware hooks
  • YAML configuration
  • Metrics via Prometheus
  • High Availability via Redis
  • Kubernetes deployment via Helm

Why Chihaya?

Chihaya is built for developers looking to integrate BitTorrent into a preexisting production environment. Chihaya's pluggable architecture and middleware framework offers a simple and flexible integration point that abstracts the BitTorrent tracker protocols. The most common use case for Chihaya is enabling peer-to-peer cloud software deployments.

Development

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.

Getting Started

Building from HEAD

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

$ git clone git@github.com:chihaya/chihaya.git
$ cd chihaya
$ go build ./cmd/chihaya
$ ./chihaya --help

Docker

Docker containers are available for HEAD and stable releases.

Testing

The following will run all tests and benchmarks. Removing -bench will just run unit tests.

$ go test -bench $(go list ./...)

The Chihaya executable contains a command to end-to-end test a BitTorrent tracker. See

$ chihaya --help

Configuration

Configuration of Chihaya is done via one YAML configuration file. The dist/ directory contains an example configuration file. Files and directories under docs/ contain detailed information about configuring middleware, storage implementations, architecture etc.

Related projects

  • BitTorrent.org: a static website containing the BitTorrent spec and all BEPs
  • OpenTracker: a popular BitTorrent tracker written in C
  • Ocelot: a private BitTorrent tracker written in C++