From c3cd2b5f3e7acc2b629a96fc80fb0426c9517211 Mon Sep 17 00:00:00 2001 From: minottic Date: Mon, 8 Apr 2024 16:57:49 +0200 Subject: [PATCH] Update readmes based on env var --- README.md | 2 +- services/frontend/README.md | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f210b268..597e510d 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ graph TD end mongodb --> backends - backend --> frontend + backends --> frontend[frontend**] backend --> searchapi end diff --git a/services/frontend/README.md b/services/frontend/README.md index c010ef17..d718bde9 100644 --- a/services/frontend/README.md +++ b/services/frontend/README.md @@ -4,8 +4,12 @@ The SciCat frontend is the SciCat metadata catalogue web UI, built on top of the ## Configuration options -The frontend configuration is set by the [config.json file](./config/config.json). For an extensive list of available options see [here](https://scicatproject.github.io/documentation/Development/v3.x/Configuration.html) in the SciCat frontend section. +The frontend configuration is set by the [configfiles](./config/). Files inside the [config](./config/) folder, with a `.json` extension are merged in alphabetical order, with [config.v3.json](./config/config.v3.json) applied depending on the [BE_VERSION](README.md#dependency-on-be_version). For an extensive list of available options see [here](https://scicatproject.github.io/documentation/Development/v3.x/Configuration.html) in the SciCat frontend section. -## Defaul configuration +## Default configuration -In the default configuration [config.json file](./config/config.json), the frontend is set to call the [backend container](../backend/) which is available on the `backend.localhost`. +In the default configuration [config](./config/), the frontend is set to call the [backend container](../backend/) which is available on the `backend.localhost`. + +## Dependency on `BE_VERSION` + +The `BE_VERSION` value controls if the `frontend` should connect to the [backend container](../backend/) or the [backendnext container](../backendnext/).