bencode | ||
config | ||
drivers | ||
http | ||
models | ||
.travis.yml | ||
AUTHORS | ||
CONTRIBUTORS | ||
example.json | ||
LICENSE | ||
main.go | ||
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
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:
- mock (memory)
- redis
Backend:
- mock (memory)
- gazelle (mysql)
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!