zf

zenflows testing
git clone https://s.sonu.ch/~srfsh/zf.git
Log | Files | Refs | Submodules | README | LICENSE

commit fd9a214794be4032e0734550f891ffe6119c0018
parent 55cc95846ff64a50c28cf441068b8773bd6d11ab
Author: srfsh <dev@srf.sh>
Date:   Fri, 15 Jul 2022 11:11:01 +0300

doc: improve Configuration Guide

Diffstat:
Mdocs/configuration-guide.md | 10++++++----
1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md @@ -39,15 +39,17 @@ 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_SALT`: A 64-octect long, lowercase-base16-encoded string used for the - salt of the passphrase hashing function. Can be generated with `openssl rand - -hex 64`. It is automatically generated when you run `mann env.setup` + +* `ADMIN_KEY`: A 64-octect long, lowercase-base16-encoded string used for the + authenticating calls from the administrators. Can be generated with + `openssl rand -hex 64`. It is automatically generated when you run + `mann env.setup`. ## Required Options Some of the options on how to connect to the database and the Restroom intance -are required, along with `ROOM_SALT` that is used for passhprase hashing. +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.