From bf52bc3d1dcedeee96c5bef6d6231ff9f5689ee9 Mon Sep 17 00:00:00 2001 From: Jan Friedenstab <8794084+jfriedenstab@users.noreply.github.com> Date: Thu, 5 Oct 2023 19:44:38 +0200 Subject: [PATCH] docs(web-modeler): document feature flag for enabling the Marketplace integration --- .../configuration/configuration.md | 26 ++++++++++++------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/self-managed/modeler/web-modeler/configuration/configuration.md b/docs/self-managed/modeler/web-modeler/configuration/configuration.md index adf53407774..fe09eb3dc01 100644 --- a/docs/self-managed/modeler/web-modeler/configuration/configuration.md +++ b/docs/self-managed/modeler/web-modeler/configuration/configuration.md @@ -78,16 +78,22 @@ Refer to the [Advanced Logging Configuration Guide](./logging.md#logging-configu ### General -| Environment variable | Description | Example value | Default value | -| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------- | -| `SERVER_URL` | URL at which users access Web Modeler in the browser.
_Note_: To use a sub path for Web Modeler, just include the path in the URL. | `https://modeler.example.com`,
`https://example.com/modeler` | - | -| `SERVER_HTTPS_ONLY` | Enforce the usage of HTTPS when users access Web Modeler (by redirecting from `http://` to `https://`). | `true` | `false` | -| `RESTAPI_HOST` | [Internal](#notes-on-host-names-and-port-numbers) host name of the `restapi` application. | `modeler-restapi` | - | -| `RESTAPI_PORT` | [Internal](#notes-on-host-names-and-port-numbers) port number on which the `restapi` serves the regular API endpoints. | `8081` | `8081` | -| `RESTAPI_MANAGEMENT_PORT` | [Internal](#notes-on-host-names-and-port-numbers) port number on which the `restapi` serves the management API endpoints. | `8091` | `8091` | -| `PLAY_ENABLED` | [optional]
Enables the [**Play** mode](../../../../components/modeler/web-modeler/play-your-process.md) in the BPMN editor, allowing users to test processes in a playground environment. | `true` | `false` | -| `ZEEBE_BPMN_DEPLOYMENT_ENABLED` | [optional]
Enables the [**Deploy** and **Run**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) actions in the BPMN editor.
When disabled, it prevents users from deploying and starting instances of processes via the UI. | `false` | `true` | -| `ZEEBE_DMN_DEPLOYMENT_ENABLED` | [optional]
Enables the [**Deploy**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) action in the DMN editor.
When disabled, it prevents users from deploying decisions via the UI. | `false` | `true` | +| Environment variable | Description | Example value | Default value | +| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------- | +| `SERVER_URL` | URL at which users access Web Modeler in the browser.
_Note_: To use a sub path for Web Modeler, just include the path in the URL. | `https://modeler.example.com`,
`https://example.com/modeler` | - | +| `SERVER_HTTPS_ONLY` | Enforce the usage of HTTPS when users access Web Modeler (by redirecting from `http://` to `https://`). | `true` | `false` | +| `RESTAPI_HOST` | [Internal](#notes-on-host-names-and-port-numbers) host name of the `restapi` application. | `modeler-restapi` | - | +| `RESTAPI_PORT` | [Internal](#notes-on-host-names-and-port-numbers) port number on which the `restapi` serves the regular API endpoints. | `8081` | `8081` | +| `RESTAPI_MANAGEMENT_PORT` | [Internal](#notes-on-host-names-and-port-numbers) port number on which the `restapi` serves the management API endpoints. | `8091` | `8091` | + +### Feature Flags + +| Environment variable | Description | Example value | Default value | +| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------- | +| `PLAY_ENABLED` | [optional]
Enables the [**Play** mode](../../../../components/modeler/web-modeler/play-your-process.md) in the BPMN editor, allowing users to test processes in a playground environment. | `true` | `false` | +| `ZEEBE_BPMN_DEPLOYMENT_ENABLED` | [optional]
Enables the [**Deploy** and **Run**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) actions in the BPMN editor.
When disabled, it prevents users from deploying and starting instances of processes via the UI. | `false` | `true` | +| `ZEEBE_DMN_DEPLOYMENT_ENABLED` | [optional]
Enables the [**Deploy**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) action in the DMN editor.
When disabled, it prevents users from deploying decisions via the UI. | `false` | `true` | +| `MARKETPLACE_ENABLED` | [optional]
Enables the integration of the [Camunda Marketplace](https://marketplace.camunda.com). If enabled, users can browse the Marketplace and download [Connectors](../../../../components/connectors/introduction.md) directly inside Web Modeler. | `false` | `true` | ### Identity / Keycloak