add customizing section to readme
This commit is contained in:
Jimmy Zelinskie
parent
fc2d15cdc0
commit
25e7ea98d5
1 changed files with 38 additions and 29 deletions
67
README.md
67
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Chihaya [](https://travis-ci.org/chihaya/chihaya)
|
||||
|
||||
Chihaya is a high-performance [BitTorrent tracker](http://en.wikipedia.org/wiki/BitTorrent_tracker) written in the Go programming language. It is still heavily under development and the current `master` branch should probably not be used in production.
|
||||
Chihaya is a high-performance [BitTorrent tracker](http://en.wikipedia.org/wiki/BitTorrent_tracker) written in the Go programming language. It is still heavily under development and the current `master` branch should probably not be used in production unless you know what you're doing.
|
||||
|
||||
Features include:
|
||||
|
||||
|
|
@ -13,7 +13,7 @@ Features include:
|
|||
|
||||
## Using Chihaya
|
||||
|
||||
Chihaya can be ran as a public or private tracker and is intended to work with existing torrent-indexing web frameworks, such as [Gazelle], [Batter] and any others that spring up. Following the Unix way, it is built to perform one specific task: handling announces and scrapes. By cleanly separating the concerns between tracker and database, we can provide an interface that can be used by system that needs its functionality. See [below](#drivers) for more info.
|
||||
Chihaya can be ran as a public or private tracker and is intended to coordinate with existing torrent-indexing web frameworks, such as [Gazelle], [Batter] and any others that spring up. Following the Unix way, it is built to perform one specific task: handling announces and scrapes. By cleanly separating the concerns between tracker and database, we can provide an interface that can be used by system that needs its functionality.
|
||||
|
||||
[batter]: https://github.com/wafflesfm/batter
|
||||
[gazelle]: https://github.com/whatcd/gazelle
|
||||
|
|
@ -26,43 +26,35 @@ Chihaya requires Go 1.3+ to build. To install the Chihaya server, run:
|
|||
$ go get github.com/chihaya/chihaya/cmd/chihaya
|
||||
```
|
||||
|
||||
Make sure you have your `$GOPATH` set up correctly, and have `$GOPATH/bin` in your `$PATH`.
|
||||
If you're new to Go, an overview of the directory structure can be found [here](http://golang.org/doc/code.html).
|
||||
Make sure you have your `$GOPATH` set up correctly, and have `$GOPATH/bin` in your `$PATH`. If you're new to Go, an overview of the directory structure can be found [here](http://golang.org/doc/code.html).
|
||||
|
||||
### Configuring
|
||||
|
||||
Configuration is done in a JSON formatted file specified with the `-config`
|
||||
flag. An example configuration file can be found
|
||||
[here](https://github.com/chihaya/chihaya/blob/master/example.json).
|
||||
Configuration is done in a JSON formatted file specified with the `-config` flag. An example configuration file can be found [here](https://github.com/chihaya/chihaya/blob/master/example.json).
|
||||
|
||||
### Running the tests
|
||||
#### Drivers
|
||||
|
||||
Chihaya is designed to remain agnostic about the choice of data storage. Out of the box, we provide only the necessary drivers to run Chihaya in public mode ("memory" for tracker and "noop" for backend). If you're interested in creating a new driver, check out the section on [customizing chihaya].
|
||||
|
||||
[customizing chihaya]: https://github.com/chihaya/chihaya#customizing-chihaya
|
||||
|
||||
|
||||
## Developing Chihaya
|
||||
|
||||
### Testing
|
||||
|
||||
```sh
|
||||
$ cd $GOPATH/src/github.com/chihaya/chihaya
|
||||
$ go test -v ./...
|
||||
```
|
||||
|
||||
### Technical Details
|
||||
### Customizing Chihaya
|
||||
|
||||
See [the wiki](https://github.com/chihaya/chihaya/wiki) for a discussion of the design behind Chihaya.
|
||||
If you require more than the drivers provided out-of-the-box, you are free to create your own and then produce your own custom Chihaya binary. To create this binary, simply create your own main package, import your custom drivers, then call [`chihaya.Boot`] from main.
|
||||
|
||||
## Drivers
|
||||
[`chihaya.Boot`]: http://godoc.org/github.com/chihaya/chihaya
|
||||
|
||||
Chihaya is designed to remain agnostic about the choice of data store for an
|
||||
application, and it is straightforward to [implement a new driver]. However, there
|
||||
are a number of drivers that will be directly supported "out of the box":
|
||||
|
||||
Tracker:
|
||||
|
||||
* memory
|
||||
* [redis](https://github.com/chihaya/chihaya-redis)
|
||||
|
||||
Backend:
|
||||
|
||||
* noop (for public trackers)
|
||||
* [gazelle (mysql)](https://github.com/chihaya/chihaya-gazelle)
|
||||
|
||||
To use an external driver, make your own package and call it something like `github.com/yourusername/chihaya`. Then, import Chihaya like so:
|
||||
#### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
|
@ -78,11 +70,28 @@ func main() {
|
|||
}
|
||||
```
|
||||
|
||||
Then, when you do `go install github.com/yourusername/chihaya`, your own drivers will be included in the binary.
|
||||
#### Tracker Drivers
|
||||
|
||||
[implement a new driver]: https://github.com/chihaya/chihaya/wiki/Implementing-a-driver
|
||||
The [`tracker`] package contains 3 interfaces that are heavily inspired by the standard library's [`database/sql`] package. To write a new driver that will provide a storage mechanism for the fast moving data within the tracker, create your own new Go package that has an implementation of the [`tracker.Driver`], [`tracker.Pool`], and [`tracker.Conn`] interfaces. Within that package, you must also define an [`init()`] that calls [`tracker.Register`] registering your new driver. A great place to start is the documentation and source code of the [`memory`] driver to understand thread safety and basic driver design.
|
||||
|
||||
## Contributing
|
||||
#### Backend Drivers
|
||||
|
||||
The [`backend`] package is meant to provide announce deltas to a slower and more consistent database, such as the one powering a torrent-indexing website. Implementing a backend driver is very similar to implementing a tracker driver: simply create a package that implements the [`backend.Driver`] and [`backend.Conn`] interfaces and calls [`backend.Register`] in it's [`init()`]. Please note that [`backend.Conn`] must be thread-safe.
|
||||
|
||||
[`init()`]: http://golang.org/ref/spec#Program_execution
|
||||
[`database/sql`]: http://godoc.org/database/sql
|
||||
[`tracker`]: http://godoc.org/github.com/chihaya/chihaya/tracker
|
||||
[`tracker.Register`]: http://godoc.org/github.com/chihaya/chihaya/tracker#Register
|
||||
[`tracker.Driver`]: http://godoc.org/github.com/chihaya/chihaya/tracker#Driver
|
||||
[`tracker.Pool`]: http://godoc.org/github.com/chihaya/chihaya/tracker#Pool
|
||||
[`tracker.Conn`]: http://godoc.org/github.com/chihaya/chihaya/tracker#Conn
|
||||
[`memory`]: http://godoc.org/github.com/chihaya/chihaya/tracker/memory
|
||||
[`backend`]: http://godoc.org/github.com/chihaya/chihaya/backend
|
||||
[`backend.Register`]: http://godoc.org/github.com/chihaya/chihaya/backend#Register
|
||||
[`backend.Driver`]: http://godoc.org/github.com/chihaya/chihaya/backend#Driver
|
||||
[`backend.Conn`]: http://godoc.org/github.com/chihaya/chihaya/backend#Conn
|
||||
|
||||
### Contributing
|
||||
|
||||
If you're interested in contributing, please contact us via IRC in **[#chihaya] on
|
||||
[freenode]** or post to the GitHub issue tracker. Please don't write
|
||||
|
|
|
|||
Loading…
Reference in a new issue