A tracker for the LBRY protocol.
Find a file
2015-10-11 19:23:30 -04:00
api pull API server out of http 2015-10-11 19:23:30 -04:00
backend backend: add a Ping method to backend 2015-02-08 17:14:48 -05:00
cmd/chihaya 2015 2015-01-01 12:02:25 -05:00
config add api to config & propogate config changes 2015-10-11 19:23:30 -04:00
Godeps Remove godep sources from the repository 2015-06-18 20:11:44 -04:00
http pull API server out of http 2015-10-11 19:23:30 -04:00
stats stats: rename PauseNS to LatestPauseNS 2015-08-20 15:06:57 -04:00
tracker config: make reaping configurable 2015-09-18 01:27:27 -04:00
udp add api to config & propogate config changes 2015-10-11 19:23:30 -04:00
.gitignore Use godep restore to set up dependencies 2015-06-18 20:16:24 -04:00
.travis.yml travis: update to Go 1.5 2015-08-19 13:49:03 -04:00
AUTHORS Reflect change in sorting in the descriptions 2014-07-06 23:58:34 -04:00
chihaya.go add API to Boot() and clean things up 2015-10-11 19:23:30 -04:00
CONFIGURATION.md docs: Break out config docs into a separate file 2015-03-24 00:38:20 -04:00
CONTRIBUTING.md docs: update primary branch to be master 2015-06-26 23:00:25 -04:00
debug.go chihaya: add copyright header to debug.go 2015-09-13 00:09:45 -04:00
Dockerfile dockerfile: Fix Dockerfile to build with the latest changes 2015-06-30 22:33:20 -04:00
example_config.json add api to config & propogate config changes 2015-10-11 19:23:30 -04:00
LICENSE 2015 2015-01-01 12:02:25 -05:00
README.md travis: update to Go 1.5 2015-08-19 13:49:03 -04:00

Chihaya

GoDoc License Build Status Docker Repository on Quay.io

Chihaya is a high-performance BitTorrent tracker written in the Go programming language. It is still heavily under development and the current master branch should probably not be used in production (unless you know what you're doing).

Features include:

  • Public tracker feature-set with full compatibility with what exists of the BitTorrent spec
  • Private tracker feature-set with compatibility for a Gazelle-like deployment (WIP)
  • Low resource consumption, and fast, asynchronous request processing
  • Full IPv6 support, including handling for dual-stacked peers
  • Extensive metrics for visibility into the tracker and swarm's performance
  • Ability to prioritize peers in local subnets to reduce backbone contention
  • Pluggable backend driver that can coordinate with an external database

When would I use Chihaya?

Chihaya is a meant for every kind of BitTorrent tracker deployment. Chihaya has been used to replace instances of opentracker and also instances of ocelot. Chihaya handles torrent announces and scrapes in memory, but using a backend driver, can also asynchronously provide deltas to maintain a set of persistent data without throttling a database (this most useful for private tracker use-cases).

Building & Installing

Chihaya requires Go 1.4+ (preferrably the latest stable Go), Godep, and a Go environment previously set up.

$ export GOPATH=$PWD/chihaya
$ git clone https://github.com/chihaya/chihaya.git chihaya/src/github.com/chihaya/chihaya
$ cd chihaya/src/github.com/chihaya/chihaya/cmd/chihaya/
$ godep restore
$ go install github.com/chihaya/chihaya/cmd/chihaya

Testing

Chihaya has end-to-end test coverage for announces in addition to unit tests for isolated components. To run the tests, use:

$ cd $GOPATH/src/github.com/chihaya/chihaya
$ godep go test -v ./...

There is also a set of benchmarks for performance-critical sections of Chihaya. These can be run similarly:

$ cd $GOPATH/src/github.com/chihaya/chihaya
$ godep go test -v ./... -bench .

Configuration

Copy example_config.json to your choice of location, and update the values as required. An explanation of the available keys can be found in CONFIGURATION.md.