commit 6ee9f3d40619530e4ae7b990c022be3ccdbf1df8
parent c24d3339b7a8b40019f0168d083566a7d80f28c8
Author: srfsh <dev@srf.sh>
Date: Tue, 26 Jul 2022 17:39:41 +0300
doc: mention ROOM_PASS
Diffstat:
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md
@@ -39,6 +39,7 @@ also see the [Required Options](#required-options).
* `ROOM_HOST`: The hostname or IP address of the Restroom instance.
* `ROOM_PORT`: The port number of the Restroom instance. It must be an integer
between `0` and `65535`, inclusive.
+* `ROOM_PASS`: The passphrase to be used with Restroom's keypairoomServer call.
* `ADMIN_KEY`: A 64-octect long, lowercase-base16-encoded string used for the
authenticating calls from the administrators. Can be generated with
@@ -51,7 +52,8 @@ also see the [Required Options](#required-options).
Some of the options on how to connect to the database and the Restroom intance
are required, along with `ADMIN_KEY` that is used authenticating admin calls.
-For the Restroom instance, you need the `ROOM_HOST` and `ROOM_PORT` options.
+For the Restroom instance, you need the `ROOM_HOST`, `ROOM_PORT`, and `ROOM_PASS`
+options.
About the database, there are only 2 things you need to setup: how to connect to
the database host, and what credentials to use.
