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 probably not be used in production
(unless you know what you're doing).
Features include:
- Public tracker feature-set with full compatibility with what exists of the BitTorrent spec
- Private tracker feature-set with compatibility for a Gazelle-like deployment (WIP)
- Low resource consumption, and fast, asynchronous request processing
- Full IPv6 support, including handling for dual-stacked peers
- Extensive metrics for visibility into the tracker and swarm's performance
- Ability to prioritize peers in local subnets to reduce backbone contention
- Pluggable backend driver that can coordinate with an external database
When would I use Chihaya?
Chihaya is a meant for every kind of BitTorrent tracker deployment. Chihaya has been used to replace instances of opentracker and also instances of ocelot. Chihaya handles torrent announces and scrapes in memory, but using a backend driver, can also asynchronously provide deltas to maintain a set of persistent data without throttling a database (this most useful for private tracker use-cases).
Building & Installing
Chihaya requires 64-bit Go 1.4, Godep, and a Go environment previously set up.
$ export GOPATH=$PWD/chihaya
$ git clone https://github.com/chihaya/chihaya.git chihaya/src/github.com/chihaya/chihaya
$ cd chihaya/src/github.com/chihaya/chihaya/cmd/chihaya/
$ godep restore
$ godep go install github.com/chihaya/chihaya/cmd/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
$ godep 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
$ godep go test -v ./... -bench .
Configuration
Copy example_config.json
to your choice of location, and update the values as required.
An explanation of the available keys can be found in CONFIGURATION.md.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package backend provides a generic interface for manipulating a BitTorrent tracker's consistent backend data store (usually for a web application).
|
Package backend provides a generic interface for manipulating a BitTorrent tracker's consistent backend data store (usually for a web application). |
|
noop
Package noop implements a Chihaya backend storage driver as a no-op.
|
Package noop implements a Chihaya backend storage driver as a no-op. |
|
cmd
|
|
|
Package config implements the configuration for a BitTorrent tracker
|
Package config implements the configuration for a BitTorrent tracker |
|
Package http implements an http-serving BitTorrent tracker.
|
Package http implements an http-serving BitTorrent tracker. |
|
query
Package query implements a faster single-purpose URL Query parser.
|
Package query implements a faster single-purpose URL Query parser. |
|
Package stats implements a means of tracking processing statistics for a BitTorrent tracker.
|
Package stats implements a means of tracking processing statistics for a BitTorrent tracker. |
|
Package tracker provides a generic interface for manipulating a BitTorrent tracker's fast-moving data.
|
Package tracker provides a generic interface for manipulating a BitTorrent tracker's fast-moving data. |
|
models
Package models implements the common data types used throughout a BitTorrent tracker.
|
Package models implements the common data types used throughout a BitTorrent tracker. |
|
Package udp implements a UDP BitTorrent tracker per BEP 15.
|
Package udp implements a UDP BitTorrent tracker per BEP 15. |