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

Update documentation about default bind address

Browse Source
This commit is contained in:
vrde 2016-04-15 16:33:26 +02:00
parent 6844a1a212
commit 7cd26cbd3a
No known key found for this signature in database
GPG Key ID: 6581C7C39B3D397D
3 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/configuration.md
View File

@ -65,7 +65,7 @@ environment variables available are:
- `BIGCHAINDB_STATSD_RATE` is a float between `0` and `1` that defines the fraction of transaction operations sampled. - `BIGCHAINDB_STATSD_RATE` is a float between `0` and `1` that defines the fraction of transaction operations sampled.
- `BIGCHAINDB_API_ENDPOINT` defines the API endpoint to use (e.g. `http://localhost:9984/api/v1`). - `BIGCHAINDB_API_ENDPOINT` defines the API endpoint to use (e.g. `http://localhost:9984/api/v1`).
- `BIGCHAINDB_CONSENSUS_PLUGIN` defines the name of the [consensus plugin](consensus.html) to use. - `BIGCHAINDB_CONSENSUS_PLUGIN` defines the name of the [consensus plugin](consensus.html) to use.
- `BIGCHAINDB_SERVER_BIND` defines where to bind the server socket, the format is `addr:port` (e.g. `0.0.0.0:9984`). - `BIGCHAINDB_SERVER_BIND` defines where to bind the server socket, the format is `addr:port` (e.g. `localhost:9984`).
- `BIGCHAINDB_SERVER_WORKERS` defines the [number of workers](http://docs.gunicorn.org/en/stable/settings.html#workers) - `BIGCHAINDB_SERVER_WORKERS` defines the [number of workers](http://docs.gunicorn.org/en/stable/settings.html#workers)
to start for the server API. to start for the server API.
- `BIGCHAINDB_SERVER_THREADS` defines the [number of threads](http://docs.gunicorn.org/en/stable/settings.html#threads) - `BIGCHAINDB_SERVER_THREADS` defines the [number of threads](http://docs.gunicorn.org/en/stable/settings.html#threads)
@ -129,7 +129,7 @@ you will get the following values for all the configuration settings:
"pubkey1" "pubkey1"
], ],
"server": { "server": {
"bind": "0.0.0.0:9984", "bind": "localhost:9984",
"threads": null, "threads": null,
"workers": null "workers": null
}, },
@ -164,7 +164,7 @@ WARNING:bigchaindb.config_utils:Cannot find config file `/home/vrde/.bigchaindb`
}, },
"keyring": [], "keyring": [],
"server": { "server": {
"bind": "0.0.0.0:9984", "bind": "localhost:9984",
"threads": null, "threads": null,
"workers": null "workers": null
}, },
@ -213,7 +213,7 @@ WARNING:bigchaindb.config_utils:Cannot find config file `/home/vrde/.bigchaindb`
}, },
"keyring": [], "keyring": [],
"server": { "server": {
"bind": "0.0.0.0:9984", "bind": "localhost:9984",
"threads": null, "threads": null,
"workers": null "workers": null
}, },

6
docs/source/http-client-server-api.md
View File

@ -5,8 +5,10 @@ When you start Bigchaindb using `bigchaindb start`, an HTTP API is exposed at:
- [http://localhost:9984/api/v1/](http://localhost:9984/api/v1/) - [http://localhost:9984/api/v1/](http://localhost:9984/api/v1/)
Please note that by default the server binds to `0.0.0.0:9984`, hence the API Please note that for security reasons the server binds to `localhost:9984`.
is exposed to the world. If you want to bind the server to `0.0.0.0` we recommend you to read
[Deploying Gunicorn](http://docs.gunicorn.org/en/stable/deploy.html) and
follow the instructions to deploy it in production.
The HTTP API currently exposes two endpoints, one to get information about a The HTTP API currently exposes two endpoints, one to get information about a
specific transaction id, and one to push a transaction to the BigchainDB specific transaction id, and one to push a transaction to the BigchainDB

2
docs/source/installing-server.md
View File

@ -130,7 +130,7 @@ stored on your host machine under ` ~/.bigchaindb_docker/config`:
$ docker-compose run --rm bigchaindb bigchaindb configure $ docker-compose run --rm bigchaindb bigchaindb configure
Starting bigchaindb_rethinkdb-data_1 Starting bigchaindb_rethinkdb-data_1
Generating keypair Generating keypair
API Server bind? (default `0.0.0.0:9984`): API Server bind? (default `localhost:9984`):
Database host? (default `localhost`): rethinkdb Database host? (default `localhost`): rethinkdb
Database port? (default `28015`): Database port? (default `28015`):
Database name? (default `bigchain`): Database name? (default `bigchain`):