Skip to content

Commit

Permalink
feat(console-sm): add envvar to disable auth
Browse files Browse the repository at this point in the history
  • Loading branch information
@urbanisierung
urbanisierung committed May 15, 2024
1 parent 7f7840b commit 9226e7a
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/self-managed/console-deployment/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,18 @@ Console Self-Managed can be configured using environment variables and configura

## Environment variables

| Environment variable | Description | Example value |
| -------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------- |
| `KEYCLOAK_BASE_URL` | Base URL for Keycloak | https://example.com/auth |
| `KEYCLOAK_INTERNAL_BASE_URL` | Internal Base URL for Keycloak | http://camunda-platform-keycloak:80/auth |
| `KEYCLOAK_REALM` | Realm for Keycloak | camunda-platform |
| `CAMUNDA_IDENTITY_AUDIENCE` | Audience for Console client | console |
| `CAMUNDA_IDENTITY_CLIENT_ID` | Client Id for Console client | console |
| `CAMUNDA_CONSOLE_CONTEXT_PATH` | Context path for Console | console |
| `CAMUNDA_CONSOLE_CUSTOMERID` | Unique identifier of the customer | `customer-id` |
| `CAMUNDA_CONSOLE_INSTALLATIONID` | Unique installation id of the current customer installation | `installation-id` |
| `CAMUNDA_CONSOLE_TELEMETRY` | Telemetry config for Console Self-Managed: `disabled`, `online` or `download` | `online` |
| Environment variable | Description | Example value |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| `KEYCLOAK_BASE_URL` | Base URL for Keycloak | https://example.com/auth |
| `KEYCLOAK_INTERNAL_BASE_URL` | Internal Base URL for Keycloak | http://camunda-platform-keycloak:80/auth |
| `KEYCLOAK_REALM` | Realm for Keycloak | camunda-platform |
| `CAMUNDA_IDENTITY_AUDIENCE` | Audience for Console client | console |
| `CAMUNDA_IDENTITY_CLIENT_ID` | Client Id for Console client | console |
| `CAMUNDA_CONSOLE_CONTEXT_PATH` | Context path for Console | console |
| `CAMUNDA_CONSOLE_CUSTOMERID` | Unique identifier of the customer | `customer-id` |
| `CAMUNDA_CONSOLE_INSTALLATIONID` | Unique installation id of the current customer installation | `installation-id` |
| `CAMUNDA_CONSOLE_TELEMETRY` | Telemetry config for Console Self-Managed: `disabled`, `online` or `download` | `online` |
| `CAMUNDA_CONSOLE_DISABLE_AUTH` | Disables authentication for Console. With this option set users don't have to login to use Console and API requests can be executed without an Authorization header. <br /> By disabling authentication all `CAMUNDA_IDENTITY` variables won't be used. | `true` |

Console environment variables could be set in Helm via the `console.env` key. For more details, check [Console Helm values](https://artifacthub.io/packages/helm/camunda/camunda-platform#console-parameters).

Expand Down

0 comments on commit 9226e7a

Please sign in to comment.