A tracker for the LBRY protocol.

Find a file

Justin Li eefbe64da6 docs: Break out config docs into a separate file		2015-03-24 00:38:20 -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	config: add create_on_announce option	2015-03-23 20:02:13 -04:00
Godeps	godeps: strip import comments	2015-02-08 17:19:10 -05:00
http	lint: Http -> HTTP	2015-03-23 19:57:45 -04:00
stats	2015 ✨	2015-01-01 12:02:25 -05:00
tracker	tracker: fix reference to config	2015-03-23 20:43:33 -04:00
.travis.yml	travis: set sudo=false	2015-02-09 19:24:01 -05:00
AUTHORS	Reflect change in sorting in the descriptions	2014-07-06 23:58:34 -04:00
chihaya.go	2015 ✨	2015-01-01 12:02:25 -05:00
CONFIGURATION.md	docs: Break out config docs into a separate file	2015-03-24 00:38:20 -04:00
CONTRIBUTING.md	docs: target for changes is develop, not master	2015-02-08 17:13:39 -05:00
Dockerfile	dockerfile: initial	2015-03-19 23:39:31 -04:00
example_config.json	config: add create_on_announce option	2015-03-23 20:02:13 -04:00
LICENSE	2015 ✨	2015-01-01 12:02:25 -05:00
README.md	docs: Break out config docs into a separate file	2015-03-24 00:38:20 -04:00

README.md

Chihaya

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 64-bit Go 1.4, Godep, and a Go environment previously set up.

$ export GOPATH=$PWD/chihaya
$ git clone github.com/chihaya/chihaya chihaya/src/github.com/chihaya/chihaya
$ godep go install chihaya/src/github.com/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.