README

Chihaya

GoDoc License Build Status Docker Repository on Quay.io

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).

Current features include:

  • Public tracker feature-set with full compatibility with what exists of the BitTorrent spec
  • 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
  • JWT Validation to approve the usage of a given infohash.

Planned features include:

  • Private tracker feature-set with compatibility for a Gazelle-like deployment (WIP)

When would I use Chihaya?

Chihaya is a eventually 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. However, using a backend driver, Chihaya can also asynchronously provide deltas to maintain a set of persistent data without throttling a database. This is particularly useful behavior for private tracker use-cases.

Running Chihaya

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.

Docker
# Download and edit the example config
curl -L https://raw.githubusercontent.com/chihaya/chihaya/release-v1.0/example_config.json -o config.json
vi config.json

# Run the container with the config file mounted
docker run -p 6880-6882:6880-6882 -v $PWD/config.json:/config.json:ro quay.io/jzelinskie/chihaya:v1.0.1 -v=5

Developing Chihaya

Building & Installing

Chihaya requires Go 1.5+ (preferrably the latest stable Go), 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
$ 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 .
Contributing

See CONTRIBUTING.md for guidelines to contributing to the project. Feel free to make issues or ask questions. Our maintainers are also always idle in #chihaya on freenode.

Documentation

Overview

    Package chihaya implements the ability to boot the Chihaya BitTorrent tracker with your own imports that can dynamically register additional functionality.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func Boot

    func Boot()

      Boot starts Chihaya. By exporting this function, anyone can import their own custom drivers into their own package main and then call chihaya.Boot.

      Types

      This section is empty.

      Directories

      Path Synopsis
      Package api implements a RESTful HTTP JSON API server for a BitTorrent tracker.
      Package api implements a RESTful HTTP JSON API server for a BitTorrent tracker.
      cmd
      Package config implements the configuration for a BitTorrent tracker
      Package config implements the configuration for a BitTorrent tracker
      Package http implements a BitTorrent tracker over the HTTP protocol as per BEP 3.
      Package http implements a BitTorrent tracker over the HTTP protocol as per BEP 3.
      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 BitTorrent tracker over the UDP protocol as per BEP 15.
      Package udp implements a BitTorrent tracker over the UDP protocol as per BEP 15.