A tracker for the LBRY protocol.

Find a file

Jimmy Zelinskie 81b1e4aa4d initial mock tracker storage		2013-11-27 03:51:19 -05:00
config	go fmt [ci skip]	2013-11-24 00:49:20 -05:00
server	go fmt [ci skip]	2013-11-24 00:49:20 -05:00
storage	initial mock tracker storage	2013-11-27 03:51:19 -05:00
.travis.yml	generic test config	2013-08-29 00:47:37 -04:00
AUTHORS	initial	2013-06-21 19:31:32 -04:00
CONTRIBUTORS	initial	2013-06-21 19:31:32 -04:00
LICENSE	initial	2013-06-21 19:31:32 -04:00
main.go	web package renamed backend	2013-10-21 03:29:35 -04:00
README.md	remove references to "cache" from readme [ci skip]	2013-11-24 00:00:30 -05: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 not be used in production.

Planned features include:

Light resource consumption
Fast request processing, sparing the network from exorbitant connection counts
Maximum compatibility with what exists of the BitTorrent spec
Correct IPv6 support
Generic storage interfaces that are easily adapted to work with any existing web application
Scaling properties that directly correlate with those of the chosen data stores

Technical Details

See the wiki for a discussion of the design behind Chihaya.

Using Chihaya

Chihaya is intended to work with existing torrent indexing web frameworks, such as Batter and Gazelle. Following the Unix way, it is built to perform a specific task, and interface with any system that needs its functionality. See below for more info.

Installing

Make sure you have your $GOROOT and $GOPATH set up correctly, and have your $GOBIN in your $PATH.

$ go install github.com/pushrax/chihaya

Configuring

Configuration is done in a JSON formatted file specified with the -config flag. An example configuration file can be found here.

Running the tests

The tests require a running redis server to function correctly, and a config to use for the tests. The $TESTCONFIGPATH environment variable is required for the tests to function:

$ cd $GOPATH/src/github.com/pushrax/chihaya
$ export TESTCONFIGPATH=$GOPATH/src/github.com/pushrax/chihaya/config/example.json
$ go test -v ./...

Drivers

Chihaya is designed to remain agnostic about the choice of data store for an application, and it is straightforward to implement a new driver. However, there are a number of drivers that plan to be directly supported:

Tracker:

redis
memory

Backend:

Contributing

If you're interested in contributing, please contact us via IRC in #chihaya on freenode or post to the GitHub issue tracker. Please don't write massive patches with no prior communication, as it will most likely lead to confusion and time wasted for everyone. However, small unannounced fixes are always welcome!

And remember: good gophers always use gofmt!