Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for aas-gui ENV variable ENDPOINT_CONFIG_AVAILABLE #25

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Add documentation for aas-gui ENV variable ENDPOINT_CONFIG_AVAILABLE #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf46941
Add ENDPOINT_CONFIG_AVAILABLE
seicke Nov 12, 2024
1d992cf
Add note for docker image tag
seicke Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...ce/content/user_documentation/basyx_components/web_ui/features/docker_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/source/content/user_documentation/basyx_components/web_ui/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```
Expand Down