Giter VIP home page Giter VIP logo

Chihaya

Build Status Container Image GoDoc License IRC Channel

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 [email protected]: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++

chihaya's Projects

bencode icon bencode

deprecated bencode package for chihaya v1.x

chihaya icon chihaya

A customizable, multi-protocol BitTorrent Tracker

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.