Skip to content
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.

Sign up for GitHub

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

docs(web-modeler): document feature flag for enabling the Marketplace integration #2709

Merged
merged 2 commits into from
Oct 9, 2023
Merged

docs(web-modeler): document feature flag for enabling the Marketplace integration #2709

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf52bc3
docs(web-modeler): document feature flag for enabling the Marketplace…
jfriedenstab Oct 5, 2023
229cf93
Merge branch 'main' into web-modeler-6366-marketplace-feature-flag
christinaausley Oct 6, 2023
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
26 changes: 16 additions & 10 deletions docs/self-managed/modeler/web-modeler/configuration/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/>_Note_: To use a sub path for Web Modeler, just include the path in the URL. | `https://modeler.example.com`,<br/>`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]<br/>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]<br/>Enables the [**Deploy** and **Run**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) actions in the BPMN editor.<br/>When disabled, it prevents users from deploying and starting instances of processes via the UI. | `false` | `true` |
| `ZEEBE_DMN_DEPLOYMENT_ENABLED` | [optional]<br/>Enables the [**Deploy**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) action in the DMN editor.<br/>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.<br/>_Note_: To use a sub path for Web Modeler, just include the path in the URL. | `https://modeler.example.com`,<br/>`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]<br/>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]<br/>Enables the [**Deploy** and **Run**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) actions in the BPMN editor.<br/>When disabled, it prevents users from deploying and starting instances of processes via the UI. | `false` | `true` |
| `ZEEBE_DMN_DEPLOYMENT_ENABLED` | [optional]<br/>Enables the [**Deploy**](../../../../components/modeler/web-modeler/run-or-publish-your-process.md) action in the DMN editor.<br/>When disabled, it prevents users from deploying decisions via the UI. | `false` | `true` |
| `MARKETPLACE_ENABLED` | [optional]<br/>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

Expand Down