From 41550dafa947cbf719017467a542ac85380e9019 Mon Sep 17 00:00:00 2001
From: Troy McConaghy <troy@bigchaindb.com>
Date: Wed, 19 Apr 2017 11:21:59 +0200
Subject: [PATCH] added docs for wssserver.host and .port

---
 .../source/server-reference/configuration.md  | 36 +++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/docs/server/source/server-reference/configuration.md b/docs/server/source/server-reference/configuration.md
index 6f3c8878..053ed68b 100644
--- a/docs/server/source/server-reference/configuration.md
+++ b/docs/server/source/server-reference/configuration.md
@@ -22,6 +22,8 @@ For convenience, here's a list of all the relevant environment variables (docume
 `BIGCHAINDB_SERVER_LOGLEVEL`<br>
 `BIGCHAINDB_SERVER_WORKERS`<br>
 `BIGCHAINDB_SERVER_THREADS`<br>
+`BIGCHAINDB_WSSERVER_HOST`<br>
+`BIGCHAINDB_WSSERVER_PORT`<br>
 `BIGCHAINDB_CONFIG_PATH`<br>
 `BIGCHAINDB_BACKLOG_REASSIGN_DELAY`<br>
 `BIGCHAINDB_LOG`<br>
@@ -180,6 +182,40 @@ export BIGCHAINDB_SERVER_THREADS=5
 }
 ```
 
+
+## wsserver.host and wsserver.port
+
+These settings are for the
+[aiohttp server](https://aiohttp.readthedocs.io/en/stable/index.html), 
+which is used to serve the
+[WebSocket Event Stream API](../websocket-event-stream-api.html).
+`wsserver.host` is where to bind the aiohttp server socket and
+`wsserver.port` is the corresponding port.
+If you want to allow connections from anyone, on port 9985,
+set `wsserver.host` to 0.0.0.0 and `wsserver.port` to 9985.
+
+**Example using environment variables**
+```text
+export BIGCHAINDB_WSSERVER_HOST=0.0.0.0
+export BIGCHAINDB_WSSERVER_PORT=9985
+```
+
+**Example config file snippet**
+```js
+"wsserver": {
+    "host": "0.0.0.0",
+    "port": 65000
+}
+```
+
+**Default values (from a config file)**
+```js
+"wsserver": {
+    "host": "localhost",
+    "port": 9985
+}
+```
+
 ## backlog_reassign_delay
 
 Specifies how long, in seconds, transactions can remain in the backlog before being reassigned.  Long-waiting transactions must be reassigned because the assigned node may no longer be responsive.  The default duration is 120 seconds.