A tracker for the LBRY protocol.

Find a file

Jimmy Zelinskie 7df0145118 readme: refresh info, add graphviz architecture		2019-02-12 19:29:55 -05:00
bittorrent	bittorrent: anonymous fields for IPs in test table	2018-06-15 13:33:26 -04:00
cmd/chihaya	Add Support for Redis Storage Backend(To Achieve Chihaya High Availability)	2019-01-03 17:21:13 +08:00
dist	Add config to enable keepalive/persistent connections	2018-09-09 09:01:53 -04:00
docs	readme: refresh info, add graphviz architecture	2019-02-12 19:29:55 -05:00
frontend	split listen&serve for http	2018-12-30 13:36:32 +03:00
middleware	fix goimports error	2018-12-17 16:59:44 +08:00
pkg	Fix goimports violations	2018-10-24 09:25:03 -04:00
storage	storage/redis: add exiting info	2019-01-28 15:18:21 +08:00
.travis.yml	enable -race flag in tests	2018-12-30 00:50:54 +03:00
CONTRIBUTING.md	readme: add CONTRIBUTING.md	2016-03-30 01:21:53 -04:00
Dockerfile	dockerfile: add CA certificates	2018-09-24 14:04:12 -04:00
example_config.yaml	Add storage redis configuration example	2019-01-22 19:36:27 +08:00
Gopkg.lock	dep ensure udpate	2019-01-04 13:58:20 +08:00
Gopkg.toml	dep ensure udpate	2019-01-04 13:58:20 +08:00
LICENSE	Bring in more old behaviour, use types for peer_id and infohash	2016-03-02 21:05:31 -05:00
MAINTAINERS	add leo to maintainers	2016-08-16 22:17:10 -04:00
README.md	readme: refresh info, add graphviz architecture	2019-02-12 19:29:55 -05:00

README.md

Chihaya

Note: The master branch may be in an unstable or even broken state during development. Please use releases instead of the master branch in order to get stable binaries.

Chihaya is an open source BitTorrent tracker written in Go.

Differentiating features include:

HTTP and UDP protocols
IPv4 and IPv6 support
Pre/Post middlware hooks
YAML configuration
Metrics via Prometheus
High Availability via Redis
Kubernetes deployment via Helm

Why Chihaya?

Chihaya is built for developers looking to integrate BitTorrent into a preexisting production environment. Chihaya's pluggable architecture and middleware framework offers a simple and flexible integration point that abstracts the BitTorrent tracker protocols. The most common use case for Chihaya is enabling peer-to-peer cloud software deployments.

Production Use

Facebook

Facebook uses BitTorrent to deploy new versions of their software. In order to optimize the flow of traffic within their datacenters, Facebook uses an alternative Storage driver for Chihaya that is configured to prefer peers within the same subnet. Because Facebook organizes their network such that server racks are allocated IP addresses in the same subnet, the vast majority of deployment traffic never impacts the congested areas of their network.

Red Hat

Quay is a container registry that offers the ability to download containers via BitTorrent in order to speed up large or geographically distant deployments. Announce URLs from Quay's torrent files contain a JWT in order to allow Chihaya to verify that an infohash was approved by the registry. By verifying the infohash, Quay can restrict their tracker to only sharing their own content.

Development

Contributing

Long-term discussion and bug reports are maintained via GitHub Issues. Code review is done via GitHub Pull Requests. Real-time discussion is done via freenode IRC.

For more information read CONTRIBUTING.md.

Getting Started

Building from HEAD

In order to compile the project, the latest stable version of Go and knowledge of a working Go environment are required.

NOTE: Building in this fashion will download the latest version of all dependencies, which may have introduced breaking changes. To produce a build with safe versions of dependencies, follow the instructions for reproducible builds.

$ mkdir chihaya && export GOPATH=$PWD/chihaya
$ go get -t -u github.com/chihaya/chihaya/...
$ $GOPATH/bin/chihaya --help

Reproducible Builds

Reproducible builds are handled by using dep to vendor dependencies.

$ mkdir chihaya && export GOPATH=$PWD/chihaya
$ git clone git@github.com:chihaya/chihaya.git $GOPATH/src/github.com/chihaya/chihaya
$ cd $GOPATH/src/github.com/chihaya/chihaya
$ dep ensure
$ go install github.com/chihaya/chihaya/cmd/...
$ $GOPATH/bin/chihaya --help

Docker

Docker containers are available for HEAD and stable releases.

Testing

The following will run all tests and benchmarks. Removing -bench will just run unit tests.

$ go test -bench $(go list ./...)

Architecture

BitTorrent clients send Announce and Scrape requests to a Frontend. Frontends parse requests and write responses for the particular protocol they implement. The TrackerLogic interface to is used to generate responses for their requests and optionally perform a task after responding to a client. A configurable chain of PreHook and PostHook middleware is used to construct an instance of TrackerLogic. PreHooks are middleware that are executed before the response has been written. After all PreHooks have executed, any missing response fields that are required are filled by reading out of the configured implementation of the Storage interface. PostHooks are asynchronous tasks that occur after a response has been delivered to the client. Because they are unnecessary to for generating a response, updates to the Storage for a particular request are done asynchronously in a PostHook.

BitTorrent.org: a static website containing the BitTorrent spec and all BEPs
OpenTracker: a popular BitTorrent tracker written in C
Ocelot: a private BitTorrent tracker written in C++