Environment (Section)#
Path: /environments/environment
Defines an environment with all services and meta information it needs
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| available-template-areas | multi-value string | optional | - | Reports the template areas that are available as they are found on the file system of the admin node |
| name | string | optional | se.curity | The name of the organization running the services in an environment (Entity ID) |
| deployment-type | union (enumeration (development, production, staging) | string (length: 1..9223372036854775807)) | optional | - | The type of deployment this system is executing as. |
| base-url | string | optional | - | The external base URL used to contact this machine |
| static-resource-root-path | string | optional | “ | The root path under the base-url from which static resources should be served |
| non-essential-cookies-are-opt-in | boolean | optional | false | If set to true, non-essential cookies will not be set unless the user explicitly opts-in to cookies. For details on how a user may opt-in, refer to the Cookies section in the System Admin Guide |
Subsections#
| Name | Type | Description |
|---|---|---|
| localization | Section | The localization settings for this environment |
| white-listed-proxies | Section | A list of proxies that are allowed to be in the middle of the requestor and this server. If this list is empty, the X-Forwarded-For header will be ignored. If this list is non-empty the X-Forwarded-For header will be used as the remote-ip of the client if the proxies match this list. |
| distributed-service | Section | Explicitly configure the Distributed Service. WARNING: this is EXPERIMENTAL. |
| cluster | Section | Settings of a configuration cluster |
| admin-service | Section | Enable the admin service |
| ui-experience | Section | (experimental) Configure which UI experience to use. Defaults to using Velocity templates. This can be overridden for specific profiles or client applications. |
| themes | Section | UI theme configuration |
| services | Section | Settings of physical daemon instances |
| reporting | Section | Reporting makes runtime nodes expose Prometheus compatible metrics |
| alarms | Section | |
| telemetry | Section | Configure the server to participate in distributed tracing |
| graphql | Section | GraphQL-related settings that apply to all GraphQL endpoints. |