Skip to content

Commit

Permalink
style(formatting): grammatical adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
@christinaausley
christinaausley committed Dec 16, 2024
1 parent 49a6ad1 commit d88e2c8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/self-managed/console-deployment/configuration/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ 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 |
| `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 log in 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` |
| `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. <br /> 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]<br/>Whether to enable SSL support.<br/>Default: `false` | `true` |
| `SERVER_SSL_CERTIFICATE` | [optional]<br/>Path to a PEM-encoded SSL certificate file. | `file:/full/path/to/certificate.pem` |
Expand Down
6 changes: 3 additions & 3 deletions docs/self-managed/console-deployment/configuration/ssl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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`:

Expand Down

0 comments on commit d88e2c8

Please sign in to comment.