Add LDAP_ENABLED feature flag in CI/README

SciCatProject · May 29, 2024 · 5d99939 · 5d99939
1 parent ce44b7d
commit 5d99939
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/.env b/.env
@@ -6,3 +6,6 @@ BE_VERSION=v4
 
 ## Enable v4 ELASTIC feature (disable if required or set in command line). To later disable, either unset or set to an empty value
 # ELASTIC_ENABLED=true
+
+## Enable LDAP authentication backend (disable if required or set in command line). To later disable, either unset or set to an empty value
+# LDAP_ENABLED=true
diff --git a/.github/workflows/compose_test.yaml b/.github/workflows/compose_test.yaml
@@ -54,12 +54,13 @@ jobs:
     strategy:
       matrix:
         BE_VERSION: [v3, v4]
-        JOBS_AND_ELASTIC_ENABLED: ['', true]
+        FEATURE_ENABLED: ['', true]
     steps:
       - uses: actions/checkout@v4
       - name: Test compose.yaml
         run: |-
-          export JOBS_ENABLED=${{ matrix.JOBS_AND_ELASTIC_ENABLED }}
-          export ELASTIC_ENABLED=${{ matrix.JOBS_AND_ELASTIC_ENABLED }}
+          export JOBS_ENABLED=${{ matrix.FEATURE_ENABLED }}
+          export ELASTIC_ENABLED=${{ matrix.FEATURE_ENABLED }}
+          export LDAP_ENABLED=${{ matrix.FEATURE_ENABLED }}
           export BE_VERSION=${{ matrix.BE_VERSION }}
           docker compose --profile '*' up --wait --wait-timeout 300
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ They are used when adding new services or grouping services together (and do not
 | env     | `BE_VERSION`       | <li>`v3`: backend/v3<li>`v4`: backend/v4                                          | `v4`    | as set                | Sets the be version to use in (2) of [default setup](#default-setup) to v3                                                                                             | mongodb,frontend        |
 | env     | `JOBS_ENABLED`     | `true`: rabbitmq,archivemock,jobs feature                                       | `''`    | v3                    | Creates a rabbitmq message broker which the be posts to and the archivemock listens to. It emulates the data long-term archive/retrieve workflow                       |                         |
 | env     | `ELASTIC_ENABLED`  | `true`: elastic,elastic feature                                                 | `''`    | v4                    | Creates an elastic search service and sets the be to use it for full-text searches                                                                                     |                         |
+| env     | `LDAP_ENABLED`     | `true`: ldap auth                                                              | `''`    | as set                | Creates an LDAP service and sets the be to use it as authentication backend                                                                                                    |                         |
 
 
 After optionally setting any configuration option, one can still select the services to run as described [here](README.md#select-the-services).