From d88e2c846df4a2b72ad8d6e60bf7126ff935b0ef Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Mon, 16 Dec 2024 11:08:35 -0500 Subject: [PATCH] style(formatting): grammatical adjustments --- .../console-deployment/configuration/configuration.md | 4 ++-- docs/self-managed/console-deployment/configuration/ssl.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/self-managed/console-deployment/configuration/configuration.md b/docs/self-managed/console-deployment/configuration/configuration.md index 7864abf8f02..1c09cea48e1 100644 --- a/docs/self-managed/console-deployment/configuration/configuration.md +++ b/docs/self-managed/console-deployment/configuration/configuration.md @@ -16,7 +16,7 @@ Underscores in environment variables correspond to configuration file key levels | 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_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 | @@ -24,7 +24,7 @@ Underscores in environment variables correspond to configuration file key levels | `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 log in to use Console and API requests can be executed without an Authorization header.
By disabling authentication all `CAMUNDA_IDENTITY`, variables won't be used. | `true` | +| `CAMUNDA_CONSOLE_DISABLE_AUTH` | Disables authentication for Console. With this option, set users don't have to log in to use Console and API requests can be executed without an authorization header.
By disabling authentication, all `CAMUNDA_IDENTITY` variables won't be used. | `true` | | `CAMUNDA_LICENSE_KEY` | Your Camunda 8 license key, if your installation requires a license. For Helm installations, license keys can be configured globally in your `values.yaml` file. See the [Helm installation documentation](/self-managed/setup/install.md#configure-license-key) for more details. | N/A | | `SERVER_SSL_ENABLED` | [optional]
Whether to enable SSL support.
Default: `false` | `true` | | `SERVER_SSL_CERTIFICATE` | [optional]
Path to a PEM-encoded SSL certificate file. | `file:/full/path/to/certificate.pem` | diff --git a/docs/self-managed/console-deployment/configuration/ssl.md b/docs/self-managed/console-deployment/configuration/ssl.md index 5d6f1c176ea..e74aa635e3f 100644 --- a/docs/self-managed/console-deployment/configuration/ssl.md +++ b/docs/self-managed/console-deployment/configuration/ssl.md @@ -31,7 +31,7 @@ Enable and configure SSL by setting the following properties: | `SERVER_SSL_ENABLED` | To enable SSL, set to `true`. | `true` | | `SERVER_SSL_CERTIFICATE` | The path to a PEM-encoded SSL certificate file. Ensure the provided path is accessible from the container (for example, via a mounted volume). | `file:/full/path/to/certificate.pem` | | `SERVER_SSL_CERTIFICATE_PRIVATE_KEY` | The path to a PEM-encoded private key file for the SSL certificate. Ensure the provided path is accessible from the container (for example, via a mounted volume). | `file:/full/path/to/key.pem` | -| `SERVER_SSL_PASSPHRASE` | _Optional._ A passphrase for the private key. | `passphrase` | +| `SERVER_SSL_PASSPHRASE` | _Optional_ A passphrase for the private key. | `passphrase` | SSL can be configured separately for the management routes using the `MANAGEMENT_` properties: @@ -40,11 +40,11 @@ SSL can be configured separately for the management routes using the `MANAGEMENT | `MANAGEMENT_SERVER_SSL_ENABLED` | To enable SSL, set to `true`. | `true` | | `MANAGEMENT_SERVER_SSL_CERTIFICATE` | The path to a PEM-encoded SSL certificate file. Ensure the provided path is accessible from the container (for example, via a mounted volume). | `file:/full/path/to/certificate.pem` | | `MANAGEMENT_SERVER_SSL_CERTIFICATE_PRIVATE_KEY` | The path to a PEM-encoded private key file for the SSL certificate. Ensure the provided path is accessible from the container (for example, via a mounted volume). | `file:/full/path/to/key.pem` | -| `MANAGEMENT_SERVER_SSL_PASSPHRASE` | _Optional._ A passphrase for the private key. | `passphrase` | +| `MANAGEMENT_SERVER_SSL_PASSPHRASE` | _Optional_ A passphrase for the private key. | `passphrase` | ## (Optional) Provide a custom certificate -If you are using a custom (self-signed) TLS certificate in Console or Identity, you need to make Console accept the certificate. +If you are using a custom (self-signed) TLS certificate in Console or Identity, configure Console to accept the certificate. Provide the path to the certificate file via the environment variable `NODE_EXTRA_CA_CERTS`: