tracker/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 probably not be used in production unless you know what you're doing.

Features include:

• Low resource consumption, and fast, asynchronous request processing
• Full IPv6 support, including handling for dual-stacked peers
• Generic storage interfaces that are easily adapted to work with any database
• Full compatibility with what exists of the BitTorrent spec
• Extensive metrics for visibility into the tracker and swarm's performance
• Ability to group peers in local subnets to reduce backbone contention

Using Chihaya

Chihaya can be ran as a public or private tracker and is intended to coordinate with existing torrent-indexing web frameworks, such as Gazelle, Batter and any others that spring up. Following the Unix way, it is built to perform one specific task: handling announces and scrapes. By cleanly separating the concerns between tracker and database, we can provide an interface that can be used by system that needs its functionality.

Installing

Chihaya requires Go 1.3+ to build. To install the Chihaya server, run:

$ go get github.com/chihaya/chihaya/cmd/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.

Drivers

Chihaya is designed to remain agnostic about the choice of data storage. Out of the box, we provide only the necessary drivers to run Chihaya in public mode ("memory" for tracker and "noop" for backend). If you're interested in creating a new driver, check out the section on customizing chihaya.

Developing Chihaya

Testing

Chihaya has end-to-end test coverage for announces in addition to unit tests for isolated components. To run the tests, use:

$ cd $GOPATH/src/github.com/chihaya/chihaya
$ go test -v ./...

There is also a set of benchmarks for performance-critical sections of Chihaya. These can be run similarly:

$ cd $GOPATH/src/github.com/chihaya/chihaya
$ go test -v ./... -bench .

Customizing Chihaya

If you require more than the drivers provided out-of-the-box, you are free to create your own and then produce your own custom Chihaya binary. To create this binary, simply create your own main package, import your custom drivers, then call chihaya.Boot from main.

Example

package main

import (
	"github.com/chihaya/chihaya"

	_ "github.com/yourusername/chihaya-custom-backend" // Import any of your own drivers.
)

func main() {
	chihaya.Boot() // Start Chihaya normally.
}

Tracker Drivers

The tracker package contains 3 interfaces that are heavily inspired by the standard library's database/sql package. To write a new driver that will provide a storage mechanism for the fast moving data within the tracker, create your own new Go package that has an implementation of the tracker.Driver, tracker.Pool, and tracker.Conn interfaces. Within that package, you must also define an init() that calls tracker.Register registering your new driver. A great place to start is the documentation and source code of the memory driver to understand thread safety and basic driver design.

Backend Drivers

The backend package is meant to provide announce deltas to a slower and more consistent database, such as the one powering a torrent-indexing website. Implementing a backend driver is very similar to implementing a tracker driver: simply create a package that implements the backend.Driver and backend.Conn interfaces and calls backend.Register in it's init(). Please note that backend.Conn must be thread-safe.

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!