From cf469411c8c26711067dfd81e76382a85a7d368a Mon Sep 17 00:00:00 2001 From: Sebastian Eicke Date: Tue, 12 Nov 2024 08:54:33 +0100 Subject: [PATCH 1/2] Add ENDPOINT_CONFIG_AVAILABLE --- .../basyx_components/web_ui/features/docker_config.md | 2 ++ .../content/user_documentation/basyx_components/web_ui/index.md | 1 + 2 files changed, 3 insertions(+) diff --git a/docs/source/content/user_documentation/basyx_components/web_ui/features/docker_config.md b/docs/source/content/user_documentation/basyx_components/web_ui/features/docker_config.md index b2bb9fd..65385e1 100644 --- a/docs/source/content/user_documentation/basyx_components/web_ui/features/docker_config.md +++ b/docs/source/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 | ```{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: "" (optional; RBAC feature) KEYCLOAK_REALM: "" (optional; RBAC feature) KEYCLOAK_CLIENT_ID: "" (optional; RBAC feature) + ENDPOINT_CONFIG_AVAILABLE: "" (optional) ``` 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 index 86586f6..bf83464 100644 --- 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: "" (optional; RBAC feature) KEYCLOAK_REALM: "" (optional; RBAC feature) KEYCLOAK_CLIENT_ID: "" (optional; RBAC feature) + ENDPOINT_CONFIG_AVAILABLE: "" (optional) volumes: - :/usr/src/app/dist/Logo (optional; Corporate Design) ``` From 1d992cf981272c1c0954766b9466f2e9094f13b7 Mon Sep 17 00:00:00 2001 From: Sebastian Eicke Date: Tue, 12 Nov 2024 09:04:25 +0100 Subject: [PATCH 2/2] Add note for docker image tag --- .../basyx_components/web_ui/features/docker_config.md | 4 ++-- .../user_documentation/basyx_components/web_ui/index.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/content/user_documentation/basyx_components/web_ui/features/docker_config.md b/docs/source/content/user_documentation/basyx_components/web_ui/features/docker_config.md index 65385e1..52b2dae 100644 --- a/docs/source/content/user_documentation/basyx_components/web_ui/features/docker_config.md +++ b/docs/source/content/user_documentation/basyx_components/web_ui/features/docker_config.md @@ -30,7 +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 | +| 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. @@ -76,7 +76,7 @@ services: KEYCLOAK_URL: "" (optional; RBAC feature) KEYCLOAK_REALM: "" (optional; RBAC feature) KEYCLOAK_CLIENT_ID: "" (optional; RBAC feature) - ENDPOINT_CONFIG_AVAILABLE: "" (optional) + ENDPOINT_CONFIG_AVAILABLE: "" (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 index bf83464..01d8cfe 100644 --- 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,7 +131,7 @@ services: KEYCLOAK_URL: "" (optional; RBAC feature) KEYCLOAK_REALM: "" (optional; RBAC feature) KEYCLOAK_CLIENT_ID: "" (optional; RBAC feature) - ENDPOINT_CONFIG_AVAILABLE: "" (optional) + ENDPOINT_CONFIG_AVAILABLE: "" (optional; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114) volumes: - :/usr/src/app/dist/Logo (optional; Corporate Design) ```