Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #657 from bigchaindb/settings-and-cli-docs-tweaks

Browse Source 
Tidied up the docs for the config settings & the CLI
This commit is contained in:
Troy McConaghy 2016-10-07 12:30:04 +02:00 committed by GitHub
commit 2a67bc8236
2 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/server-reference/bigchaindb-cli.md
View File

@ -1,9 +1,6 @@
# BigchainDB Command Line Interface (CLI)
# Command Line Interface (CLI)
**Note: At the time of writing, BigchainDB Server and our BigchainDB client are combined, so the BigchainDB CLI includes some server-specific commands and some client-specific commands (e.g. `bigchaindb load`). Soon, BigchainDB Server will be separate from all BigchainDB clients, and they'll all have different CLIs.**
The command-line command to interact with BigchainDB is `bigchaindb`.
The command-line command to interact with BigchainDB Server is `bigchaindb`.
## bigchaindb \-\-help
@ -70,6 +67,9 @@ Write transactions to the backlog (for benchmarking tests). You can learn more a
$ bigchaindb load -h
```
Note: This command uses the Python Server API to write transactions to the database. It _doesn't_ use the HTTP API or a driver that wraps the HTTP API.
## bigchaindb set-shards
Set the number of shards in the underlying datastore. For example, the following command will set the number of shards to four:

6
docs/source/server-reference/configuration.md
View File

@ -1,8 +1,6 @@
# BigchainDB Configuration Settings
# Configuration Settings
**Note: At the time of writing, BigchainDB Server code and BigchainDB Python driver code are mixed together, so the following settings are the settings used by BigchainDB Server and also by clients written using the Python driver code. Soon, the code will be separated into server, driver and shared modules, so that BigchainDB Server and BigchainDB clients will have different configuration settings.**
The value of each configuration setting is determined according to the following rules:
The value of each BigchainDB Server configuration setting is determined according to the following rules:
* If it's set by an environment variable, then use that value
* Otherwise, if it's set in a local config file, then use that value