From dd6e0b50725b511a4f8d8aea2f8b83853e25b4f6 Mon Sep 17 00:00:00 2001 From: Anthony LC Date: Tue, 13 May 2025 15:08:18 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(project)=20add=20missing=20env=20v?= =?UTF-8?q?ar=20to=20env.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update the documentation to include the missing environment variables. The missing environment variables are involved in the build process of the frontend image. --- docs/env.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/env.md b/docs/env.md index e29e99b8..5cfa7e0f 100644 --- a/docs/env.md +++ b/docs/env.md @@ -4,7 +4,7 @@ Here we describe all environment variables that can be set for the docs applicat ## impress-backend container -These are the environmental variables you can set for the impress-backend container. +These are the environment variables you can set for the `impress-backend` container. | Option | Description | default | | ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- | @@ -100,3 +100,14 @@ These are the environmental variables you can set for the impress-backend contai | MALWARE_DETECTION_PARAMETERS | A dict containing all the parameters to initiate the malware detection backend | {"callback_path": "core.malware_detection.malware_detection_callback",} | | THEME_CUSTOMIZATION_FILE_PATH | full path to the file customizing the theme. An example is provided in src/backend/impress/configuration/theme/default.json | BASE_DIR/impress/configuration/theme/default.json | | THEME_CUSTOMIZATION_CACHE_TIMEOUT | Cache duration for the customization settings | 86400 | + + +## impress-frontend image + +These are the environment variables you can set to build the `impress-frontend` image. + +| Option | Description | default | +| ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| API_ORIGIN | backend domain - it uses the current domain if not initialized | | +| SW_DEACTIVATED | To not install the service worker | | +| PUBLISH_AS_MIT | MIT licence does not include the export feature | true | \ No newline at end of file