Skip to main content

Configuration

Kafkador is a Spring Boot application, so you can set any property below in three ways:

  • as an environment variable, which is the usual choice in Docker
  • as a command-line argument, such as --server.port=9090
  • in an override file, with ./starter.sh --config /path/to/override.yml

First-run setup​

Environment variableDefaultDescription
KAFKADOR_SETUP_USERNAMEDatabase username. Setting this and the password skips the setup page
KAFKADOR_SETUP_PASSWORDDatabase password, at least 8 characters
KAFKADOR_SETUP_TOKENRandomThe one-time setup token
KAFKADOR_SETUP_AUTOfalseSkip setup for a single-user app

Access​

These apply at every start.

Environment variableDescription
KAFKADOR_ACCESS_MODEnone, database or ldap. Leave it empty to manage access in Settings
KAFKADOR_ACCESS_ADMINUSERNAMEAdmin username, for database
KAFKADOR_ACCESS_ADMINPASSWORDAdmin password, 8-128 characters, for database
KAFKADOR_ACCESS_LDAP_URLldap://host:389 or ldaps://host:636
KAFKADOR_ACCESS_LDAP_BASEDNSuch as dc=example,dc=com
KAFKADOR_ACCESS_LDAP_USERDNPATTERNSuch as uid={0},ou=people, relative to the base DN
KAFKADOR_ACCESS_LDAP_USERSEARCHBASESuch as ou=people, when searching
KAFKADOR_ACCESS_LDAP_USERSEARCHFILTERSuch as (uid={0}), when searching
KAFKADOR_ACCESS_LDAP_MANAGERDNThe account to search with, if searches can't be anonymous
KAFKADOR_ACCESS_LDAP_MANAGERPASSWORDThat account's password

Live record views​

PropertyDefaultDescription
kafkador.records.live.max-per-session3Live views per session
kafkador.records.live.max-total20Live views across the server
kafkador.records.live.max-duration30mHow long one live view can run

Other properties​

PropertyDefaultDescription
server.port8080Port to listen on
server.addressAll addressesAddress to listen on, such as 127.0.0.1
kafkador.cors.allowed-originsNoneOther origins allowed to call the API from a browser
kafkador.db-credentials-file./data/db-credentials.propertiesWhere the database credentials are kept

Docker variables​

These are read by docker-compose.yml from your .env file:

VariableDefaultDescription
KAFKADOR_VERSIONlatestImage tag
KAFKADOR_PORT8080Host port. 127.0.0.1:8080 publishes it on this machine only
JAVA_OPTS-XX:MaxRAMPercentage=75.0JVM options

Settings kept in the database​

You change these in the app rather than in configuration:

SettingWhere
Session timeoutSettings → Generic
TLS, SASL and truststoreSettings → Security
Who may use KafkadorSettings → Access
Schema Registry, ksqlDB and ConnectSettings → Schema Registry, KsqlDB and Connectors
AI assistantSettings → AI Assistant