LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity
A tracker for the LBRY protocol.
1155 commits 12 branches 6 tags 3.9 MiB
Go 99.7%
Dockerfile 0.3%
Go to file
Jimmy Zelinskie b1852c7c8e
Merge pull request #469 from jzelinskie/fix-badge 
readme: fix broken build status badge
2020-03-11 10:17:33 -04:00
.github Merge pull request #469 from jzelinskie/fix-badge 2020-03-11 10:17:33 -04:00
bittorrent add godoc explaining catch-all parameter matching for ByName 2020-01-20 11:31:45 -07:00
cmd/chihaya cmd/chihaya: fix imports for updated goimports 2019-10-17 12:51:53 +09:00
dist dist: remove all traces of travisci 2020-02-18 11:21:43 -05:00
docs docs: update redis storage docs 2019-10-17 14:59:59 +09:00
frontend http: allow for customized routes 2020-01-14 16:35:28 -07: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
CONTRIBUTING.md readme: add CONTRIBUTING.md 2016-03-30 01:21:53 -04:00
Dockerfile docker: update Dockerfile for Go 1.13+ 2019-10-17 15:00:16 +09:00
go.mod travis: update to go 1.13 2019-10-17 12:51:53 +09: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 readme: fix broken build status badge 2020-02-20 13:13:38 -05: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.

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

The Chihaya executable contains a command to end-to-end test a BitTorrent tracker. See

$ chihaya --help

Configuration

Configuration of Chihaya is done via one YAML configuration file. The dist/ directory contains an example configuration file. Files and directories under docs/ contain detailed information about configuring middleware, storage implementations, architecture etc.

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