Implement comments

Author: fpotier

.github/workflows/compose_test.yaml

@@ -54,13 +54,15 @@ jobs:
     strategy:
       matrix:
         BE_VERSION: [v3, v4]
-        FEATURE_ENABLED: ['', true]
+        JOBS_ENABLED: ['', true]
+        ELASTIC_ENABLED: ['', true]
+        LDAP_ENABLED: ['', true]
     steps:
       - uses: actions/checkout@v4
       - name: Test compose.yaml
         run: |-
-          export JOBS_ENABLED=${{ matrix.FEATURE_ENABLED }}
-          export ELASTIC_ENABLED=${{ matrix.FEATURE_ENABLED }}
-          export LDAP_ENABLED=${{ matrix.FEATURE_ENABLED }}
+          export JOBS_ENABLED=${{ matrix.JOBS_ENABLED }}
+          export ELASTIC_ENABLED=${{ matrix.ELASTIC_ENABLED }}
+          export LDAP_ENABLED=${{ matrix.LDAP_ENABLED }}
           export BE_VERSION=${{ matrix.BE_VERSION }}
           docker compose --profile '*' up --wait --wait-timeout 300

services/backend/README.md

@@ -5,3 +5,12 @@ The SciCat backend HTTP service.
 ## Dependency on `BE_VERSION`
 
 The `BE_VERSION` value controls which version of the backend should be started, either [v3](./services/v3) or [v4](./services/v4) (default).
+
+## Dependencies
+
+Here below we show the internal dependencies of the service, which are not already covered [here](../../../../README.md) (if `B` depends on `A`, then we visualize as `A --> B`). The same subdomain to service convention applies.
+
+```mermaid
+graph TD
+    ldap --> backend
+```

services/backend/services/ldap/README.md

@@ -9,6 +9,9 @@ The OpenLDAP configuration is set by the [.env file](./config/.env).
 
 For an extensive list of available options see [here](https://hub.docker.com/r/bitnami/openldap).
 
+You can add other users by editing the [ldif file](./config/ldifs/02-users.ldif).
+:warning: User creation is only done once, when the container is created.
+
 ## Default configuration
 The default configuration [.env file](./config/.env) creates the `dc=facility` domain with the following user:
 

services/backend/services/v3/README.md

@@ -71,12 +71,11 @@ If `LDAP_ENABLED` is toggled, you can use LDAP to log in with a [LDAP user](../l
 
 ## Dependencies
 
-Here below we show the internal dependencies of the service, which are not already covered [here](../../../../README.md) (if `B` depends on `A`, then we visualize it as `A --> B`). The same subdomain to service convention applies.
+Here below we show the internal dependencies of the service, which are not already covered [here](../../../../README.md) and [here](../../README.md) (if `B` depends on `A`, then we visualize as `A --> B`). The same subdomain to service convention applies.
 
 ```mermaid
-graph TD   
+graph TD
     rabbitmq --> archivemock
     rabbitmq --> backend
-    ldap --> backend
     backend --> archivemock
 ```

services/backend/services/v4/README.md

@@ -23,17 +23,15 @@ In the default configuration folder [config](./config), the backend is set to us
 
 ## Enable additional features
 
-Additionally, by setting the env variable `ELASTIC_ENABLED`, the [elastic search](./services/elastic/) service is started and the backend is configured to connect to them. 
 Additionally, by setting the env variable `ELASTIC_ENABLED`, the [elastic search](./services/elastic/) service is started and the backend is configured to connect to them.
 
 If `LDAP_ENABLED` is toggled, you can use LDAP to log in with a [LDAP user](../ldap/README.md#default-configuration).
 
 ## Dependencies
 
-Here below we show the internal dependencies of the service, which are not already covered [here](../../../../README.md) (if `B` depends on `A`, then we visualize as `A --> B`). The same subdomain to service convention applies.
+Here below we show the internal dependencies of the service, which are not already covered [here](../../../../README.md) and [here](../../README.md) (if `B` depends on `A`, then we visualize as `A --> B`). The same subdomain to service convention applies.
 
 ```mermaid
 graph TD
     elasticsearch --> backend
-    ldap --> backend
 ```