From be0a48b7656578c6431850a30c2fcc04907d6663 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20Verg=C3=A9s?= Date: Thu, 7 Dec 2023 17:23:41 +0100 Subject: [PATCH] documentation --- docs/modules/configure/pages/environment_variables.adoc | 6 ++++++ .../develop/pages/manual/operations/automated-tests.adoc | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/modules/configure/pages/environment_variables.adoc b/docs/modules/configure/pages/environment_variables.adoc index c3b6d037..619530ef 100644 --- a/docs/modules/configure/pages/environment_variables.adoc +++ b/docs/modules/configure/pages/environment_variables.adoc @@ -21,6 +21,12 @@ We try to let most of the things defined through Environment Variables, as https |SECRET_KEY_BASE |Secret key base for the Application. It's specially important that this is kept secret from the outside word; do NOT publish it on GitHub/GitLab/BitBucket. +|IAT_EXPIRATION_MINUTES +|Expiration time for the JWT tokens, in minutes. Defaults to 60 minutes. + +|HOURS_BEFORE_CREATE_ELECTION +|Number of hours before the election starts that the election can be created. Defaults to 1 hour. + |SEED |Used to force seed test data on production environments, if `true`. diff --git a/docs/modules/develop/pages/manual/operations/automated-tests.adoc b/docs/modules/develop/pages/manual/operations/automated-tests.adoc index 9a010473..c40df3ae 100644 --- a/docs/modules/develop/pages/manual/operations/automated-tests.adoc +++ b/docs/modules/develop/pages/manual/operations/automated-tests.adoc @@ -34,7 +34,7 @@ We divide the test phase in 4 steps: Make sure you set the `SANDBOX` environment variable to any value to activate it; * The web server and the background worker server shall run in separate machines in order for web traffic and background jobs not to affect each other; * Use Sidekiq as queue adapter; -* In `bulletin_board/server/config/settings.yml`, set `iat_expiration_minutes` to few hours/days. +* In `bulletin_board/server/config/settings.yml`, set `iat_expiration_minutes` to few hours/days (or use the ENV variable `IAT_EXPIRATION_MINUTES`). This is the amount of time a vote is considered valid from its emission - since the vote generation phase could take a few hours, you don't want it to be too low and have the Bulletin Board to reject the votes when you start the load test. [#generate-votes]