readme: update readme, move example config
This commit is contained in:
parent
ae431e1361
commit
728ec0c623
2 changed files with 18 additions and 4 deletions
15
README.md
15
README.md
|
@ -61,7 +61,7 @@ In order to compile the project, the [latest stable version of Go] and knowledge
|
|||
```sh
|
||||
$ git clone git@github.com:chihaya/chihaya.git
|
||||
$ cd chihaya
|
||||
$ GO111MODULE=on go build ./cmd/chihaya
|
||||
$ go build ./cmd/chihaya
|
||||
$ ./chihaya --help
|
||||
```
|
||||
|
||||
|
@ -84,6 +84,19 @@ 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
|
||||
|
||||
```sh
|
||||
$ 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](https://github.com/bittorrent/bittorrent.org): a static website containing the BitTorrent spec and all BEPs
|
||||
|
|
|
@ -129,14 +129,15 @@ chihaya:
|
|||
# # This balances between
|
||||
# # - collecting garbage more often, potentially using more CPU time, but potentially using less memory (lower value)
|
||||
# # - collecting garbage less frequently, saving CPU time, but keeping old peers long, thus using more memory (higher value).
|
||||
# gc_interval: 14m
|
||||
# gc_interval: 3m
|
||||
|
||||
# # The frequency which metrics are pushed into a local Prometheus endpoint.
|
||||
# # The interval at which metrics about the number of infohashes and peers
|
||||
# # are collected and posted to Prometheus.
|
||||
# prometheus_reporting_interval: 1s
|
||||
|
||||
# # The amount of time until a peer is considered stale.
|
||||
# # To avoid churn, keep this slightly larger than `announce_interval`
|
||||
# peer_lifetime: 16m
|
||||
# peer_lifetime: 31m
|
||||
|
||||
# # The address of redis storage.
|
||||
# redis_broker: "redis://pwd@127.0.0.1:6379/0"
|
Loading…
Add table
Reference in a new issue