README
¶
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 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!
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cache provides a generic interface for manipulating a BitTorrent tracker's fast moving data.
|
Package cache provides a generic interface for manipulating a BitTorrent tracker's fast moving data. |
|
redis
Package redis implements the storage interface for a BitTorrent tracker.
|
Package redis implements the storage interface for a BitTorrent tracker. |
|
Package config implements the configuration for a BitTorrent tracker
|
Package config implements the configuration for a BitTorrent tracker |
|
Package server implements a BitTorrent tracker
|
Package server implements a BitTorrent tracker |
|
Package storage provides a generic interface for manipulating a BitTorrent tracker's web application data.
|
Package storage provides a generic interface for manipulating a BitTorrent tracker's web application data. |
|
batter
Package batter provides a driver for a BitTorrent tracker to interface with the postgres database used by batter (github.com/wafflesfm/batter).
|
Package batter provides a driver for a BitTorrent tracker to interface with the postgres database used by batter (github.com/wafflesfm/batter). |
|
gazelle
Package gazelle provides a driver for a BitTorrent tracker to interface with the MySQL database used by Gazelle (github.com/WhatCD/Gazelle).
|
Package gazelle provides a driver for a BitTorrent tracker to interface with the MySQL database used by Gazelle (github.com/WhatCD/Gazelle). |