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

Add configuration documentation for new database.backend setting (#934)

Browse Source
This commit is contained in:
Brett Sun 2016-12-12 18:31:34 +01:00 committed by GitHub
parent 8a68e24e69
commit d7d223801d
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -11,6 +11,7 @@ For convenience, here's a list of all the relevant environment variables (docume
`BIGCHAINDB_KEYPAIR_PUBLIC`<br> `BIGCHAINDB_KEYPAIR_PUBLIC`<br>
`BIGCHAINDB_KEYPAIR_PRIVATE`<br> `BIGCHAINDB_KEYPAIR_PRIVATE`<br>
`BIGCHAINDB_KEYRING`<br> `BIGCHAINDB_KEYRING`<br>
`BIGCHAINDB_DATABASE_BACKEND`<br>
`BIGCHAINDB_DATABASE_HOST`<br> `BIGCHAINDB_DATABASE_HOST`<br>
`BIGCHAINDB_DATABASE_PORT`<br> `BIGCHAINDB_DATABASE_PORT`<br>
`BIGCHAINDB_DATABASE_NAME`<br> `BIGCHAINDB_DATABASE_NAME`<br>
@ -76,12 +77,13 @@ Note how the keys in the list are separated by colons.
``` ```
## database.host, database.port & database.name ## database.backend, database.host, database.port & database.name
The RethinkDB database hostname, port and name. The database backend to use (e.g. RethinkDB) and its hostname, port and name.
**Example using environment variables** **Example using environment variables**
```text ```text
export BIGCHAINDB_DATABASE_BACKEND=rethinkdb
export BIGCHAINDB_DATABASE_HOST=localhost export BIGCHAINDB_DATABASE_HOST=localhost
export BIGCHAINDB_DATABASE_PORT=28015 export BIGCHAINDB_DATABASE_PORT=28015
export BIGCHAINDB_DATABASE_NAME=bigchain export BIGCHAINDB_DATABASE_NAME=bigchain
@ -90,6 +92,7 @@ export BIGCHAINDB_DATABASE_NAME=bigchain
**Example config file snippet** **Example config file snippet**
```js ```js
"database": { "database": {
"backend": "rethinkdb",
"host": "localhost", "host": "localhost",
"port": 28015, "port": 28015,
"name": "bigchain" "name": "bigchain"
@ -99,12 +102,16 @@ export BIGCHAINDB_DATABASE_NAME=bigchain
**Default values (a snippet from `bigchaindb/__init__.py`)** **Default values (a snippet from `bigchaindb/__init__.py`)**
```python ```python
'database': { 'database': {
"backend": "rethinkdb",
'host': os.environ.get('BIGCHAINDB_DATABASE_HOST', 'localhost'), 'host': os.environ.get('BIGCHAINDB_DATABASE_HOST', 'localhost'),
'port': 28015, 'port': 28015,
'name': 'bigchain', 'name': 'bigchain',
} }
``` ```
**Note**: As of now, only RethinkDB ("rethinkdb") is supported as a value for `database.backend`. In
the future, other options (e.g. MongoDB) will be available.
## server.bind, server.workers & server.threads ## server.bind, server.workers & server.threads