LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity
A tracker for the LBRY protocol.
163 commits 12 branches 6 tags 3.9 MiB
Go 99.7%
Dockerfile 0.3%
Find a file
Jimmy Zelinskie 9e94643379 implemented some API funcs, added whitelist API
2014-07-07 22:23:01 -04:00
config Happy uber-belated new year! ✨ 2014-07-06 17:56:54 -04:00
drivers Happy uber-belated new year! ✨ 2014-07-06 17:56:54 -04:00
http implemented some API funcs, added whitelist API 2014-07-07 22:23:01 -04:00
models Add missing quotation mark in struct tag 2014-07-07 00:09:20 -04:00
.travis.yml update travis to go1.3 & rm redis dependency 2014-06-19 12:35:24 -04:00
AUTHORS Reflect change in sorting in the descriptions 2014-07-06 23:58:34 -04:00
CONTRIBUTORS Reflect change in sorting in the descriptions 2014-07-06 23:58:34 -04:00
example.json transition to httprouter 2014-07-01 21:40:29 -04:00
LICENSE Happy uber-belated new year! ✨ 2014-07-06 17:56:54 -04:00
main.go Happy uber-belated new year! ✨ 2014-07-06 17:56:54 -04:00
README.md Use new Travis badge URL 2014-07-06 18:08:55 -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

Chihaya requires Go 1.3+ to build.

$ go get github.com/chihaya/chihaya

Make sure you have your $GOPATH set up correctly, and have $GOPATH/bin in your $PATH. If you're new to Go, an overview of the directory structure can be found here.

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

$ cd $GOPATH/src/github.com/chihaya/chihaya
$ 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 will be directly supported:

Tracker:

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!