Configuration Reference

Version:2.2.1

Micronaut Control Panel Core Config Properties

Table 1. Configuration Properties for ControlPanelModuleConfiguration
Property	Type	Description	Default value
`micronaut.control-panel.enabled`	boolean	Enables/disables the control panel module. Default value: "true".	true
`micronaut.control-panel.allowed-environments`	java.util.Set	Configures the environments where the control panel module is enabled. By default, it is only enabled in the "dev" and "test" environments.	dev,test
`micronaut.control-panel.path`	java.lang.String	Configures the path where the control panel can be accessed. Default value: "/control-panel".	/control-panel
`micronaut.control-panel.log-url`	boolean	Whether to print the Control Panel URL in the logs on application startup. Default: StringUtils.TRUE	true

Table 2. Configuration Properties for ControlPanelConfiguration
Property	Type	Description	Default value
`micronaut.control-panel.panels.*.enabled`	boolean	Sets whether this control panel is enabled or not.
`micronaut.control-panel.panels.*.order`	int	Sets the order of this control panel, since they will be displayed sorted by order.
`micronaut.control-panel.panels.*.title`	java.lang.String	Sets the title of this control panel.
`micronaut.control-panel.panels.*.icon`	java.lang.String	Sets the icon of this control panel.
`micronaut.control-panel.panels.*.name`	java.lang.String	Sets the unique name of the control panel. Can be used in URLs.

Table 3. Configuration Properties for ControlPanelSecurityConfiguration
Property	Type	Description	Default value
`micronaut.control-panel.security.access`	ControlPanelSecurityConfiguration$Access	the configured read access mode	AUTHORIZED
`micronaut.control-panel.security.role`	java.lang.String	role required when authorized read access is enabled	ROLE_CONTROL_PANEL
`micronaut.control-panel.security.write-access`	ControlPanelSecurityConfiguration$WriteAccess	the configured write access mode	INHERITED
`micronaut.control-panel.security.write-role`	java.lang.String	role required when authorized write access is enabled

Table 4. Configuration Properties for ControlPanelRequestConfiguration
Property	Type	Description	Default value
`micronaut.control-panel.security.csrf-protection-enabled`	boolean	Whether same-origin protection (Fetch Metadata, {@code Origin} and the control panel request header) is enforced for mutating control panel requests. Default: "true".	true
`micronaut.control-panel.security.host-check-enabled`	boolean	Whether the host allowlist is enforced when the control panel is reachable without authentication. Default: "true".	true
`micronaut.control-panel.security.allowed-hosts`	java.util.Set	Additional host names (optionally with a port) that are accepted when the host check is active, beyond the built-in loopback names. Each entry is matched case-insensitively and may be a bare host or {@code host:port}.

Micronaut Control Panel Datasource Config Properties

Table 5. Configuration Properties for DataSourceQueryConfiguration
Property	Type	Description	Default value
`micronaut.control-panel.datasource.allow-writes`	boolean	Whether the datasource SQL console may run data-modifying statements (anything that is not a {@code SELECT}/{@code WITH} query). Disabled by default so the console is read-only; enable it only in a trusted development environment. Default: "false".	false

Micronaut Control Panel Kafka Config Properties

Table 6. Configuration Properties for KafkaIntegrationConfiguration
Property	Type	Description	Default value
`micronaut.control-panel.panels.kafka.integrations.schema-registry`	KafkaIntegrationConfiguration$Endpoint	The optional Schema Registry endpoint.
`micronaut.control-panel.panels.kafka.integrations.connect`	KafkaIntegrationConfiguration$Endpoint	The optional Kafka Connect endpoint.
`micronaut.control-panel.panels.kafka.integrations.ksqldb`	KafkaIntegrationConfiguration$Endpoint	The optional ksqlDB endpoint.

Table 7. Configuration Properties for KafkaClusterWriteConfiguration
Property	Type	Description	Default value
`micronaut.control-panel.panels.kafka.writes.enabled`	boolean	Enables non-destructive Kafka write actions such as producing records and updating mutable resources.	false
`micronaut.control-panel.panels.kafka.writes.destructive-enabled`	boolean	Enables destructive Kafka write actions such as deleting topics, consumer groups, connectors, or schemas.	false
`micronaut.control-panel.panels.kafka.writes.max-message-value-bytes`	int	Maximum number of bytes allowed for a produced record value.	1048576
`micronaut.control-panel.panels.kafka.writes.max-message-key-bytes`	int	Maximum number of bytes allowed for a produced record key.	1024
`micronaut.control-panel.panels.kafka.writes.max-message-headers`	int	Maximum number of headers allowed on a produced record.	20
`micronaut.control-panel.panels.kafka.writes.max-message-header-key-bytes`	int	Maximum number of bytes allowed for each produced record header key.	256
`micronaut.control-panel.panels.kafka.writes.max-message-header-value-bytes`	int	Maximum number of bytes allowed for each produced record header value.	4096
`micronaut.control-panel.panels.kafka.writes.actions`	KafkaClusterWriteConfiguration$Actions	Per-action Kafka write toggles that can disable individual write operations after the top-level write gate is enabled.