Connector property naming

Every Connector setting has one canonical property name, written in lowercase dotted kebab case (e.g., moderne.connector.api-gateway-rsocket-uri).

These settings can be supplied in different ways based on how you choose to run the Connector. Throughout the documentation, settings are shown as environment variables and as command line arguments.

Regardless of how you run the Connector, the spelling of the settings will be derived from the canonical property name.

Supplying a property

If you run the Connector as an OCI container, you will set an environment variable (e.g., MODERNE_CONNECTOR_NICKNAME=prod-1). If you run the Connector as an executable JAR, you will pass a command line argument (e.g., --moderne.connector.nickname=prod-1).

Deriving the environment variable name

By convention, an environment variable name uses only uppercase letters, digits, and underscores. To rewrite a canonical property name to fit that rule:

1. Replace dots (.) with underscores (_).
2. Remove any dashes (-).
3. Convert to uppercase.

For a list, surround the element number with underscores.

Canonical property	Environment variable
moderne.connector.nickname	MODERNE_CONNECTOR_NICKNAME
moderne.connector.crypto.symmetric-key	MODERNE_CONNECTOR_CRYPTO_SYMMETRICKEY
moderne.scm.github[0].uri	MODERNE_SCM_GITHUB_0_URI
moderne.scm.github[0].oauth.client-id	MODERNE_SCM_GITHUB_0_OAUTH_CLIENTID
moderne.scm.github[0].allowable-organizations[1]	MODERNE_SCM_GITHUB_0_ALLOWABLEORGANIZATIONS_1
moderne.organization.sources.http[0].bearer-token	MODERNE_ORGANIZATION_SOURCES_HTTP_0_BEARERTOKEN

Spring Boot's binding from environment variables documentation covers these rules in full.

Deriving the JAR argument

Prefix the canonical name with -- and leave it otherwise unchanged.

Canonical property	JAR argument
moderne.connector.nickname	--moderne.connector.nickname
moderne.scm.github[0].oauth.client-id	--moderne.scm.github[0].oauth.client-id
moderne.scm.github[0].allowable-organizations[1]	--moderne.scm.github[0].allowable-organizations[1]

Exporting an environment variable also works when running the JAR, so you can mix the two forms. This is useful for secrets you would rather not put on the command line.

Indexes

A property with [{index}] in its name can be repeated. Start at 0 and increase by one for each additional entry. Indexes must be contiguous.

--moderne.scm.github[0].uri=https://github.example.com \
--moderne.scm.github[1].uri=https://github-eu.example.com

YAML

You can also keep your configuration in a YAML file and point the Connector at it with --spring.config.additional-location=file:moderne.yml. The canonical name maps onto nested keys.

moderne:
  scm:
    github:
      - uri: https://github.example.com
        oauth:
          client-id: yourClientId
          client-secret: yourClientSecret

The Connector also writes one for you. On startup it generates a moderne.yml that shows your active configuration in canonical form. Set moderne.connector.write-migrated-config to false to turn that off, or moderne.connector.migrated-config-path to change where it is written.

The generated file includes your secrets in plaintext: the Connector token, the symmetric key, and any OAuth client secrets or LLM API keys. Protect it like the rest of your configuration, or turn the file off.

Where to find property names

Each configuration guide shows both spellings for the settings it covers. The All Connector configuration variables reference covers every setting.