tracker/README.md
Jimmy Zelinskie 39cbb0bdba readme update
2013-06-28 16:28:27 -04:00

2.3 KiB

#chihaya Build Status

chihaya is a high-performance BitTorrent tracker written in the Go programming language. It isn't quite ready for prime-time just yet, but these are the features that it targets:

  • Requests are multiplexed over all available threads
  • Low processing and memory footprint
  • IPv6 support
  • Generic storage interface that can be easily adapted to use any data store
  • Scaling properties that directly correlate with the chosen data store's scaling properties
  • Redis data storage driver

##installing

$ go install github.com/pushrax/chihaya

##configuring

Configuration is done in a JSON formatted file specified with the -config flag. One can start with example/config.json as a base.

##implementing custom storage

The storage package works similar to the standard library's database/sql package. To write a new storage backend, create a new Go package that has an implementation of both the Conn and the Driver interfaces. Within your package define an init() function that calls storage.Register(driverName, &yourDriver{}). You're driver must be thread-safe. After that, all you have to do is remember to add import _ path/to/your/library to the top of main.go and now config files will recognize your driver by name. If you're writing a driver for a popular data store, consider contributing it.

##contributing

If you're interested in contributing, please contact us in #chihaya on freenode(webchat) or post to the issue tracker. Please don't offer massive pull requests with no prior communication attempts (unannounced small changes are fine), as it will most likely lead to confusion and time wasted for everyone. And remember: good gophers always use gofmt!