LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity
A tracker for the LBRY protocol.
1119 commits 12 branches 6 tags 3.9 MiB
Go 99.7%
Dockerfile 0.3%
Go to file
Cooper Ry Lees d7cfcacbff Remove Facebook from README.md 
- We no longer use the code that is on HEAD
- We should not incorrectly state that we do and mislead the general public
2019-02-14 09:25:13 -08:00
bittorrent bittorrent: anonymous fields for IPs in test table 2018-06-15 13:33:26 -04:00
cmd/chihaya storage: remove memorybysubnet 2019-02-13 19:44:04 -05:00
dist Add config to enable keepalive/persistent connections 2018-09-09 09:01:53 -04:00
docs docs: refactor architecture into its own doc 2019-02-13 10:53:26 -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: remove memorybysubnet 2019-02-13 19:44:04 -05:00
.travis.yml vendor: move to Go modules for dependencies 2019-02-12 20:36:25 -05:00
CONTRIBUTING.md readme: add CONTRIBUTING.md 2016-03-30 01:21:53 -04:00
Dockerfile vendor: move to Go modules for dependencies 2019-02-12 20:36:25 -05:00
example_config.yaml Add storage redis configuration example 2019-01-22 19:36:27 +08:00
go.mod vendor: move to Go modules for dependencies 2019-02-12 20:36:25 -05:00
go.sum vendor: move to Go modules for dependencies 2019-02-12 20:36:25 -05: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 Remove Facebook from README.md 2019-02-14 09:25:13 -08:00

README.md

Chihaya

Build Status Docker Repository on Quay.io Go Report Card GoDoc Lines of Code License IRC Channel

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

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.

$ git clone git@github.com:chihaya/chihaya.git
$ cd chihaya
$ GO111MODULE=on go build ./cmd/chihaya
$ ./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 ./...)

Related projects

  • 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++