A tracker for the LBRY protocol.

Find a file

CptTony f68a946f96 Remove unused import 'os/signal' for windows		2022-07-05 16:01:38 -07:00
.github	.github: update workflows	2022-07-01 10:33:20 +02:00
bittorrent	golangci-lint: include golint docstring exceptions	2022-01-18 13:33:46 -05:00
cmd/chihaya	Remove unused import 'os/signal' for windows	2022-07-05 16:01:38 -07:00
dist	lint: lint yaml files	2022-01-15 13:13:21 -05:00
docs	lint: lint markdown files	2022-01-15 13:03:41 -05:00
frontend	*: pass golangci-lint	2022-07-01 10:36:48 +02:00
middleware	lint: actually lint all go files	2022-01-15 23:28:52 -05:00
pkg	lint: actually lint all go files	2022-01-15 23:28:52 -05:00
storage	gomod: bump all deps (mostly redis)	2022-01-18 22:00:57 -05:00
.golangci.yaml	*: pass golangci-lint	2022-07-01 10:36:48 +02:00
.markdownlint.yaml	lint: lint markdown files	2022-01-15 13:03:41 -05:00
.yamllint	lint: lint yaml files	2022-01-15 13:13:21 -05:00
CONTRIBUTING.md	lint: lint markdown files	2022-01-15 13:03:41 -05:00
Dockerfile	Fixes Dockerfile	2020-04-06 11:17:41 +07:00
go.mod	build(deps): bump github.com/spf13/cobra from 1.3.0 to 1.5.0	2022-07-04 08:50:44 +00:00
go.sum	build(deps): bump github.com/spf13/cobra from 1.3.0 to 1.5.0	2022-07-04 08:50:44 +00: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	lint: lint markdown files	2022-01-15 13:03:41 -05:00

README.md

Chihaya

Chihaya is an open source BitTorrent tracker written in Go.

Differentiating features include:

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

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.

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.

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