scriptoriumadmin/featurebase
1
0
Fork 0
mirror of https://github.com/featurebasedb/featurebase.git synced 2026-10-06 19:07:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

some more readme fixes for the new config style.

Browse source
This commit is contained in:
Matt Jaffee 2017-03-20 11:09:19 -05:00
parent a3462a2290
commit 9b88e6e754
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -28,7 +28,19 @@ pilosa server
## Configuration
You can specify a configuration by setting the `-config` flag when running `pilosa`.
Running just `pilosa` will show a list of available subcommands. `pilosa help
<command>` will show usage information and the available flags for the command.
Any flag can be specified at the command line, in an environment variables,
and/or in a toml config file. The environment variable for any flag is that
flag, upper cased, prefixed with `PILOSA_`, and with any dashes converted to
underscores. For example, if you would specify `--cluster.poll-interval=30s` at
the command line, you would set `PILOSA_CLUSTER.POLL_INTERVAL=30s` in the
environment. For the configuration file, a dot in a flag denotes nesting with in
the config file. See the example config file below for examples of this.
You can specify a configuration by setting the `-config` flag when running
`pilosa`.
```sh
@ -72,7 +84,7 @@ The first two configuration options will be unique to each node in the cluster:
The remaining configuration options should be the same on every node in the cluster.
`replicas`: the number of replicas within the cluster
`[cluster] replicas`: the number of replicas within the cluster
`[cluster] hosts`: specifies each node within the cluster
@ -80,6 +92,8 @@ The remaining configuration options should be the same on every node in the clus
`[anti-entropy] interval`: TODO
There are also some profiling options for debugging and performance tuning - these don't need to be the same across the cluster and are mostly useful for doing Pilosa development.
`[profile] cpu`: Path at which to store cpu profiling data which will be taken when pilosa starts.
`[profile] cpu-time`: Amount of time for which to collect cpu profiling data at startup.