LBRYFoundation/tracker
1
0
Fork 0
mirror of https://github.com/LBRYFoundation/tracker.git synced 2025-08-28 16:01:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

remove references to "cache" from readme [ci skip]

Browse source
This commit is contained in:
Jimmy Zelinskie 2013-11-23 23:59:12 -05:00
parent 9382ac482e
commit cf36519c5e
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -19,7 +19,7 @@ See [the wiki](https://github.com/pushrax/chihaya/wiki) for a discussion of the
## Using Chihaya ## Using Chihaya
Chihaya is intended to work with existing torrent indexing web frameworks, such as [batter] and [Gazelle]. Chihaya is intended to work with existing torrent indexing web frameworks, such as [Batter] and [Gazelle].
Following the Unix way, it is built to perform a specific task, and interface with any system that Following the Unix way, it is built to perform a specific task, and interface with any system that
needs its functionality. See [below](#drivers) for more info. needs its functionality. See [below](#drivers) for more info.
@ -31,7 +31,7 @@ needs its functionality. See [below](#drivers) for more info.
Make sure you have your `$GOROOT` and `$GOPATH` set up correctly, and have your `$GOBIN` in your `$PATH`. Make sure you have your `$GOROOT` and `$GOPATH` set up correctly, and have your `$GOBIN` in your `$PATH`.
```sh ```sh
$ go get github.com/pushrax/chihaya $ go install github.com/pushrax/chihaya
``` ```
### Configuring ### Configuring
@ -47,24 +47,25 @@ The `$TESTCONFIGPATH` environment variable is required for the tests to function
```sh ```sh
$ cd $GOPATH/src/github.com/pushrax/chihaya $ cd $GOPATH/src/github.com/pushrax/chihaya
$ TESTCONFIGPATH=$GOPATH/src/github.com/pushrax/chihaya/config/example.json go test -v ./... $ export TESTCONFIGPATH=$GOPATH/src/github.com/pushrax/chihaya/config/example.json
$ go test -v ./...
``` ```
## Drivers ## Drivers
Chihaya is designed to remain agnostic about the choice of data store for an 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 application, and it is straightforward to [implement a new driver]. However, there
are a number of directly supported drivers: are a number of drivers that plan to be directly supported:
Cache: Tracker:
* [redis](http://redis.io) — allows for multiple tracker instances to run at the same time for the same swarm * [redis](http://redis.io)
* memory — only a single instance can run, but it requires no extra setup * memory
Storage: Backend:
* [batter-postgres](https://github.com/wafflesfm/batter) * [batter (postgres)](https://github.com/wafflesfm/batter)
* [gazelle-mysql](https://github.com/whatcd/gazelle) * [gazelle (mysql)](https://github.com/whatcd/gazelle)
[implement a new driver]: https://github.com/pushrax/chihaya/wiki/Implementing-a-driver [implement a new driver]: https://github.com/pushrax/chihaya/wiki/Implementing-a-driver