From 1049782c36539e2494cc2d926b0fb260c8ca6b16 Mon Sep 17 00:00:00 2001 From: James Kropiwka Date: Wed, 2 Jul 2025 16:41:45 -0400 Subject: [PATCH 1/6] [WIP] Add Admin UI configuration page. --- .../service-config/adminUI-configuration.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 content/reference/service-config/adminUI-configuration.md diff --git a/content/reference/service-config/adminUI-configuration.md b/content/reference/service-config/adminUI-configuration.md new file mode 100644 index 000000000..2cba4d63a --- /dev/null +++ b/content/reference/service-config/adminUI-configuration.md @@ -0,0 +1,53 @@ +--- +title: 'Admin UI configuration' +categories: ["reference"] +description: List of Evnironmental Variables and their description +weight: 900 +--- + +The Rhize Admin UI Evnironmental variables used for configuration. + +## `Preact ENV Variables` + + All Preact Environmental Variables, what they do and what there default value is. + +| Attribute | Description | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `NODE_ENV` | I dont know what this one is used for | +| `PREACT_APP_AMPLITUDE_API_KEY` | The Amplitude API Key. (Default: 30) | +| `PREACT_APP_APOLLO_CLIENT` | The Apollo Client URL.
(Default: None, but typically http://localhost:4000 when running locally)  | +| `PREACT_APP_APOLLO_CLIENT_ADMIN` | The Apollo Client Admin URL.
(Default: None, but typically http://localhost:4000 when running locally)  | +| `PREACT_APP_APOLLO_JSONATA_CLIENT` | The Jsonata Client URL used for running the jsonata playground.
(Default: none)  | +| `PREACT_APP_APPSMITH_PORTAL` | Shows the appsmith portal page in the admin ui if true.
(Default: false)  | +| `PREACT_APP_AUTH_KEYCLOAK_CLIENT_ID` | The Keycloak Realms Client ID.
(Default: 30)  | +| `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloaks logout URL.
(Default: 30)  | +| `PREACT_APP_AUTH_KEYCLOAK_REALM` | The Keycloak Realm.
(Default: none)  | +| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keybloack Realms Client IDs Secret Key.
(Default: none)  | +| `PREACT_APP_AUTH_KEYCLOAK_SERVER_URL` | The Keycloak Server URL.
(None, but typically http://localhost:8080 when running)  | +| `PREACT_APP_DEBUG` | Will put admin ui page in debug mode if true.
(Default: false)  | +| `PREACT_APP_GRAPHIQL_ENABLED` | Uses graphiql playground if true else uses apollo sandbox.
(Default: false)  | +| `PREACT_APP_LIBRE_DATA_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.
(Default: 15)  | +| `PREACT_APP_LIBRE_VERSION` | The libre version.
(Default: none)  | +| `PREACT_APP_MAPBOX_API_KEY` | I dont know what this one is.
(Default: none)  | +| `PREACT_APP_VERSION` | The schema version.
(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
| +| `CYPRESS_LOGIN_ADMIN_EMAIL` | The Cypress Testing Email.
| +| `CYPRESS_LOGIN_ADMIN_PASSWORD` | The Cypress Testing Password.
| + +## `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. Probably Deprecated | +| `PREACT_APP_PRODUCTION` | This one is not being used anywhere in the admin ui. Probably Deprecated | \ No newline at end of file From af91778714a9cc92c012edf9a0454b0dae99712d Mon Sep 17 00:00:00 2001 From: James Kropiwka Date: Thu, 3 Jul 2025 14:05:02 -0400 Subject: [PATCH 2/6] Update Descriptions and Default Cases --- .../service-config/adminUI-configuration.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/content/reference/service-config/adminUI-configuration.md b/content/reference/service-config/adminUI-configuration.md index 2cba4d63a..d391ff5f5 100644 --- a/content/reference/service-config/adminUI-configuration.md +++ b/content/reference/service-config/adminUI-configuration.md @@ -13,23 +13,23 @@ The Rhize Admin UI Evnironmental variables used for configuration. | Attribute | Description | |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `NODE_ENV` | I dont know what this one is used for | -| `PREACT_APP_AMPLITUDE_API_KEY` | The Amplitude API Key. (Default: 30) | -| `PREACT_APP_APOLLO_CLIENT` | The Apollo Client URL.
(Default: None, but typically http://localhost:4000 when running locally)  | -| `PREACT_APP_APOLLO_CLIENT_ADMIN` | The Apollo Client Admin URL.
(Default: None, but typically http://localhost:4000 when running locally)  | +| `NODE_ENV` | If true will also put admin ui into debug mode. This and PREACT_APP_DEBUG.
(Default: false) | +| `PREACT_APP_AMPLITUDE_API_KEY` | The Amplitude API Key.
(Default: None) | +| `PREACT_APP_APOLLO_CLIENT` | The Apollo Client URL.
(Default: None, http://localhost:4000 when running locally)  | +| `PREACT_APP_APOLLO_CLIENT_ADMIN` | The Apollo Client Admin URL.
(Default: None, http://localhost:4000 when running locally)  | | `PREACT_APP_APOLLO_JSONATA_CLIENT` | The Jsonata Client URL used for running the jsonata playground.
(Default: none)  | | `PREACT_APP_APPSMITH_PORTAL` | Shows the appsmith portal page in the admin ui if true.
(Default: false)  | -| `PREACT_APP_AUTH_KEYCLOAK_CLIENT_ID` | The Keycloak Realms Client ID.
(Default: 30)  | -| `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloaks logout URL.
(Default: 30)  | -| `PREACT_APP_AUTH_KEYCLOAK_REALM` | The Keycloak Realm.
(Default: none)  | -| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keybloack Realms Client IDs Secret Key.
(Default: none)  | -| `PREACT_APP_AUTH_KEYCLOAK_SERVER_URL` | The Keycloak Server URL.
(None, but typically http://localhost:8080 when running)  | +| `PREACT_APP_AUTH_KEYCLOAK_CLIENT_ID` | The Keycloak Realms Client ID.
(Default: none, libreUI when running locally)  | +| `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloaks logout URL.
(Default: None, libre when running locally)  | +| `PREACT_APP_AUTH_KEYCLOAK_REALM` | The Keycloak Realm.
(Default: None)  | +| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keybloack Realms Client IDs Secret Key.
(Default: None)  | +| `PREACT_APP_AUTH_KEYCLOAK_SERVER_URL` | The Keycloak Server URL.
(None, http://localhost:8080 when running)  | | `PREACT_APP_DEBUG` | Will put admin ui page in debug mode if true.
(Default: false)  | | `PREACT_APP_GRAPHIQL_ENABLED` | Uses graphiql playground if true else uses apollo sandbox.
(Default: false)  | -| `PREACT_APP_LIBRE_DATA_MIGRATION_URI` | This one is not being used currently in the admin ui but is commented out  | +| `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.
(Default: 15)  | | `PREACT_APP_LIBRE_VERSION` | The libre version.
(Default: none)  | -| `PREACT_APP_MAPBOX_API_KEY` | I dont know what this one is.
(Default: none)  | +| `PREACT_APP_MAPBOX_API_KEY` | The mapbox access token api key.
(Default: none)  | | `PREACT_APP_VERSION` | The schema version.
(Default: none)  | | `PREACT_APP_WORK_MASTER_UI_ENABLED` | Uses the new work master page if true, else uses old work master page.  | @@ -49,5 +49,5 @@ The Rhize Admin UI Evnironmental variables used for configuration. | Attribute | Description | |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `PREACT_APP_NAME` | This one is not being used anywhere in the admin ui. Probably Deprecated | -| `PREACT_APP_PRODUCTION` | This one is not being used anywhere in the admin ui. Probably Deprecated | \ No newline at end of file +| `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 Dockefile. Probably Deprecated | \ No newline at end of file From 2175e6cbe647d5059c34911a098a5186e0490669 Mon Sep 17 00:00:00 2001 From: James Kropiwka Date: Thu, 3 Jul 2025 14:10:50 -0400 Subject: [PATCH 3/6] Fix spelling errors --- .../service-config/adminUI-configuration.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/reference/service-config/adminUI-configuration.md b/content/reference/service-config/adminUI-configuration.md index d391ff5f5..e43c7cbb6 100644 --- a/content/reference/service-config/adminUI-configuration.md +++ b/content/reference/service-config/adminUI-configuration.md @@ -1,11 +1,11 @@ --- title: 'Admin UI configuration' categories: ["reference"] -description: List of Evnironmental Variables and their description +description: List of Environmental Variables and their description weight: 900 --- -The Rhize Admin UI Evnironmental variables used for configuration. +The Rhize Admin UI Environmental variables used for configuration. ## `Preact ENV Variables` @@ -13,20 +13,20 @@ The Rhize Admin UI Evnironmental variables used for configuration. | Attribute | Description | |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `NODE_ENV` | If true will also put admin ui into debug mode. This and PREACT_APP_DEBUG.
(Default: false) | +| `NODE_ENV` | If true will also put admin UI into debug mode. This and PREACT_APP_DEBUG.
(Default: false) | | `PREACT_APP_AMPLITUDE_API_KEY` | The Amplitude API Key.
(Default: None) | | `PREACT_APP_APOLLO_CLIENT` | The Apollo Client URL.
(Default: None, http://localhost:4000 when running locally)  | | `PREACT_APP_APOLLO_CLIENT_ADMIN` | The Apollo Client Admin URL.
(Default: None, http://localhost:4000 when running locally)  | -| `PREACT_APP_APOLLO_JSONATA_CLIENT` | The Jsonata Client URL used for running the jsonata playground.
(Default: none)  | -| `PREACT_APP_APPSMITH_PORTAL` | Shows the appsmith portal page in the admin ui if true.
(Default: false)  | +| `PREACT_APP_APOLLO_JSONATA_CLIENT` | The JSONata Client URL used for running the JSONata playground.
(Default: none)  | +| `PREACT_APP_APPSMITH_PORTAL` | Shows the Appsmith portal page in the admin UI if true.
(Default: false)  | | `PREACT_APP_AUTH_KEYCLOAK_CLIENT_ID` | The Keycloak Realms Client ID.
(Default: none, libreUI when running locally)  | | `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloaks logout URL.
(Default: None, libre when running locally)  | | `PREACT_APP_AUTH_KEYCLOAK_REALM` | The Keycloak Realm.
(Default: None)  | -| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keybloack Realms Client IDs Secret Key.
(Default: None)  | +| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keycloak Realms Client IDs Secret Key.
(Default: None)  | | `PREACT_APP_AUTH_KEYCLOAK_SERVER_URL` | The Keycloak Server URL.
(None, http://localhost:8080 when running)  | -| `PREACT_APP_DEBUG` | Will put admin ui page in debug mode if true.
(Default: false)  | +| `PREACT_APP_DEBUG` | Will put admin UI page in debug mode if true.
(Default: false)  | | `PREACT_APP_GRAPHIQL_ENABLED` | Uses graphiql playground if true else uses apollo sandbox.
(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_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.
(Default: 15)  | | `PREACT_APP_LIBRE_VERSION` | The libre version.
(Default: none)  | | `PREACT_APP_MAPBOX_API_KEY` | The mapbox access token api key.
(Default: none)  | @@ -49,5 +49,5 @@ The Rhize Admin UI Evnironmental variables used for configuration. | 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 Dockefile. Probably Deprecated | \ No newline at end of file +| `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 Dockefile. Probably Deprecated | \ No newline at end of file From 720bfb9aea4f101ee23b0058d71d163d32ef5967 Mon Sep 17 00:00:00 2001 From: James Kropiwka Date: Thu, 3 Jul 2025 14:16:37 -0400 Subject: [PATCH 4/6] Fix more grammar errors --- content/reference/service-config/adminUI-configuration.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/reference/service-config/adminUI-configuration.md b/content/reference/service-config/adminUI-configuration.md index e43c7cbb6..64db2bd1f 100644 --- a/content/reference/service-config/adminUI-configuration.md +++ b/content/reference/service-config/adminUI-configuration.md @@ -22,14 +22,14 @@ The Rhize Admin UI Environmental variables used for configuration. | `PREACT_APP_AUTH_KEYCLOAK_CLIENT_ID` | The Keycloak Realms Client ID.
(Default: none, libreUI when running locally)  | | `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloaks logout URL.
(Default: None, libre when running locally)  | | `PREACT_APP_AUTH_KEYCLOAK_REALM` | The Keycloak Realm.
(Default: None)  | -| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keycloak Realms Client IDs Secret Key.
(Default: None)  | +| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keycloak Realm's Client IDs Secret Key.
(Default: None)  | | `PREACT_APP_AUTH_KEYCLOAK_SERVER_URL` | The Keycloak Server URL.
(None, http://localhost:8080 when running)  | | `PREACT_APP_DEBUG` | Will put admin UI page in debug mode if true.
(Default: false)  | -| `PREACT_APP_GRAPHIQL_ENABLED` | Uses graphiql playground if true else uses apollo sandbox.
(Default: false)  | +| `PREACT_APP_GRAPHIQL_ENABLED` | Uses GraphiQL playground if true else uses apollo sandbox.
(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.
(Default: 15)  | | `PREACT_APP_LIBRE_VERSION` | The libre version.
(Default: none)  | -| `PREACT_APP_MAPBOX_API_KEY` | The mapbox access token api key.
(Default: none)  | +| `PREACT_APP_MAPBOX_API_KEY` | The Mapbox access token API key.
(Default: none)  | | `PREACT_APP_VERSION` | The schema version.
(Default: none)  | | `PREACT_APP_WORK_MASTER_UI_ENABLED` | Uses the new work master page if true, else uses old work master page.  | @@ -39,7 +39,7 @@ The Rhize Admin UI Environmental variables used for configuration. | Attribute | Description | |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `CYPRESS_FRONTEND_TESTING_DOMAIN` | The Cypress Frontend Testing Domain url
| +| `CYPRESS_FRONTEND_TESTING_DOMAIN` | The Cypress Frontend Testing Domain URL
| | `CYPRESS_LOGIN_ADMIN_EMAIL` | The Cypress Testing Email.
| | `CYPRESS_LOGIN_ADMIN_PASSWORD` | The Cypress Testing Password.
| From e04a9d334f0a8138fe769c37d2422ba3983092ca Mon Sep 17 00:00:00 2001 From: JamesKropiwka1 Date: Mon, 7 Jul 2025 17:45:27 -0400 Subject: [PATCH 5/6] Update accept.txt --- .github/styles/config/vocabularies/docs/accept.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/styles/config/vocabularies/docs/accept.txt b/.github/styles/config/vocabularies/docs/accept.txt index 4ccc92ffa..7a004b4f9 100644 --- a/.github/styles/config/vocabularies/docs/accept.txt +++ b/.github/styles/config/vocabularies/docs/accept.txt @@ -4,6 +4,7 @@ APIs Appsmith Bitnami +Dockerfile Grafana JSONata JWT @@ -12,7 +13,9 @@ JetStream KPI KPIs Keycloak +Mapbox NATS +Preact URI URIs [Aa]ctuals From cba00fb15cd3cd8a92cfebb2c10f4c3a8b6ac0ed Mon Sep 17 00:00:00 2001 From: James Kropiwka Date: Mon, 7 Jul 2025 18:12:49 -0400 Subject: [PATCH 6/6] Fix spelling mistakes --- content/reference/service-config/adminUI-configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/reference/service-config/adminUI-configuration.md b/content/reference/service-config/adminUI-configuration.md index 64db2bd1f..c005d2c9d 100644 --- a/content/reference/service-config/adminUI-configuration.md +++ b/content/reference/service-config/adminUI-configuration.md @@ -20,9 +20,9 @@ The Rhize Admin UI Environmental variables used for configuration. | `PREACT_APP_APOLLO_JSONATA_CLIENT` | The JSONata Client URL used for running the JSONata playground.
(Default: none)  | | `PREACT_APP_APPSMITH_PORTAL` | Shows the Appsmith portal page in the admin UI if true.
(Default: false)  | | `PREACT_APP_AUTH_KEYCLOAK_CLIENT_ID` | The Keycloak Realms Client ID.
(Default: none, libreUI when running locally)  | -| `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloaks logout URL.
(Default: None, libre when running locally)  | +| `PREACT_APP_AUTH_KEYCLOAK_LOGOUT_URI` | The Keycloak logout URL.
(Default: None, libre when running locally)  | | `PREACT_APP_AUTH_KEYCLOAK_REALM` | The Keycloak Realm.
(Default: None)  | -| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keycloak Realm's Client IDs Secret Key.
(Default: None)  | +| `PREACT_APP_AUTH_KEYCLOAK_SECRET` | The Keycloak Realms Client IDs Secret Key.
(Default: None)  | | `PREACT_APP_AUTH_KEYCLOAK_SERVER_URL` | The Keycloak Server URL.
(None, http://localhost:8080 when running)  | | `PREACT_APP_DEBUG` | Will put admin UI page in debug mode if true.
(Default: false)  | | `PREACT_APP_GRAPHIQL_ENABLED` | Uses GraphiQL playground if true else uses apollo sandbox.
(Default: false)  | @@ -50,4 +50,4 @@ The Rhize Admin UI Environmental variables used for configuration. | 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 Dockefile. Probably Deprecated | \ No newline at end of file +| `PREACT_APP_PRODUCTION` | This one is not being used anywhere in the admin UI, just shows up in Dockerfile. Probably Deprecated | \ No newline at end of file