Documentation/DamlView on Daml ↗
Daml

Configuration options

Configuration options

./scribe.jar pipeline parameters

Parameter

Description

--config file

Path to configuration overrides via an external HOCON file (optional)

  • Environment variable: SCRIBE_CONFIG

  • System property: config

--pipeline-datasource enum

Ledger API service to use as data source (default: TransactionStream)

  • Environment variable: SCRIBE_PIPELINE_DATASOURCE

  • System property: pipeline.datasource

  • Enumeration values: TransactionStream, TransactionTreeStream

--pipeline-oauth-clientid string

Client’s identifier (optional)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_CLIENTID

  • System property: pipeline.oauth.clientId

--pipeline-oauth-accesstoken string

Access token (optional)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_ACCESSTOKEN

  • System property: pipeline.oauth.accessToken

--pipeline-oauth-scope [enum | string]

Token scope (default: Default)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_SCOPE

  • System property: pipeline.oauth.scope

  • Enumeration values: Default, None

--pipeline-oauth-parameters map

Custom parameters

  • Environment variable: SCRIBE_PIPELINE_OAUTH_PARAMETERS

  • System property: pipeline.oauth.parameters

--pipeline-oauth-preemptexpiry string

The duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_PREEMPTEXPIRY

  • System property: pipeline.oauth.preemptExpiry

--pipeline-oauth-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_CAFILE

  • System property: pipeline.oauth.cafile

--pipeline-oauth-endpoint uri

Token endpoint URL (optional)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_ENDPOINT

  • System property: pipeline.oauth.endpoint

--pipeline-oauth-issuer uri

OIDC-compliant issuer URL (optional)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_ISSUER

  • System property: pipeline.oauth.issuer

--pipeline-oauth-clientsecret string

Client’s secret (optional)

  • Environment variable: SCRIBE_PIPELINE_OAUTH_CLIENTSECRET

  • System property: pipeline.oauth.clientSecret

--pipeline-filter-parties string

Filter expression determining Daml party identifiers to filter on (default: *)

  • Environment variable: SCRIBE_PIPELINE_FILTER_PARTIES

  • System property: pipeline.filter.parties

--pipeline-filter-metadata string

Filter expression determining which templates and interfaces to capture metadata for (default: !*)

  • Environment variable: SCRIBE_PIPELINE_FILTER_METADATA

  • System property: pipeline.filter.metadata

--pipeline-filter-contracts string

Filter expression determining which templates and interfaces to include (default: *)

  • Environment variable: SCRIBE_PIPELINE_FILTER_CONTRACTS

  • System property: pipeline.filter.contracts

--pipeline-ledger-start [enum | string]

Start offset (default: Latest)

  • Environment variable: SCRIBE_PIPELINE_LEDGER_START

  • System property: pipeline.ledger.start

  • Enumeration values: Genesis, Oldest, Latest

--pipeline-ledger-stop [enum | string]

Stop offset (default: Never)

  • Environment variable: SCRIBE_PIPELINE_LEDGER_STOP

  • System property: pipeline.ledger.stop

  • Enumeration values: Latest, Never

--retry-backoff-base string

Base time (ISO 8601) for backoff retry strategy (default: PT1S)

  • Environment variable: SCRIBE_RETRY_BACKOFF_BASE

  • System property: retry.backoff.base

--retry-backoff-cap string

Max duration (ISO 8601) between attempts (default: PT1M)

  • Environment variable: SCRIBE_RETRY_BACKOFF_CAP

  • System property: retry.backoff.cap

--retry-backoff-factor double

Factor for backoff retry strategy (default: 2.0)

  • Environment variable: SCRIBE_RETRY_BACKOFF_FACTOR

  • System property: retry.backoff.factor

--retry-counter-attempts int

Max attempts before giving up (optional)

  • Environment variable: SCRIBE_RETRY_COUNTER_ATTEMPTS

  • System property: retry.counter.attempts

--retry-counter-reset string

Reset retry counters after period (ISO 8601) of stability (default: PT10M)

  • Environment variable: SCRIBE_RETRY_COUNTER_RESET

  • System property: retry.counter.reset

--retry-counter-duration string

Time limit (ISO 8601) before giving up (optional)

  • Environment variable: SCRIBE_RETRY_COUNTER_DURATION

  • System property: retry.counter.duration

--health-address string

Hostname or IP to bind HTTP health info service to (default: 127.0.0.1)

  • Environment variable: SCRIBE_HEALTH_ADDRESS

  • System property: health.address

--health-port int

HTTP port to use to expose application health info (default: 8080)

  • Environment variable: SCRIBE_HEALTH_PORT

  • System property: health.port

--logger-level enum

Log level (default: Info)

  • Environment variable: SCRIBE_LOGGER_LEVEL

  • System property: logger.level

  • Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None

--logger-mappings map

Custom mappings for log levels

  • Environment variable: SCRIBE_LOGGER_MAPPINGS

  • System property: logger.mappings

--logger-format enum

Log output format (default: Plain)

  • Environment variable: SCRIBE_LOGGER_FORMAT

  • System property: logger.format

  • Enumeration values: Plain, Json

--logger-pattern [enum | string]

Log pattern (default: Plain)

  • Environment variable: SCRIBE_LOGGER_PATTERN

  • System property: logger.pattern

  • Enumeration values: Plain, Standard, Structured

--target-postgres-host string

Postgres host (default: localhost)

  • Environment variable: SCRIBE_TARGET_POSTGRES_HOST

  • System property: target.postgres.host

--target-postgres-appname string

Application name for Postgres connections (default: scribe)

  • Environment variable: SCRIBE_TARGET_POSTGRES_APPNAME

  • System property: target.postgres.appName

--target-postgres-buffersize int

Buffer size for transactions processing (default: 128)

  • Environment variable: SCRIBE_TARGET_POSTGRES_BUFFERSIZE

  • System property: target.postgres.bufferSize

--target-postgres-tls-mode enum

SSL mode required for Postgres connectivity (default: Disable)

  • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_MODE

  • System property: target.postgres.tls.mode

  • Enumeration values: Disable, Require, VerifyCA, VerifyFull

--target-postgres-tls-cert file

Client’s certificate (optional)

  • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_CERT

  • System property: target.postgres.tls.cert

--target-postgres-tls-key file

Client’s private key (optional)

  • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_KEY

  • System property: target.postgres.tls.key

--target-postgres-tls-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_CAFILE

  • System property: target.postgres.tls.cafile

--target-postgres-keepalive boolean

Enable/disable TCP keep-alive probe (default: true)

  • Environment variable: SCRIBE_TARGET_POSTGRES_KEEPALIVE

  • System property: target.postgres.keepAlive

--target-postgres-maxconnections int

Maximum number of JDBC connections (default: 16)

  • Environment variable: SCRIBE_TARGET_POSTGRES_MAXCONNECTIONS

  • System property: target.postgres.maxConnections

--target-postgres-password string

Postgres user password (default: ********)

  • Environment variable: SCRIBE_TARGET_POSTGRES_PASSWORD

  • System property: target.postgres.password

--target-postgres-username string

Postgres user name (default: postgres)

  • Environment variable: SCRIBE_TARGET_POSTGRES_USERNAME

  • System property: target.postgres.username

--target-postgres-database string

Postgres database (default: postgres)

  • Environment variable: SCRIBE_TARGET_POSTGRES_DATABASE

  • System property: target.postgres.database

--target-postgres-schema string

Postgres schema (default: public)

  • Environment variable: SCRIBE_TARGET_POSTGRES_SCHEMA

  • System property: target.postgres.schema

--target-postgres-port int

Postgres port (default: 5432)

  • Environment variable: SCRIBE_TARGET_POSTGRES_PORT

  • System property: target.postgres.port

--target-encoding-numericasstring boolean

Encode numeric as string instead of JSON number (default: true)

  • Environment variable: SCRIBE_TARGET_ENCODING_NUMERICASSTRING

  • System property: target.encoding.numericAsString

--target-encoding-excludenulls boolean

Omit fields with NULL values from resulting JSON (default: false)

  • Environment variable: SCRIBE_TARGET_ENCODING_EXCLUDENULLS

  • System property: target.encoding.excludeNulls

--target-encoding-int64asstring boolean

Encode int64 as string instead of JSON number (default: true)

  • Environment variable: SCRIBE_TARGET_ENCODING_INT64ASSTRING

  • System property: target.encoding.int64AsString

--target-schema-autoapply boolean

Apply metadata inferred schema on startup (default: true)

  • Environment variable: SCRIBE_TARGET_SCHEMA_AUTOAPPLY

  • System property: target.schema.autoApply

--target-schema-baseline boolean

Baseline existing database schema during apply (default: false)

  • Environment variable: SCRIBE_TARGET_SCHEMA_BASELINE

  • System property: target.schema.baseline

--source-ledger-host string

Ledger API host (default: localhost)

  • Environment variable: SCRIBE_SOURCE_LEDGER_HOST

  • System property: source.ledger.host

--source-ledger-cachedir file

Cache Directory (default: /tmp/scribe)

  • Environment variable: SCRIBE_SOURCE_LEDGER_CACHEDIR

  • System property: source.ledger.cacheDir

--source-ledger-buffersize int

Buffer size for gRPC channel (default: 128)

  • Environment variable: SCRIBE_SOURCE_LEDGER_BUFFERSIZE

  • System property: source.ledger.bufferSize

--source-ledger-keepalive-time string

Duration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S)

  • Environment variable: SCRIBE_SOURCE_LEDGER_KEEPALIVE_TIME

  • System property: source.ledger.keepAlive.time

--source-ledger-keepalive-timeout string

Duration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S)

  • Environment variable: SCRIBE_SOURCE_LEDGER_KEEPALIVE_TIMEOUT

  • System property: source.ledger.keepAlive.timeout

--source-ledger-auth enum

Authorisation mode (default: NoAuth)

  • Environment variable: SCRIBE_SOURCE_LEDGER_AUTH

  • System property: source.ledger.auth

  • Enumeration values: OAuth, NoAuth

--source-ledger-tls-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_SOURCE_LEDGER_TLS_CAFILE

  • System property: source.ledger.tls.cafile

--source-ledger-tls-cert file

Client’s certificate (leave empty if embedded into private key file) (optional)

  • Environment variable: SCRIBE_SOURCE_LEDGER_TLS_CERT

  • System property: source.ledger.tls.cert

--source-ledger-tls-key file

Client’s private key (leave empty for server-only TLS) (optional)

  • Environment variable: SCRIBE_SOURCE_LEDGER_TLS_KEY

  • System property: source.ledger.tls.key

--source-ledger-port int

Ledger API port (default: 6865)

  • Environment variable: SCRIBE_SOURCE_LEDGER_PORT

  • System property: source.ledger.port

./scribe.jar datastore postgres-document prune parameters

Parameter

Description

--config file

Path to configuration overrides via an external HOCON file (optional)

  • Environment variable: SCRIBE_CONFIG

  • System property: config

--prune-target string

Inclusive boundary up to which to prune. Can be an offset, timestamp (ISO 8601) or duration (ISO 8601)

  • Environment variable: SCRIBE_PRUNE_TARGET

  • System property: prune.target

--prune-mode enum

Precomputes effects of pruning through dry-run, or actually runs it (default: DryRun)

  • Environment variable: SCRIBE_PRUNE_MODE

  • System property: prune.mode

  • Enumeration values: DryRun, Force

--logger-destination file

Log output file (default: output.log)

  • Environment variable: SCRIBE_LOGGER_DESTINATION

  • System property: logger.destination

--logger-mappings map

Custom mappings for log levels

  • Environment variable: SCRIBE_LOGGER_MAPPINGS

  • System property: logger.mappings

--logger-format enum

Log output format (default: Plain)

  • Environment variable: SCRIBE_LOGGER_FORMAT

  • System property: logger.format

  • Enumeration values: Plain, PlainAsync, Json, JsonAsync

--logger-pattern [enum | string]

Log pattern (default: Plain)

  • Environment variable: SCRIBE_LOGGER_PATTERN

  • System property: logger.pattern

  • Enumeration values: Plain, Standard, Structured

--logger-level enum

Log level (default: Info)

  • Environment variable: SCRIBE_LOGGER_LEVEL

  • System property: logger.level

  • Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None

--postgres-host string

Postgres host (default: localhost)

  • Environment variable: SCRIBE_POSTGRES_HOST

  • System property: postgres.host

--postgres-appname string

Application name for Postgres connections (default: scribe)

  • Environment variable: SCRIBE_POSTGRES_APPNAME

  • System property: postgres.appName

--postgres-buffersize int

Buffer size for transactions processing (default: 128)

  • Environment variable: SCRIBE_POSTGRES_BUFFERSIZE

  • System property: postgres.bufferSize

--postgres-tls-mode enum

SSL mode required for Postgres connectivity (default: Disable)

  • Environment variable: SCRIBE_POSTGRES_TLS_MODE

  • System property: postgres.tls.mode

  • Enumeration values: Disable, Require, VerifyCA, VerifyFull

--postgres-tls-cert file

Client’s certificate (optional)

  • Environment variable: SCRIBE_POSTGRES_TLS_CERT

  • System property: postgres.tls.cert

--postgres-tls-key file

Client’s private key (optional)

  • Environment variable: SCRIBE_POSTGRES_TLS_KEY

  • System property: postgres.tls.key

--postgres-tls-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_POSTGRES_TLS_CAFILE

  • System property: postgres.tls.cafile

--postgres-keepalive boolean

Enable/disable TCP keep-alive probe (default: true)

  • Environment variable: SCRIBE_POSTGRES_KEEPALIVE

  • System property: postgres.keepAlive

--postgres-maxconnections int

Maximum number of JDBC connections (default: 16)

  • Environment variable: SCRIBE_POSTGRES_MAXCONNECTIONS

  • System property: postgres.maxConnections

--postgres-password string

Postgres user password (default: ********)

  • Environment variable: SCRIBE_POSTGRES_PASSWORD

  • System property: postgres.password

--postgres-username string

Postgres user name (default: postgres)

  • Environment variable: SCRIBE_POSTGRES_USERNAME

  • System property: postgres.username

--postgres-schema string

Postgres schema (default: public)

  • Environment variable: SCRIBE_POSTGRES_SCHEMA

  • System property: postgres.schema

--postgres-database string

Postgres database (default: postgres)

  • Environment variable: SCRIBE_POSTGRES_DATABASE

  • System property: postgres.database

--postgres-port int

Postgres port (default: 5432)

  • Environment variable: SCRIBE_POSTGRES_PORT

  • System property: postgres.port

./scribe.jar datastore postgres-document schema show parameters

Parameter

Description

--config file

Path to configuration overrides via an external HOCON file (optional)

  • Environment variable: SCRIBE_CONFIG

  • System property: config

--ledger-host string

Ledger API host (default: localhost)

  • Environment variable: SCRIBE_LEDGER_HOST

  • System property: ledger.host

--ledger-cachedir file

Cache Directory (default: /tmp/scribe)

  • Environment variable: SCRIBE_LEDGER_CACHEDIR

  • System property: ledger.cacheDir

--ledger-buffersize int

Buffer size for gRPC channel (default: 128)

  • Environment variable: SCRIBE_LEDGER_BUFFERSIZE

  • System property: ledger.bufferSize

--ledger-keepalive-time string

Duration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S)

  • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIME

  • System property: ledger.keepAlive.time

--ledger-keepalive-timeout string

Duration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S)

  • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIMEOUT

  • System property: ledger.keepAlive.timeout

--ledger-auth enum

Authorisation mode (default: NoAuth)

  • Environment variable: SCRIBE_LEDGER_AUTH

  • System property: ledger.auth

  • Enumeration values: OAuth, NoAuth

--ledger-tls-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_LEDGER_TLS_CAFILE

  • System property: ledger.tls.cafile

--ledger-tls-cert file

Client’s certificate (leave empty if embedded into private key file) (optional)

  • Environment variable: SCRIBE_LEDGER_TLS_CERT

  • System property: ledger.tls.cert

--ledger-tls-key file

Client’s private key (leave empty for server-only TLS) (optional)

  • Environment variable: SCRIBE_LEDGER_TLS_KEY

  • System property: ledger.tls.key

--ledger-port int

Ledger API port (default: 6865)

  • Environment variable: SCRIBE_LEDGER_PORT

  • System property: ledger.port

--logger-destination file

Log output file (default: output.log)

  • Environment variable: SCRIBE_LOGGER_DESTINATION

  • System property: logger.destination

--logger-mappings map

Custom mappings for log levels

  • Environment variable: SCRIBE_LOGGER_MAPPINGS

  • System property: logger.mappings

--logger-format enum

Log output format (default: Plain)

  • Environment variable: SCRIBE_LOGGER_FORMAT

  • System property: logger.format

  • Enumeration values: Plain, PlainAsync, Json, JsonAsync

--logger-pattern [enum | string]

Log pattern (default: Plain)

  • Environment variable: SCRIBE_LOGGER_PATTERN

  • System property: logger.pattern

  • Enumeration values: Plain, Standard, Structured

--logger-level enum

Log level (default: Info)

  • Environment variable: SCRIBE_LOGGER_LEVEL

  • System property: logger.level

  • Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None

--filter-contracts string

Filter expression determining which templates and interfaces to include (default: *)

  • Environment variable: SCRIBE_FILTER_CONTRACTS

  • System property: filter.contracts

--oauth-clientid string

Client’s identifier (optional)

  • Environment variable: SCRIBE_OAUTH_CLIENTID

  • System property: oauth.clientId

--oauth-accesstoken string

Access token (optional)

  • Environment variable: SCRIBE_OAUTH_ACCESSTOKEN

  • System property: oauth.accessToken

--oauth-scope [enum | string]

Token scope (default: Default)

  • Environment variable: SCRIBE_OAUTH_SCOPE

  • System property: oauth.scope

  • Enumeration values: Default, None

--oauth-parameters map

Custom parameters

  • Environment variable: SCRIBE_OAUTH_PARAMETERS

  • System property: oauth.parameters

--oauth-preemptexpiry string

The duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M)

  • Environment variable: SCRIBE_OAUTH_PREEMPTEXPIRY

  • System property: oauth.preemptExpiry

--oauth-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_OAUTH_CAFILE

  • System property: oauth.cafile

--oauth-endpoint uri

Token endpoint URL (optional)

  • Environment variable: SCRIBE_OAUTH_ENDPOINT

  • System property: oauth.endpoint

--oauth-issuer uri

OIDC-compliant issuer URL (optional)

  • Environment variable: SCRIBE_OAUTH_ISSUER

  • System property: oauth.issuer

--oauth-clientsecret string

Client’s secret (optional)

  • Environment variable: SCRIBE_OAUTH_CLIENTSECRET

  • System property: oauth.clientSecret

./scribe.jar datastore postgres-document schema apply parameters

Parameter

Description

--config file

Path to configuration overrides via an external HOCON file (optional)

  • Environment variable: SCRIBE_CONFIG

  • System property: config

--ledger-host string

Ledger API host (default: localhost)

  • Environment variable: SCRIBE_LEDGER_HOST

  • System property: ledger.host

--ledger-cachedir file

Cache Directory (default: /tmp/scribe)

  • Environment variable: SCRIBE_LEDGER_CACHEDIR

  • System property: ledger.cacheDir

--ledger-buffersize int

Buffer size for gRPC channel (default: 128)

  • Environment variable: SCRIBE_LEDGER_BUFFERSIZE

  • System property: ledger.bufferSize

--ledger-keepalive-time string

Duration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S)

  • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIME

  • System property: ledger.keepAlive.time

--ledger-keepalive-timeout string

Duration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S)

  • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIMEOUT

  • System property: ledger.keepAlive.timeout

--ledger-auth enum

Authorisation mode (default: NoAuth)

  • Environment variable: SCRIBE_LEDGER_AUTH

  • System property: ledger.auth

  • Enumeration values: OAuth, NoAuth

--ledger-tls-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_LEDGER_TLS_CAFILE

  • System property: ledger.tls.cafile

--ledger-tls-cert file

Client’s certificate (leave empty if embedded into private key file) (optional)

  • Environment variable: SCRIBE_LEDGER_TLS_CERT

  • System property: ledger.tls.cert

--ledger-tls-key file

Client’s private key (leave empty for server-only TLS) (optional)

  • Environment variable: SCRIBE_LEDGER_TLS_KEY

  • System property: ledger.tls.key

--ledger-port int

Ledger API port (default: 6865)

  • Environment variable: SCRIBE_LEDGER_PORT

  • System property: ledger.port

--logger-destination file

Log output file (default: output.log)

  • Environment variable: SCRIBE_LOGGER_DESTINATION

  • System property: logger.destination

--logger-mappings map

Custom mappings for log levels

  • Environment variable: SCRIBE_LOGGER_MAPPINGS

  • System property: logger.mappings

--logger-format enum

Log output format (default: Plain)

  • Environment variable: SCRIBE_LOGGER_FORMAT

  • System property: logger.format

  • Enumeration values: Plain, PlainAsync, Json, JsonAsync

--logger-pattern [enum | string]

Log pattern (default: Plain)

  • Environment variable: SCRIBE_LOGGER_PATTERN

  • System property: logger.pattern

  • Enumeration values: Plain, Standard, Structured

--logger-level enum

Log level (default: Info)

  • Environment variable: SCRIBE_LOGGER_LEVEL

  • System property: logger.level

  • Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None

--filter-contracts string

Filter expression determining which templates and interfaces to include (default: *)

  • Environment variable: SCRIBE_FILTER_CONTRACTS

  • System property: filter.contracts

--schema-autoapply boolean

Apply metadata inferred schema on startup (default: true)

  • Environment variable: SCRIBE_SCHEMA_AUTOAPPLY

  • System property: schema.autoApply

--schema-baseline boolean

Baseline existing database schema during apply (default: false)

  • Environment variable: SCRIBE_SCHEMA_BASELINE

  • System property: schema.baseline

--postgres-host string

Postgres host (default: localhost)

  • Environment variable: SCRIBE_POSTGRES_HOST

  • System property: postgres.host

--postgres-appname string

Application name for Postgres connections (default: scribe)

  • Environment variable: SCRIBE_POSTGRES_APPNAME

  • System property: postgres.appName

--postgres-buffersize int

Buffer size for transactions processing (default: 128)

  • Environment variable: SCRIBE_POSTGRES_BUFFERSIZE

  • System property: postgres.bufferSize

--postgres-tls-mode enum

SSL mode required for Postgres connectivity (default: Disable)

  • Environment variable: SCRIBE_POSTGRES_TLS_MODE

  • System property: postgres.tls.mode

  • Enumeration values: Disable, Require, VerifyCA, VerifyFull

--postgres-tls-cert file

Client’s certificate (optional)

  • Environment variable: SCRIBE_POSTGRES_TLS_CERT

  • System property: postgres.tls.cert

--postgres-tls-key file

Client’s private key (optional)

  • Environment variable: SCRIBE_POSTGRES_TLS_KEY

  • System property: postgres.tls.key

--postgres-tls-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_POSTGRES_TLS_CAFILE

  • System property: postgres.tls.cafile

--postgres-keepalive boolean

Enable/disable TCP keep-alive probe (default: true)

  • Environment variable: SCRIBE_POSTGRES_KEEPALIVE

  • System property: postgres.keepAlive

--postgres-maxconnections int

Maximum number of JDBC connections (default: 16)

  • Environment variable: SCRIBE_POSTGRES_MAXCONNECTIONS

  • System property: postgres.maxConnections

--postgres-password string

Postgres user password (default: ********)

  • Environment variable: SCRIBE_POSTGRES_PASSWORD

  • System property: postgres.password

--postgres-username string

Postgres user name (default: postgres)

  • Environment variable: SCRIBE_POSTGRES_USERNAME

  • System property: postgres.username

--postgres-schema string

Postgres schema (default: public)

  • Environment variable: SCRIBE_POSTGRES_SCHEMA

  • System property: postgres.schema

--postgres-database string

Postgres database (default: postgres)

  • Environment variable: SCRIBE_POSTGRES_DATABASE

  • System property: postgres.database

--postgres-port int

Postgres port (default: 5432)

  • Environment variable: SCRIBE_POSTGRES_PORT

  • System property: postgres.port

--oauth-clientid string

Client’s identifier (optional)

  • Environment variable: SCRIBE_OAUTH_CLIENTID

  • System property: oauth.clientId

--oauth-accesstoken string

Access token (optional)

  • Environment variable: SCRIBE_OAUTH_ACCESSTOKEN

  • System property: oauth.accessToken

--oauth-scope [enum | string]

Token scope (default: Default)

  • Environment variable: SCRIBE_OAUTH_SCOPE

  • System property: oauth.scope

  • Enumeration values: Default, None

--oauth-parameters map

Custom parameters

  • Environment variable: SCRIBE_OAUTH_PARAMETERS

  • System property: oauth.parameters

--oauth-preemptexpiry string

The duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M)

  • Environment variable: SCRIBE_OAUTH_PREEMPTEXPIRY

  • System property: oauth.preemptExpiry

--oauth-cafile file

Trusted Certificate Authority (CA) certificate (optional)

  • Environment variable: SCRIBE_OAUTH_CAFILE

  • System property: oauth.cafile

--oauth-endpoint uri

Token endpoint URL (optional)

  • Environment variable: SCRIBE_OAUTH_ENDPOINT

  • System property: oauth.endpoint

--oauth-issuer uri

OIDC-compliant issuer URL (optional)

  • Environment variable: SCRIBE_OAUTH_ISSUER

  • System property: oauth.issuer

--oauth-clientsecret string

Client’s secret (optional)

  • Environment variable: SCRIBE_OAUTH_CLIENTSECRET

  • System property: oauth.clientSecret