Docs navigation
Core
Build Plugins
AI
Dev & Test
Build
Data Access
Database Migration
Errors
Messaging
Analytics
API
Cloud
Configuration
Languages
Misc
Reactive
Views
Validation
Configuration Reference

Micronaut Control Panel Configuration Reference

Every documented configuration property of Micronaut Control Panel, with types, descriptions, and defaults.

Micronaut Control Panel documentation

24 properties across 2 sections

Micronaut Control Panel Core Config Properties

Configuration properties for ControlPanelModuleConfiguration

PropertyTypeDescriptionDefault
micronaut.control-panel.enabledbooleanEnables/disables the control panel module. Default value: "true".true
micronaut.control-panel.allowed-environmentsjava.util.SetConfigures 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.pathjava.lang.StringConfigures the path where the control panel can be accessed. Default value: "/control-panel"./control-panel
micronaut.control-panel.log-urlbooleanWhether to print the Control Panel URL in the logs on application startup. Default: StringUtils.TRUEtrue

Configuration properties for ControlPanelConfiguration

PropertyTypeDescription
micronaut.control-panel.panels.*.enabledbooleanSets whether this control panel is enabled or not.
micronaut.control-panel.panels.*.orderintSets the order of this control panel, since they will be displayed sorted by order.
micronaut.control-panel.panels.*.titlejava.lang.StringSets the title of this control panel.
micronaut.control-panel.panels.*.iconjava.lang.StringSets the icon of this control panel.
micronaut.control-panel.panels.*.namejava.lang.StringSets the unique name of the control panel. Can be used in URLs.

Configuration properties for ControlPanelSecurityConfiguration

PropertyTypeDescriptionDefault
micronaut.control-panel.security.accessControlPanelSecurityConfiguration$Accessthe configured read access modeAUTHORIZED
micronaut.control-panel.security.rolejava.lang.Stringrole required when authorized read access is enabledROLE_CONTROL_PANEL
micronaut.control-panel.security.write-accessControlPanelSecurityConfiguration$WriteAccessthe configured write access modeINHERITED
micronaut.control-panel.security.write-rolejava.lang.Stringrole required when authorized write access is enabled

Micronaut Control Panel Kafka Config Properties

Configuration properties for KafkaIntegrationConfiguration

PropertyTypeDescription
micronaut.control-panel.panels.kafka.integrations.schema-registryKafkaIntegrationConfiguration$EndpointThe optional Schema Registry endpoint.
micronaut.control-panel.panels.kafka.integrations.connectKafkaIntegrationConfiguration$EndpointThe optional Kafka Connect endpoint.
micronaut.control-panel.panels.kafka.integrations.ksqldbKafkaIntegrationConfiguration$EndpointThe optional ksqlDB endpoint.

Configuration properties for KafkaClusterWriteConfiguration

PropertyTypeDescriptionDefault
micronaut.control-panel.panels.kafka.writes.enabledbooleanEnables non-destructive Kafka write actions such as producing records and updating mutable resources.false
micronaut.control-panel.panels.kafka.writes.destructive-enabledbooleanEnables destructive Kafka write actions such as deleting topics, consumer groups, connectors, or schemas.false
micronaut.control-panel.panels.kafka.writes.max-message-value-bytesintMaximum number of bytes allowed for a produced record value.1048576
micronaut.control-panel.panels.kafka.writes.max-message-key-bytesintMaximum number of bytes allowed for a produced record key.1024
micronaut.control-panel.panels.kafka.writes.max-message-headersintMaximum number of headers allowed on a produced record.20
micronaut.control-panel.panels.kafka.writes.max-message-header-key-bytesintMaximum number of bytes allowed for each produced record header key.256
micronaut.control-panel.panels.kafka.writes.max-message-header-value-bytesintMaximum number of bytes allowed for each produced record header value.4096
micronaut.control-panel.panels.kafka.writes.actionsKafkaClusterWriteConfiguration$ActionsPer-action Kafka write toggles that can disable individual write operations after the top-level write gate is enabled.