Skip to content

Admin UI configuration #189

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.

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/styles/config/vocabularies/docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
APIs
Appsmith
Bitnami
Dockerfile
Grafana
JSONata
JWT
Expand All @@ -12,7 +13,9 @@ JetStream
KPI
KPIs
Keycloak
Mapbox
NATS
Preact
URI
URIs
[Aa]ctuals
Expand Down
53 changes: 53 additions & 0 deletions content/reference/service-config/adminUI-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: 'Admin UI configuration'
categories: ["reference"]
description: List of Environmental Variables and their description
weight: 900
---

The Rhize Admin UI Environmental variables used for configuration.

## `Preact ENV Variables`

All Preact Environmental Variables, what they do and what there default value is.

| Attribute | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `NODE_ENV` | If true will also put admin UI into debug mode. This and PREACT_APP_DEBUG. <br />(Default: false) |
| `PREACT_APP_AMPLITUDE_API_KEY` | The Amplitude API Key. <br />(Default: None) |
| `PREACT_APP_APOLLO_CLIENT` | The Apollo Client URL. <br />(Default: None, http://localhost:4000 when running locally)  |
| `PREACT_APP_APOLLO_CLIENT_ADMIN` | The Apollo Client Admin URL. <br />(Default: None, http://localhost:4000 when running locally)  |
| `PREACT_APP_APOLLO_JSONATA_CLIENT` | The JSONata Client URL used for running the JSONata playground. <br />(Default: none)  |
| `PREACT_APP_APPSMITH_PORTAL` | Shows the Appsmith portal page in the admin UI if true. <br />(Default: false)  |
| `PREACT_APP_AUTH_KEYCLOAK_CLIENT_ID` | The Keycloak Realms Client ID. <br />(Default: none, libreUI when running locally)  |
| `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloak logout URL. <br />(Default: None, libre when running locally)  |
| `PREACT_APP_AUTH_KEYCLOAK_REALM` | The Keycloak Realm. <br />(Default: None)  |
| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keycloak Realms Client IDs Secret Key. <br />(Default: None)  |
| `PREACT_APP_AUTH_KEYCLOAK_SERVER_URL` | The Keycloak Server URL. <br />(None, http://localhost:8080 when running)  |
| `PREACT_APP_DEBUG` | Will put admin UI page in debug mode if true. <br />(Default: false)  |
| `PREACT_APP_GRAPHIQL_ENABLED` | Uses GraphiQL playground if true else uses apollo sandbox. <br />(Default: false)  |
| `PREACT_APP_LIBRE_DATA_MIGRATION_URI` | The migration URI. This one is not being used currently in the admin UI but is commented out  |
| `PREACT_APP_LIBRE_PAGE_LIMIT` | The libre table page size. <br />(Default: 15)  |
| `PREACT_APP_LIBRE_VERSION` | The libre version. <br />(Default: none)  |
| `PREACT_APP_MAPBOX_API_KEY` | The Mapbox access token API key. <br />(Default: none)  |
| `PREACT_APP_VERSION` | The schema version. <br />(Default: none)  |
| `PREACT_APP_WORK_MASTER_UI_ENABLED` | Uses the new work master page if true, else uses old work master page.  |

## `Cypress ENV Variables`

All Cypress Environmental Variables, what they do and what there default value is.

| Attribute | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `CYPRESS_FRONTEND_TESTING_DOMAIN` | The Cypress Frontend Testing Domain URL <br /> |
| `CYPRESS_LOGIN_ADMIN_EMAIL` | The Cypress Testing Email. <br /> |
| `CYPRESS_LOGIN_ADMIN_PASSWORD` | The Cypress Testing Password. <br /> |

## `Deprecated ENV Variables`

All Deprecated Environmental Variables, what they do and what there default value is.

| Attribute | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `PREACT_APP_NAME` | This one is not being used anywhere in the admin UI, just shows up in .env.example and Dockerfile. Probably Deprecated |
| `PREACT_APP_PRODUCTION` | This one is not being used anywhere in the admin UI, just shows up in Dockerfile. Probably Deprecated |
Loading