Add documentation for light/dark theme ENV variables (aas-gui) (#26)

* Add documentation for light/dark theme ENV variables (aas-gui) * Add note for docker image tag
eclipse-basyx · Nov 26, 2024 · d894249 · d894249
1 parent 889c14d
commit d894249
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/...content/user_documentation/basyx_components/web_ui/features/corporate_design.md b/...content/user_documentation/basyx_components/web_ui/features/corporate_design.md
@@ -11,6 +11,8 @@ The corporate design can be applied through Docker.
 
 When using **Docker run**, you can add the logos by mounting a local folder containing the main logo (Logo.png/jpg/svg) and the favicon (browser tab icon) named favicon.ico. The primary color can be configured by using the *PRIMARY_COLOR* environment variable. It expects a color value in hex format.
 
+Please note, that the logo and primary color for the light and dark theme can be configured separately (starting with eclipsebasyx/aas-gui:v2-241114) using *PRIMARY_LIGHT_COLOR*, *PRIMARY_DARK_COLOR* respectivly *LOGO_LIGHT_PATH* and *LOGO_DARK_PATH*.
+
 `docker run -p 3000:3000 -v <local_path_to_logo>:/usr/src/app/dist/Logo -e LOGO_PATH=Logo/<your-logo.png> -e VITE_PRIMARY_COLOR=<primary_color> eclipsebasyx/aas-gui`
 The same feature can also be adapted for **Docker compose**:
 

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
@@ -24,7 +24,11 @@ The following environment variables can be used to configure the AAS Web UI:
 | CD_REPO_PATH | The path to the Concept Description Repository |
 | DASHBOARD_SERVICE_PATH | The path to the Dashboard Service |
 | PRIMARY_COLOR | The primary color of the AAS Web UI |
+| PRIMARY_LIGHT_COLOR | The primary color of the AAS Web UI of the light theme (ENV variable available starting with eclipsebasyx/aas-gui:v2-241114) |
+| PRIMARY_DARK_COLOR | The primary color of the AAS Web UI of the dark theme (ENV variable available starting with eclipsebasyx/aas-gui:v2-241114) |
 | LOGO_PATH | The path to the application logo inside the container `Logo/<your-logo.png>` |
+| LOGO_LIGHT_PATH | The path to the application logo of the dark theme inside the container `Logo/<your-logo.png>` (ENV variable available starting with eclipsebasyx/aas-gui:v2-241114) |
+| LOGO_DARK_PATH | The path to the application logo of the dark theme inside the container `Logo/<your-logo.png>` (ENV variable available starting with eclipsebasyx/aas-gui:v2-241114) |
 | BASE_PATH | The base path of the AAS Web UI |
 | INFLUXDB_TOKEN | The token for accessing time series data from an InfluxDB |
 | KEYCLOAK_URL | The URL of the Keycloak server used as identity provider for RBAC |
@@ -70,7 +74,11 @@ services:
             CD_REPO_PATH: "<concept_description_repo_path>"
             DASHBOARD_SERVICE_PATH: "<dashboard_service_path>" (optional; Time Series Data)
             PRIMARY_COLOR: "<primary_color>" (optional; Corporate Design)
+            PRIMARY_LIGHT_COLOR: "<primary_light_color>" (optional; Corporate Design light theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
+            PRIMARY_DARK_COLOR: "<primary_dark_color>" (optional; Corporate Design dark theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
             LOGO_PATH: "<logo_path_in_container>" (optional; Corporate Design)
+            LOGO_LIGHT_PATH: "<logo_light_path_in_container>" (optional; Corporate Design light theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
+            LOGO_DARK_PATH: "<logo_dark_path_in_container>" (optional; Corporate Design dark theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
             BASE_PATH: "<base_path>" (optional)
             INFLUXDB_TOKEN: "<influxdb_token>" (optional; Time Series Data)
             KEYCLOAK_URL: "<keycloak_url>" (optional; RBAC feature)

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
@@ -125,7 +125,11 @@ services:
             CD_REPO_PATH: "<concept_description_repo_path>"
             DASHBOARD_SERVICE_PATH: "<dashboard_service_path>" (optional; Time Series Data)
             PRIMARY_COLOR: "<primary_color>" (optional; Corporate Design)
+            PRIMARY_LIGHT_COLOR: "<primary_light_color>" (optional; Corporate Design light theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
+            PRIMARY_DARK_COLOR: "<primary_dark_color>" (optional; Corporate Design dark theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
             LOGO_PATH: "<logo_path_in_container>" (optional; Corporate Design)
+            LOGO_LIGHT_PATH: "<logo_light_path_in_container>" (optional; Corporate Design light theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
+            LOGO_DARK_PATH: "<logo_dark_path_in_container>" (optional; Corporate Design dark theme; ENV variable available starting with eclipsebasyx/aas-gui:v2-241114)
             BASE_PATH: "<base_path>" (optional)
             INFLUXDB_TOKEN: "<influxdb_token>" (optional; Time Series Data)
             KEYCLOAK_URL: "<keycloak_url>" (optional; RBAC feature)