LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity
A tracker for the LBRY protocol.
82 commits 12 branches 6 tags 3.9 MiB
Go 99.7%
Dockerfile 0.3%
Find a file
cpb8010 2dd810d2ee Fixes & format changes from pull request comments
2013-09-24 23:10:48 -04:00
cache Fixes & format changes from pull request comments 2013-09-24 23:10:48 -04:00
config Set up initial outbound synchronization structure 2013-09-06 18:39:14 -04:00
models Fixes & format changes from pull request comments 2013-09-24 23:10:48 -04:00
server Completed cache.Tx tests and added benchmarks 2013-09-22 21:23:37 -04:00
storage Add interface for loading data from storage 2013-09-06 21:38:56 -04: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 Make the batter driver follow the updated storage interface 2013-09-06 19:13:44 -04:00
README.md Add note about running a redis server for the tests 2013-09-06 18:34:56 -04:00

README.md

Chihaya Build Status

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 get 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
$ 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 directly supported drivers:

Cache:

  • redis — allows for multiple tracker instances to run at the same time for the same swarm
  • memory — only a single instance can run, but it requires no extra setup

Storage:

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!