diff --git a/docs/self-managed/modeler/web-modeler/configuration/configuration.md b/docs/self-managed/modeler/web-modeler/configuration/configuration.md index 9b989e42c7..5d88771c2f 100644 --- a/docs/self-managed/modeler/web-modeler/configuration/configuration.md +++ b/docs/self-managed/modeler/web-modeler/configuration/configuration.md @@ -140,6 +140,20 @@ Refer to the [advanced SSL configuration guide](./ssl.md) for additional details | `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` | +### Proxy + +These settings are useful when the application needs to make outgoing network requests in environments that require traffic to pass through a proxy server. + +| Environment variable | Description | Example value | Default value | +| -------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | ------------- | +| `http_proxy` | Specifies the proxy server to be used for outgoing HTTP requests. | `http://proxy.example.com:8080` | - | +| `https_proxy` | Specifies the proxy server to be used for outgoing HTTPS requests. | `https://secureproxy.example.com:443` | - | +| `no_proxy` | A comma-separated list of domain names or IP addresses for which the proxy should be bypassed. | `localhost,127.0.0.1,.example.com` | - | + +:::note +The proxy-related environment variables are lowercase because they follow a widely accepted convention used in many system environments and tools. +::: + ### Feature Flags | Environment variable | Description | Example value | Default value | @@ -181,10 +195,13 @@ The `webapp` component sends certain events (e.g. "user opened diagram", "user l ### Logging -| Environment variable | Description | Example value | -| -------------------- | -------------------------------------- | ---------------------------- | -| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| Environment variable | Description | Example value | +| -------------------- | ----------------------------------------------- | ---------------------------- | +| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| `LOG_LEVEL_CLIENT` | [optional]
Log level for the client | `DEBUG` | +| `LOG_LEVEL_WEBAPP` | [optional]
Log level for the Node.js server | `DEBUG` | +The `LOG_LEVEL_*` options can be found [here](../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). Refer to the [Advanced Logging Configuration Guide](./logging.md#logging-configuration-for-the-webapp-component) for additional details on how to customize the `webapp` logging output. ### SSL diff --git a/docs/self-managed/modeler/web-modeler/configuration/logging.md b/docs/self-managed/modeler/web-modeler/configuration/logging.md index 307a2ea773..ab86be8bc3 100644 --- a/docs/self-managed/modeler/web-modeler/configuration/logging.md +++ b/docs/self-managed/modeler/web-modeler/configuration/logging.md @@ -38,6 +38,16 @@ To enable additional log output to a file, adjust the following environment vari LOG_FILE_PATH=/full/path/to/log/file.log ``` +### Configuring log levels + +To control the verbosity of the logs, adjust the environment variables `LOG_LEVEL_CLIENT` (browser client) and `LOG_LEVEL_WEBAPP` (Node.js server). + +```properties +LOG_LEVEL_CLIENT=DEBUG +``` + +The `LOG_LEVEL_*` options can be found [here](../../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). + ## Logging configuration for the `websocket` component By default, the `websocket` component logs to the Docker container's standard output. diff --git a/docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md b/docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md new file mode 100644 index 0000000000..6059d9bed8 --- /dev/null +++ b/docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md @@ -0,0 +1,36 @@ +--- +id: troubleshoot-proxy-configuration +title: "Troubleshoot proxy configuration issues" +sidebar_label: "Proxy configuration" +description: "Troubleshooting guide for issues caused by incorrect proxy configuration in Web Modeler." +--- + +Troubleshoot and resolve issues in Web Modeler caused by incorrect or incomplete proxy configuration. + +## Issue + +Users experience a variety of failures when Web Modeler attempts to communicate with external services. These issues can manifest as: + +- Failed authentication due to the inability to access the JWKS (JSON Web Key Set) endpoint. Error message: "Expected 200 OK from the JSON Web Key Set HTTP response." +- Failure to reach other external services, such as the Camunda Marketplace. + +## Cause + +Proxy settings must be correctly configured for Web Modeler to route outgoing requests through a network proxy. Common issues occur when: + +- The proxy server is not properly configured or unreachable. +- Requests to external services are being blocked by the proxy configuration. +- Authentication requests, such as those to the OIDC provider, fail when the JWKS endpoint is unreachable via the proxy. + +## Resolution + +Ensure correct proxy configuration for both `webapp` and `restapi` components. + +- For the `webapp` component, proxy configuration is handled via the environment variables `http_proxy`, `https_proxy` and `no_proxy`. + ```properties + http_proxy=http://proxy.example.com:8080 https_proxy=https://secureproxy.example.com:443 no_proxy=localhost,127.0.0.1,.example.com + ``` +- For the `restapi` component, the proxy configuration is handled via JVM settings passed as the value of the environment variable `JAVA_OPTS`. + ```properties + JAVA_OPTS=-Dhttp.proxyHost= -Dhttps.proxyPort= + ``` diff --git a/sidebars.js b/sidebars.js index cc596d224e..ca43758fd5 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1549,6 +1549,7 @@ module.exports = { "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-database-connection", "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection", "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-missing-data", + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration", ], }, ], diff --git a/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/configuration.md b/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/configuration.md index 1f374a2abc..53b595d0f8 100644 --- a/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/configuration.md +++ b/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/configuration.md @@ -144,10 +144,13 @@ The `webapp` component sends certain events (e.g. "user opened diagram", "user l ### Logging -| Environment variable | Description | Example value | -| -------------------- | -------------------------------------- | ---------------------------- | -| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| Environment variable | Description | Example value | +| -------------------- | ----------------------------------------------- | ---------------------------- | +| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| `LOG_LEVEL_CLIENT` | [optional]
Log level for the client | `DEBUG` | +| `LOG_LEVEL_WEBAPP` | [optional]
Log level for the Node.js server | `DEBUG` | +The `LOG_LEVEL_*` options can be found [here](../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). Refer to the [Advanced Logging Configuration Guide](./logging.md#logging-configuration-for-the-webapp-component) for additional details on how to customize the `webapp` logging output. ## Configuration of the `websocket` component diff --git a/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/logging.md b/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/logging.md index be8db0bd16..7b5047b908 100644 --- a/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/logging.md +++ b/versioned_docs/version-8.4/self-managed/modeler/web-modeler/configuration/logging.md @@ -42,6 +42,16 @@ To enable additional log output to a file, adjust the following environment vari LOG_FILE_PATH=/full/path/to/log/file.log ``` +### Configuring log levels + +To control the verbosity of the logs, adjust the environment variables `LOG_LEVEL_CLIENT` (browser client) and `LOG_LEVEL_WEBAPP` (Node.js server). + +```properties +LOG_LEVEL_CLIENT=DEBUG +``` + +The `LOG_LEVEL_*` options can be found [here](../../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). + ## Logging configuration for the `websocket` component By default, the `websocket` component logs to the Docker container's standard output. diff --git a/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/configuration.md b/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/configuration.md index 906cf98a7a..4e89a4397e 100644 --- a/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/configuration.md +++ b/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/configuration.md @@ -117,6 +117,20 @@ Refer to the [advanced SSL configuration guide](./ssl.md) for additional details | `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` | +### Proxy + +These settings are useful when the application needs to make outgoing network requests in environments that require traffic to pass through a proxy server. + +| Environment variable | Description | Example value | Default value | +| -------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | ------------- | +| `http_proxy` | Specifies the proxy server to be used for outgoing HTTP requests. | `http://proxy.example.com:8080` | - | +| `https_proxy` | Specifies the proxy server to be used for outgoing HTTPS requests. | `https://secureproxy.example.com:443` | - | +| `no_proxy` | A comma-separated list of domain names or IP addresses for which the proxy should be bypassed. | `localhost,127.0.0.1,.example.com` | - | + +:::note +The proxy-related environment variables are lowercase because they follow a widely accepted convention used in many system environments and tools. +::: + ### Feature Flags | Environment variable | Description | Example value | Default value | @@ -158,10 +172,13 @@ The `webapp` component sends certain events (e.g. "user opened diagram", "user l ### Logging -| Environment variable | Description | Example value | -| -------------------- | -------------------------------------- | ---------------------------- | -| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| Environment variable | Description | Example value | +| -------------------- | ----------------------------------------------- | ---------------------------- | +| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| `LOG_LEVEL_CLIENT` | [optional]
Log level for the client | `DEBUG` | +| `LOG_LEVEL_WEBAPP` | [optional]
Log level for the Node.js server | `DEBUG` | +The `LOG_LEVEL_*` options can be found [here](../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). Refer to the [Advanced Logging Configuration Guide](./logging.md#logging-configuration-for-the-webapp-component) for additional details on how to customize the `webapp` logging output. ### SSL diff --git a/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/logging.md b/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/logging.md index b39f374782..5718a6b1e2 100644 --- a/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/logging.md +++ b/versioned_docs/version-8.5/self-managed/modeler/web-modeler/configuration/logging.md @@ -42,6 +42,16 @@ To enable additional log output to a file, adjust the following environment vari LOG_FILE_PATH=/full/path/to/log/file.log ``` +### Configuring log levels + +To control the verbosity of the logs, adjust the environment variables `LOG_LEVEL_CLIENT` (browser client) and `LOG_LEVEL_WEBAPP` (Node.js server). + +```properties +LOG_LEVEL_CLIENT=DEBUG +``` + +The `LOG_LEVEL_*` options can be found [here](../../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). + ## Logging configuration for the `websocket` component By default, the `websocket` component logs to the Docker container's standard output. diff --git a/versioned_docs/version-8.5/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md b/versioned_docs/version-8.5/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md new file mode 100644 index 0000000000..6059d9bed8 --- /dev/null +++ b/versioned_docs/version-8.5/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md @@ -0,0 +1,36 @@ +--- +id: troubleshoot-proxy-configuration +title: "Troubleshoot proxy configuration issues" +sidebar_label: "Proxy configuration" +description: "Troubleshooting guide for issues caused by incorrect proxy configuration in Web Modeler." +--- + +Troubleshoot and resolve issues in Web Modeler caused by incorrect or incomplete proxy configuration. + +## Issue + +Users experience a variety of failures when Web Modeler attempts to communicate with external services. These issues can manifest as: + +- Failed authentication due to the inability to access the JWKS (JSON Web Key Set) endpoint. Error message: "Expected 200 OK from the JSON Web Key Set HTTP response." +- Failure to reach other external services, such as the Camunda Marketplace. + +## Cause + +Proxy settings must be correctly configured for Web Modeler to route outgoing requests through a network proxy. Common issues occur when: + +- The proxy server is not properly configured or unreachable. +- Requests to external services are being blocked by the proxy configuration. +- Authentication requests, such as those to the OIDC provider, fail when the JWKS endpoint is unreachable via the proxy. + +## Resolution + +Ensure correct proxy configuration for both `webapp` and `restapi` components. + +- For the `webapp` component, proxy configuration is handled via the environment variables `http_proxy`, `https_proxy` and `no_proxy`. + ```properties + http_proxy=http://proxy.example.com:8080 https_proxy=https://secureproxy.example.com:443 no_proxy=localhost,127.0.0.1,.example.com + ``` +- For the `restapi` component, the proxy configuration is handled via JVM settings passed as the value of the environment variable `JAVA_OPTS`. + ```properties + JAVA_OPTS=-Dhttp.proxyHost= -Dhttps.proxyPort= + ``` diff --git a/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/configuration.md b/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/configuration.md index 9b989e42c7..5d88771c2f 100644 --- a/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/configuration.md +++ b/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/configuration.md @@ -140,6 +140,20 @@ Refer to the [advanced SSL configuration guide](./ssl.md) for additional details | `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` | +### Proxy + +These settings are useful when the application needs to make outgoing network requests in environments that require traffic to pass through a proxy server. + +| Environment variable | Description | Example value | Default value | +| -------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------- | ------------- | +| `http_proxy` | Specifies the proxy server to be used for outgoing HTTP requests. | `http://proxy.example.com:8080` | - | +| `https_proxy` | Specifies the proxy server to be used for outgoing HTTPS requests. | `https://secureproxy.example.com:443` | - | +| `no_proxy` | A comma-separated list of domain names or IP addresses for which the proxy should be bypassed. | `localhost,127.0.0.1,.example.com` | - | + +:::note +The proxy-related environment variables are lowercase because they follow a widely accepted convention used in many system environments and tools. +::: + ### Feature Flags | Environment variable | Description | Example value | Default value | @@ -181,10 +195,13 @@ The `webapp` component sends certain events (e.g. "user opened diagram", "user l ### Logging -| Environment variable | Description | Example value | -| -------------------- | -------------------------------------- | ---------------------------- | -| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| Environment variable | Description | Example value | +| -------------------- | ----------------------------------------------- | ---------------------------- | +| `LOG_FILE_PATH` | [optional]
Path to log file output | `/full/path/to/log/file.log` | +| `LOG_LEVEL_CLIENT` | [optional]
Log level for the client | `DEBUG` | +| `LOG_LEVEL_WEBAPP` | [optional]
Log level for the Node.js server | `DEBUG` | +The `LOG_LEVEL_*` options can be found [here](../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). Refer to the [Advanced Logging Configuration Guide](./logging.md#logging-configuration-for-the-webapp-component) for additional details on how to customize the `webapp` logging output. ### SSL diff --git a/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/logging.md b/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/logging.md index 307a2ea773..ab86be8bc3 100644 --- a/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/logging.md +++ b/versioned_docs/version-8.6/self-managed/modeler/web-modeler/configuration/logging.md @@ -38,6 +38,16 @@ To enable additional log output to a file, adjust the following environment vari LOG_FILE_PATH=/full/path/to/log/file.log ``` +### Configuring log levels + +To control the verbosity of the logs, adjust the environment variables `LOG_LEVEL_CLIENT` (browser client) and `LOG_LEVEL_WEBAPP` (Node.js server). + +```properties +LOG_LEVEL_CLIENT=DEBUG +``` + +The `LOG_LEVEL_*` options can be found [here](../../../../operational-guides/troubleshooting/log-levels/#understanding-log-levels). + ## Logging configuration for the `websocket` component By default, the `websocket` component logs to the Docker container's standard output. diff --git a/versioned_docs/version-8.6/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md b/versioned_docs/version-8.6/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md new file mode 100644 index 0000000000..6059d9bed8 --- /dev/null +++ b/versioned_docs/version-8.6/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration.md @@ -0,0 +1,36 @@ +--- +id: troubleshoot-proxy-configuration +title: "Troubleshoot proxy configuration issues" +sidebar_label: "Proxy configuration" +description: "Troubleshooting guide for issues caused by incorrect proxy configuration in Web Modeler." +--- + +Troubleshoot and resolve issues in Web Modeler caused by incorrect or incomplete proxy configuration. + +## Issue + +Users experience a variety of failures when Web Modeler attempts to communicate with external services. These issues can manifest as: + +- Failed authentication due to the inability to access the JWKS (JSON Web Key Set) endpoint. Error message: "Expected 200 OK from the JSON Web Key Set HTTP response." +- Failure to reach other external services, such as the Camunda Marketplace. + +## Cause + +Proxy settings must be correctly configured for Web Modeler to route outgoing requests through a network proxy. Common issues occur when: + +- The proxy server is not properly configured or unreachable. +- Requests to external services are being blocked by the proxy configuration. +- Authentication requests, such as those to the OIDC provider, fail when the JWKS endpoint is unreachable via the proxy. + +## Resolution + +Ensure correct proxy configuration for both `webapp` and `restapi` components. + +- For the `webapp` component, proxy configuration is handled via the environment variables `http_proxy`, `https_proxy` and `no_proxy`. + ```properties + http_proxy=http://proxy.example.com:8080 https_proxy=https://secureproxy.example.com:443 no_proxy=localhost,127.0.0.1,.example.com + ``` +- For the `restapi` component, the proxy configuration is handled via JVM settings passed as the value of the environment variable `JAVA_OPTS`. + ```properties + JAVA_OPTS=-Dhttp.proxyHost= -Dhttps.proxyPort= + ``` diff --git a/versioned_sidebars/version-8.5-sidebars.json b/versioned_sidebars/version-8.5-sidebars.json index 26d8e28c85..fb8529fde9 100644 --- a/versioned_sidebars/version-8.5-sidebars.json +++ b/versioned_sidebars/version-8.5-sidebars.json @@ -1988,7 +1988,8 @@ "Troubleshooting": [ "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-database-connection", "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection", - "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-login" + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-login", + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration" ] } ] diff --git a/versioned_sidebars/version-8.6-sidebars.json b/versioned_sidebars/version-8.6-sidebars.json index 45af8548ab..d9d96c4713 100644 --- a/versioned_sidebars/version-8.6-sidebars.json +++ b/versioned_sidebars/version-8.6-sidebars.json @@ -2485,7 +2485,8 @@ "Troubleshooting": [ "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-database-connection", "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection", - "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-missing-data" + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-missing-data", + "self-managed/modeler/web-modeler/troubleshooting/troubleshoot-proxy-configuration" ] } ]