Merge pull request #51 from linagora/logger-doc

Fix Federation server image
linagora · Jun 11, 2024 · aff26bc · aff26bc
2 parents a19810b + 9321e0c
commit aff26bc
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 2 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -22,7 +22,7 @@ env BASE_URL= \
     LDAP_USER= \
     LDAP_PASSWORD= \
     LDAP_URI= \
-    LOGGER=error \
+    LOG_LEVEL=error \
     LOG_TRANSPORTS=Console \
     MATRIX_SERVER= \
     MATRIX_DATABASE_ENGINE= \

diff --git a/README.md b/README.md
@@ -60,6 +60,7 @@ This repository provides a docker image. Here are the environment variables:
     * `UPDATE_FEDERATED_IDENTITY_HASHES_CRON` _(default: `3 3 * * *`)_
   * Logs:
     * `LOG_TRANSPORTS`: set to `Console`
+    * `LOG_LEVEL`: default to "error", possible values: "error", "warn", "info", "http", "verbose", "debug", "silly"
   * `TRUSTED_PROXIES`: IP list of server allowed to set `X-Frowarded-For` header
   * Rate limits _(see [express-rate-limit](https://www.npmjs.com/package/express-rate-limit))_:
     * `RATE_LIMITING_WINDOW`

diff --git a/packages/federated-identity-service/Dockerfile b/packages/federated-identity-service/Dockerfile
@@ -14,6 +14,8 @@ ENV BASE_URL= \
     LDAP_USER= \
     LDAP_PASSWORD= \
     LDAP_URI= \
+    LOG_LEVEL=error \
+    LOG_TRANSPORTS=Console \
     MATRIX_DATABASE_ENGINE= \
     MATRIX_DATABASE_HOST= \
     MATRIX_DATABASE_NAME= \

diff --git a/packages/federated-identity-service/README.md b/packages/federated-identity-service/README.md
@@ -61,6 +61,9 @@ You can configure it using environment variables:
   * `CRON_SERVICE` _(true/false)_: enable ot disable cron tasks. It is required
     to have at least one active federated-odentity-service with `CRON_SERVICE`
     active per database
+  * Logs:
+    * `LOG_TRANSPORTS`: set to `Console`
+    * `LOG_LEVEL`: default to "error", possible values: "error", "warn", "info", "http", "verbose", "debug", "silly"
 
 A federation server is also a [Matrix Identity Service](matrix-identity-server/README.md),
 thus all parameters of this service can also be enabled but this is interseting

diff --git a/packages/federated-identity-service/server.mjs b/packages/federated-identity-service/server.mjs
@@ -45,7 +45,7 @@ const conf = {
       'templates'
     ),
   update_users_cron: process.env.UPDATE_USERS_CRON || '*/10 * * * *',
-  userdb_engine: process.env.USERDB_ENGINE,
+  userdb_engine: process.env.USERDB_ENGINE || '',
   userdb_host: process.env.USERDB_HOST,
   userdb_name: process.env.USERDB_NAME,
   userdb_user: process.env.USERDB_USER,