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 diff --git a/content/reference/service-config/adminUI-configuration.md b/content/reference/service-config/adminUI-configuration.md new file mode 100644 index 000000000..c005d2c9d --- /dev/null +++ b/content/reference/service-config/adminUI-configuration.md @@ -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.
(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: none, libreUI 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 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` | 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_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, 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 | \ No newline at end of file