Add documentation for aas-gui ENV variable ENDPOINT_CONFIG_AVAILABLE (#…

…25) * Add ENDPOINT_CONFIG_AVAILABLE * Add note for docker image tag
eclipse-basyx · Nov 26, 2024 · 889c14d · 889c14d
1 parent 418d7f5
commit 889c14d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/...ce/content/user_documentation/basyx_components/web_ui/features/docker_config.md b/...ce/content/user_documentation/basyx_components/web_ui/features/docker_config.md
@@ -30,6 +30,7 @@ The following environment variables can be used to configure the AAS Web UI:
 | KEYCLOAK_URL | The URL of the Keycloak server used as identity provider for RBAC |
 | KEYCLOAK_REALM | The realm of the Keycloak server |
 | KEYCLOAK_CLIENT_ID | The client ID of the Keycloak server |
+| ENDPOINT_CONFIG_AVAILABLE | Specifies whether the endpoint configuration should be available in the AAS Web UI (ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)|
 
 ```{tip}
 Using environment variables works when building the Docker image yourself or when using the image from Docker Hub.
@@ -75,6 +76,7 @@ services:
             KEYCLOAK_URL: "<keycloak_url>" (optional; RBAC feature)
             KEYCLOAK_REALM: "<keycloak_realm>" (optional; RBAC feature)
             KEYCLOAK_CLIENT_ID: "<keycloak_client_id>" (optional; RBAC feature)
+            ENDPOINT_CONFIG_AVAILABLE: "<true/false>" (optional; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
 ```
 
 2. Start the AAS Web UI with the following command:

diff --git a/docs/source/content/user_documentation/basyx_components/web_ui/index.md b/docs/source/content/user_documentation/basyx_components/web_ui/index.md
@@ -131,6 +131,7 @@ services:
             KEYCLOAK_URL: "<keycloak_url>" (optional; RBAC feature)
             KEYCLOAK_REALM: "<keycloak_realm>" (optional; RBAC feature)
             KEYCLOAK_CLIENT_ID: "<keycloak_client_id>" (optional; RBAC feature)
+            ENDPOINT_CONFIG_AVAILABLE: "<true/false>" (optional; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
         volumes:
             - <local_path_to_logo>:/usr/src/app/dist/Logo (optional; Corporate Design)
 ```