Skip to main content

Interface: IEngineEnvironmentVariables

The engine core environment variables.

Properties​

debug?​

optional debug?: string

Start the engine in debug mode.

silent?​

optional silent?: string

Start the engine in silent mode.

strictEnv?​

optional strictEnv?: string

Controls how unrecognised TWIN_* environment variables are handled at startup. "error" (default): throws a startup error, allowing CI and production deployments to hard-fail on misconfigured or misspelled variable names. "warn": logs a warning and continues. "ignore": skips validation entirely. Any other value is rejected at startup.

Default​

"error"

envAllowList?​

optional envAllowList?: string

Comma-separated list of raw environment variable names to exempt from the unknown-key check. Use this to allowlist variables introduced by custom extensions that are not part of the core interface, e.g. TWIN_MY_EXTENSION_SECRET.

storageFileRoot?​

optional storageFileRoot?: string

The root directory for storing items like state file.

stateFilename?​

optional stateFilename?: string

The name of the state file.

tenantEnabled?​

optional tenantEnabled?: string

Is multi-tenant support enabled, defaults to false.

schemaMigrationEnabled?​

optional schemaMigrationEnabled?: string

Enable schema migration, defaults to true.

entityStorageConnectorType?​

optional entityStorageConnectorType?: string

The type of the entity storage to create, comma separate for more than one connector. values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql

entityStorageConnectorDefault?​

optional entityStorageConnectorDefault?: string

The default entity storage connector to use, defaults to the first one in the list.

entityStorageTablePrefix?​

optional entityStorageTablePrefix?: string

A prefix for all the table in entity-storage, can be empty.

awsDynamodbAuthMode?​

optional awsDynamodbAuthMode?: string

AWS DynamoDB auth mode, either credentials or pod.

awsDynamodbAccessKeyId?​

optional awsDynamodbAccessKeyId?: string

AWS Dynamo DB access key id.

awsDynamodbEndpoint?​

optional awsDynamodbEndpoint?: string

AWS Dynamo DB Endpoint if running local instance.

awsDynamodbRegion?​

optional awsDynamodbRegion?: string

AWS Dynamo DB region.

awsDynamodbSecretAccessKey?​

optional awsDynamodbSecretAccessKey?: string

AWS Dynamo DB secret access key.

awsDynamodbConnectionTimeout?​

optional awsDynamodbConnectionTimeout?: string

AWS Dynamo DB connection timeout in milliseconds.

azureCosmosdbKey?​

optional azureCosmosdbKey?: string

Azure Cosmos DB key.

azureCosmosdbContainerId?​

optional azureCosmosdbContainerId?: string

Azure Cosmos DB container id.

azureCosmosdbDatabaseId?​

optional azureCosmosdbDatabaseId?: string

Azure Cosmos DB database id.

azureCosmosdbEndpoint?​

optional azureCosmosdbEndpoint?: string

Azure Cosmos DB endpoint.

gcpFirestoreCollectionName?​

optional gcpFirestoreCollectionName?: string

GCP Firestore collection name.

gcpFirestoreCredentials?​

optional gcpFirestoreCredentials?: string

GCP Firestore credentials.

gcpFirestoreDatabaseId?​

optional gcpFirestoreDatabaseId?: string

GCP Firestore database id.

gcpFirestoreEndpoint?​

optional gcpFirestoreEndpoint?: string

GCP Firestore endpoint.

gcpFirestoreProjectId?​

optional gcpFirestoreProjectId?: string

GCP Firestore project id.

scylladbHosts?​

optional scylladbHosts?: string

ScyllaDB hosts as comma separated string.

scylladbKeyspace?​

optional scylladbKeyspace?: string

ScyllaDB keyspace.

scylladbLocalDataCenter?​

optional scylladbLocalDataCenter?: string

ScyllaDB local data center.

scylladbPort?​

optional scylladbPort?: string

ScyllaDB port.

scylladbPoolCoreConnectionsPerHost?​

optional scylladbPoolCoreConnectionsPerHost?: string

ScyllaDB connection pool: number of connections per local host.

scylladbPoolMaxRequestsPerConnection?​

optional scylladbPoolMaxRequestsPerConnection?: string

ScyllaDB connection pool: maximum requests per connection.

mySqlHost?​

optional mySqlHost?: string

MySQL host.

mySqlPort?​

optional mySqlPort?: string

MySQL port.

mySqlUser?​

optional mySqlUser?: string

MySQL username.

mySqlPassword?​

optional mySqlPassword?: string

MySQL password.

mySqlDatabase?​

optional mySqlDatabase?: string

MySQL Database.

mySqlPoolConnectionLimit?​

optional mySqlPoolConnectionLimit?: string

MySQL connection pool: maximum number of connections.

mySqlPoolMaxIdle?​

optional mySqlPoolMaxIdle?: string

MySQL connection pool: maximum number of idle connections.

mySqlPoolIdleTimeout?​

optional mySqlPoolIdleTimeout?: string

MySQL connection pool: milliseconds before an idle connection is removed.

mySqlPoolEnableKeepAlive?​

optional mySqlPoolEnableKeepAlive?: string

MySQL connection pool: enable TCP keep-alive.

mySqlPoolWaitForConnections?​

optional mySqlPoolWaitForConnections?: string

MySQL connection pool: wait for a connection when pool is full.

mySqlPoolQueueLimit?​

optional mySqlPoolQueueLimit?: string

MySQL connection pool: maximum queued requests (0 = unlimited).

mongoDbHost?​

optional mongoDbHost?: string

MongoDB host.

mongoDbPort?​

optional mongoDbPort?: string

MongoDB port.

mongoDbUser?​

optional mongoDbUser?: string

MongoDB username.

mongoDbPassword?​

optional mongoDbPassword?: string

MongoDB password.

mongoDbDatabase?​

optional mongoDbDatabase?: string

MongoDB Database.

mongoDbPoolMaxPoolSize?​

optional mongoDbPoolMaxPoolSize?: string

MongoDB connection pool: maximum number of connections.

mongoDbPoolMinPoolSize?​

optional mongoDbPoolMinPoolSize?: string

MongoDB connection pool: minimum number of connections to maintain.

mongoDbPoolMaxIdleTime?​

optional mongoDbPoolMaxIdleTime?: string

MongoDB connection pool: milliseconds a connection can remain idle before removal.

mongoDbPoolWaitQueueTimeout?​

optional mongoDbPoolWaitQueueTimeout?: string

MongoDB connection pool: milliseconds to wait for a connection before throwing.

postgreSqlHost?​

optional postgreSqlHost?: string

PostgreSQl host.

postgreSqlPort?​

optional postgreSqlPort?: string

PostgreSQl port.

postgreSqlUser?​

optional postgreSqlUser?: string

PostgreSQl username.

postgreSqlPassword?​

optional postgreSqlPassword?: string

PostgreSQl password.

postgreSqlDatabase?​

optional postgreSqlDatabase?: string

PostgreSQl Database.

postgreSqlPoolMax?​

optional postgreSqlPoolMax?: string

PostgreSQL connection pool: maximum number of connections.

postgreSqlPoolIdleTimeout?​

optional postgreSqlPoolIdleTimeout?: string

PostgreSQL connection pool: seconds a connection can remain idle before being closed.

postgreSqlPoolConnectTimeout?​

optional postgreSqlPoolConnectTimeout?: string

PostgreSQL connection pool: seconds to wait when establishing a connection.

postgreSqlPoolMaxLifetime?​

optional postgreSqlPoolMaxLifetime?: string

PostgreSQL connection pool: maximum seconds a connection can remain open.

ipfsBearerToken?​

optional ipfsBearerToken?: string

The security token for accessing IPFS API.

ipfsApiUrl?​

optional ipfsApiUrl?: string

The url for accessing IPFS API.

blobStorageConnectorType?​

optional blobStorageConnectorType?: string

The type of the entity storage to create, comma separate for more than one connector. values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.

blobStorageConnectorDefault?​

optional blobStorageConnectorDefault?: string

The default blob storage connector to use, defaults to the first one in the list.

blobStorageEnableEncryption?​

optional blobStorageEnableEncryption?: string

Enable encryption for the blob storage.

blobStorageEncryptionKeyId?​

optional blobStorageEncryptionKeyId?: string

The id of the encryption key for the blob storage.

blobStoragePrefix?​

optional blobStoragePrefix?: string

A prefix for all the blobs in blob-storage, can be empty.

awsS3Region?​

optional awsS3Region?: string

AWS S3 region.

awsS3BucketName?​

optional awsS3BucketName?: string

AWS S3 bucket name.

awsS3AuthMode?​

optional awsS3AuthMode?: string

AWS S3 auth mode, either credentials or pod, defaults to credentials.

awsS3AccessKeyId?​

optional awsS3AccessKeyId?: string

AWS S3 access key id.

awsS3SecretAccessKey?​

optional awsS3SecretAccessKey?: string

AWS S3 secret access key.

awsS3Endpoint?​

optional awsS3Endpoint?: string

AWS S3 endpoint.

azureStorageAccountKey?​

optional azureStorageAccountKey?: string

Azure Storage account key.

azureStorageAccountName?​

optional azureStorageAccountName?: string

Azure Storage account name.

azureStorageContainerName?​

optional azureStorageContainerName?: string

Azure Storage container.

azureStorageEndpoint?​

optional azureStorageEndpoint?: string

Azure Storage endpoint.

gcpStorageBucketName?​

optional gcpStorageBucketName?: string

GCP Storage bucket.

gcpStorageCredentials?​

optional gcpStorageCredentials?: string

GCP Storage credentials.

gcpStorageEndpoint?​

optional gcpStorageEndpoint?: string

GCP Storage endpoint.

gcpStorageProjectId?​

optional gcpStorageProjectId?: string

GCP Storage project id.

vaultConnector?​

optional vaultConnector?: string

The type of the default vault connector: entity-storage, hashicorp.

vaultPrefix?​

optional vaultPrefix?: string

Prefix to prepend to entries in the vault.

hashicorpVaultToken?​

optional hashicorpVaultToken?: string

Hashicorp Vault token.

hashicorpVaultEndpoint?​

optional hashicorpVaultEndpoint?: string

Hashicorp Vault endpoint.

loggingConnector?​

optional loggingConnector?: string

The type of logging task connector, can be a comma separated list: console, entity-storage, open-telemetry, file.

loggingBatchSize?​

optional loggingBatchSize?: string

The batch size for the logging task, set to 1 for no batching.

loggingBatchFlushInterval?​

optional loggingBatchFlushInterval?: string

The batch flush interval in seconds for the logging task, how often to flush the logs when using batching, defaults to 5 seconds.

loggingRetainFor?​

optional loggingRetainFor?: string

Delete log entries older than this many minutes for the entity-storage logging connector. Set to 0 to disable age-based retention.

Default​

2880 (2 days)

loggingMaxEntries?​

optional loggingMaxEntries?: string

Keep at most this many log entries for the entity-storage logging connector. Set to 0 to disable count-based retention.

Default​

10000

loggingRetentionInterval?​

optional loggingRetentionInterval?: string

How often the retention cleanup task runs in minutes for the entity-storage logging connector. Set to 0 to disable periodic cleanup.

Default​

5

loggingRetentionBatchSize?​

optional loggingRetentionBatchSize?: string

Maximum number of entries deleted per cleanup batch for the entity-storage logging connector. Keeping this value smaller helps avoid spikes in database load.

Default​

1000

loggingSilentComponents?​

optional loggingSilentComponents?: string

A list of components to exclude from logging, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".

loggingFileDirectory?​

optional loggingFileDirectory?: string

The directory to write log files into when using the file logging connector. Required when TWIN_LOGGING_CONNECTOR includes "file".

loggingFileFilename?​

optional loggingFileFilename?: string

The log filename when using the file logging connector, defaults to "app.log".

loggingFileMaxFileSizeBytes?​

optional loggingFileMaxFileSizeBytes?: string

The maximum log file size in bytes before rotation when using the file logging connector, defaults to 10485760 (10 MB). Set to 0 or negative to disable rotation.

loggingFileMaxRetainedFiles?​

optional loggingFileMaxRetainedFiles?: string

The number of rotated log files to retain when using the file logging connector, defaults to 5. Set to 0 or negative to keep all rotated files.

telemetrySilentComponents?​

optional telemetrySilentComponents?: string

A list of components to exclude from telemetry, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".

openTelemetryLoggingLoggerName?​

optional openTelemetryLoggingLoggerName?: string

The name of the OpenTelemetry logger, only required if using open-telemetry as logging connector, defaults to twin-logging.

openTelemetryLoggingLoggerVersion?​

optional openTelemetryLoggingLoggerVersion?: string

The version of the OpenTelemetry logger, only required if using open-telemetry as logging connector, defaults to 1.0.0.

openTelemetryLoggingPrometheusEndpoint?​

optional openTelemetryLoggingPrometheusEndpoint?: string

The OTLP endpoint URL for the OpenTelemetry logging exporter, required when using open-telemetry as logging connector, e.g. http://localhost:4318/v1/logs.

openTelemetryLoggingProcessor?​

optional openTelemetryLoggingProcessor?: string

The log record processor to use for the OpenTelemetry logging exporter, either batch or simple, defaults to batch.

eventBusConnector?​

optional eventBusConnector?: string

The type of event bus connector: local.

eventBusComponent?​

optional eventBusComponent?: string

The type of event bus component: service.

messagingEnabled?​

optional messagingEnabled?: string

Are the messaging components enabled, defaults to false.

awsSesRegion?​

optional awsSesRegion?: string

AWS SES region.

awsSesAuthMode?​

optional awsSesAuthMode?: string

AWS SES auth mode, either credentials or pod, defaults to credentials.

awsSesSecretAccessKey?​

optional awsSesSecretAccessKey?: string

AWS SES secret access key.

awsSesAccessKeyId?​

optional awsSesAccessKeyId?: string

AWS SES access key id.

awsSesEndpoint?​

optional awsSesEndpoint?: string

AWS SES endpoint.

awsMessagingPushNotificationApplications?​

optional awsMessagingPushNotificationApplications?: string

The applications for the push notifications reference a separate json with @json: prefix.

messagingEmailConnector?​

optional messagingEmailConnector?: string

The type of messaging email connector: entity-storage, aws.

messagingSmsConnector?​

optional messagingSmsConnector?: string

The type of messaging sms connector: entity-storage, aws.

messagingPushNotificationConnector?​

optional messagingPushNotificationConnector?: string

The type of messaging push notification connector: entity-storage, aws.

telemetryConnector?​

optional telemetryConnector?: string

The type of telemetry connector, comma-separated for multiple: entity-storage, open-telemetry, silent.

openTelemetryMeterName?​

optional openTelemetryMeterName?: string

The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.

openTelemetryMeterVersion?​

optional openTelemetryMeterVersion?: string

The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.

openTelemetryReader?​

optional openTelemetryReader?: string

The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.

openTelemetryPrometheusPort?​

optional openTelemetryPrometheusPort?: string

The port to use for the Open Telemetry Prometheus metrics server, only required if using open-telemetry as telemetry connector and prometheus as reader, defaults to 9464.

telemetryMetricsCollectorInterval?​

optional telemetryMetricsCollectorInterval?: string

Polling interval in seconds for the telemetry metrics collector. Defaults to 60.

telemetryMetricsProducers?​

optional telemetryMetricsProducers?: string

The type of telemetry metrics producers, can be a comma separated list: system, process.

telemetryMetricsProducerMaxHistory?​

optional telemetryMetricsProducerMaxHistory?: string

Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.

telemetryBatchSize?​

optional telemetryBatchSize?: string

The batch size for the telemetry connector, set to 1 to disable size-based flushing.

telemetryBatchFlushInterval?​

optional telemetryBatchFlushInterval?: string

The batch flush interval in seconds for the telemetry connector, how often to flush when using batching, defaults to 5 seconds.

telemetryMaxCacheSize?​

optional telemetryMaxCacheSize?: string

The maximum number of metric values to hold in the write-ahead cache for the telemetry connector. Set to 0 for unlimited.

Default​

1000

telemetryMutexTimeout?​

optional telemetryMutexTimeout?: string

The mutex timeout in milliseconds for the telemetry connector.

telemetryMetricDefinitionCacheCapacity?​

optional telemetryMetricDefinitionCacheCapacity?: string

The maximum number of metric definitions held in the in-memory definition cache for the telemetry connector.

Default​

100

telemetryMetricDefinitionCacheTtiMs?​

optional telemetryMetricDefinitionCacheTtiMs?: string

The time-to-idle in milliseconds for cached metric definitions in the telemetry connector.

Default​

3600000

tracingSilentComponents?​

optional tracingSilentComponents?: string

A list of components to exclude from tracing, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".

tracingConnector?​

optional tracingConnector?: string

The type of tracing connector, comma-separated for multiple: entity-storage, open-telemetry, silent.

openTelemetryTracingTracerName?​

optional openTelemetryTracingTracerName?: string

The name of the Open Telemetry tracer to use, only required if using open-telemetry as tracing connector, defaults to twin-node.

openTelemetryTracingTracerVersion?​

optional openTelemetryTracingTracerVersion?: string

The version of the Open Telemetry tracing specification to use, only required if using open-telemetry as tracing connector, defaults to 1.0.0.

openTelemetryTracingEndpoint?​

optional openTelemetryTracingEndpoint?: string

The OTLP HTTP endpoint to push spans to, e.g. http://localhost:4318/v1/traces. Required when using open-telemetry as tracing connector.

openTelemetryTracingProcessor?​

optional openTelemetryTracingProcessor?: string

The span processor: batch (default) or simple. Only used when TWIN_TRACING_CONNECTOR=open-telemetry.

tracingMutexTimeout?​

optional tracingMutexTimeout?: string

The mutex timeout in milliseconds for the tracing connector.

faucetConnector?​

optional faucetConnector?: string

The type of faucet connector: entity-storage, iota.

walletConnector?​

optional walletConnector?: string

The type of wallet connector: entity-storage, iota.

nftConnector?​

optional nftConnector?: string

The type of NFT connector: entity-storage, iota.

nftPackageId?​

optional nftPackageId?: string

The NFT deployed package id, for custom deployments.

notarizationConnector?​

optional notarizationConnector?: string

The type of notarization connector: entity-storage, iota.

identityConnector?​

optional identityConnector?: string

The type of identity connector: entity-storage, iota.

identityWalletAddressIndex?​

optional identityWalletAddressIndex?: string

The index of the wallet address to use, defaults to 0.

identityDidResolutionCacheTtl?​

optional identityDidResolutionCacheTtl?: string

The TTL in milliseconds for caching resolved DIDs when using the IOTA identity connector. Omit to use the connector default.

identityDidResolutionCacheCapacity?​

optional identityDidResolutionCacheCapacity?: string

The maximum number of DID documents to hold in the resolution cache. Only used when using the IOTA identity connector and caching is enabled.

identityDidResolutionCacheMutexTimeout?​

optional identityDidResolutionCacheMutexTimeout?: string

The mutex timeout in milliseconds for the DID resolution cache. Only used when using the IOTA identity connector and caching is enabled.

identityDidResolutionRetries?​

optional identityDidResolutionRetries?: string

The number of times to retry resolving a DID after a write operation (create, update, or delete) to confirm propagation. Only used when using the IOTA identity connector.

identityDidResolutionRetryDelay?​

optional identityDidResolutionRetryDelay?: string

The delay in milliseconds between DID resolution retries after a write operation. Only used when using the IOTA identity connector.

identityResolverConnector?​

optional identityResolverConnector?: string

The type of identity resolver connector: entity-storage, iota.

iotaFaucetEndpoint?​

optional iotaFaucetEndpoint?: string

IOTA Faucet Endpoint.

iotaNodeEndpoint?​

optional iotaNodeEndpoint?: string

IOTA Node Endpoint.

iotaNetwork?​

optional iotaNetwork?: string

IOTA network.

iotaCoinType?​

optional iotaCoinType?: string

IOTA coin type.

iotaGasBudget?​

optional iotaGasBudget?: string

IOTA gas budget, in nanos.

iotaGasReservationDuration?​

optional iotaGasReservationDuration?: string

IOTA gas reservation duration, in seconds.

iotaExplorerEndpoint?​

optional iotaExplorerEndpoint?: string

IOTA Explorer Endpoint.

iotaGasStationEndpoint?​

optional iotaGasStationEndpoint?: string

IOTA Gas Station Endpoint.

iotaGasStationAuthToken?​

optional iotaGasStationAuthToken?: string

IOTA Gas Station Authentication Token.

iotaIdentityPackageId?​

optional iotaIdentityPackageId?: string

The IOTA Identity deployed package id, for custom deployments.

universalResolverEndpoint?​

optional universalResolverEndpoint?: string

Universal Resolver Endpoint.

identityProfileConnector?​

optional identityProfileConnector?: string

The type of identity profile connector: entity-storage.

immutableProofVerificationMethodId?​

optional immutableProofVerificationMethodId?: string

The identity verification method id to use with immutable proofs.

immutableProofTaskRetryCount?​

optional immutableProofTaskRetryCount?: string

The number of times to retry a proof task when it fails, 0 to disable retries.

Default​

5

immutableProofTaskRetryInterval?​

optional immutableProofTaskRetryInterval?: string

The interval in seconds to wait between proof task retries.

Default​

5

immutableProofTaskFailureRetainFor?​

optional immutableProofTaskFailureRetainFor?: string

The time in minutes to retain the record of a failed proof task. Set to -1 to retain failures forever.

Default​

10080

immutableProofSweepInterval?​

optional immutableProofSweepInterval?: string

How often in minutes the immutable proof reconciliation sweep runs.

Default​

30

immutableProofSweepStaleThreshold?​

optional immutableProofSweepStaleThreshold?: string

The minimum age in minutes before a proof with no notarization is considered stuck.

Default​

180

immutableProofSweepMaxAttempts?​

optional immutableProofSweepMaxAttempts?: string

The number of sweep attempts made before a proof is parked.

Default​

5

immutableProofSweepBatchLimit?​

optional immutableProofSweepBatchLimit?: string

The maximum number of proofs to re-enqueue per tenant per sweep cycle.

Default​

10

immutableProofSweepBackoff?​

optional immutableProofSweepBackoff?: string

The minimum time in minutes between sweep attempts for the same proof.

Default​

60

immutableProofSweepAssumeRetryableBefore?​

optional immutableProofSweepAssumeRetryableBefore?: string

ISO 8601 date-time used to treat older missing-task proofs as retryable.

attestationConnector?​

optional attestationConnector?: string

The type of attestation connector: entity-storage, iota.

attestationVerificationMethodId?​

optional attestationVerificationMethodId?: string

The identity verification method id to use with attestation.

dataProcessingEnabled?​

optional dataProcessingEnabled?: string

Is the data processing enabled, defaults to false.

dataConverterConnectors?​

optional dataConverterConnectors?: string

The type of the default data converters, can be a comma separated list: json, xml.

dataExtractorConnectors?​

optional dataExtractorConnectors?: string

The type of the default data extractor, can be a comma separated list: json-path.

taskSchedulerEnabled?​

optional taskSchedulerEnabled?: string

Enable the task scheduler regardless of which other components are active, defaults to false.

auditableItemGraphEnabled?​

optional auditableItemGraphEnabled?: string

Is the auditable item graph enabled, defaults to false.

auditableItemStreamEnabled?​

optional auditableItemStreamEnabled?: string

Is the auditable item stream enabled, defaults to false.

documentManagementEnabled?​

optional documentManagementEnabled?: string

Is the document management enabled, defaults to false.

federatedCatalogueEnabled?​

optional federatedCatalogueEnabled?: string

Enable the federated catalogue, defaults to false, automatically enabled if remote endpoint, filters or dataspace is enabled.

federatedCatalogueFilters?​

optional federatedCatalogueFilters?: string

Federated catalog filters, command separated list of filters to add.

federatedCatalogueRemoteEndpoint?​

optional federatedCatalogueRemoteEndpoint?: string

Federated catalog remote endpoint, if set will use a REST client instead of local service.

federatedCatalogueRestClientPathPrefix?​

optional federatedCatalogueRestClientPathPrefix?: string

The path prefix used by the federated catalogue REST client when forwarding requests to the remote endpoint, defaults to "federated-catalogue".

trustGenerators?​

optional trustGenerators?: string

The trust generators to add to the factory, comma separated list.

trustVerifiers?​

optional trustVerifiers?: string

The trust verifiers to add to the factory, comma separated list.

trustVerificationMethodId?​

optional trustVerificationMethodId?: string

The verification method to use for trust identities. Defaults to trust-assertion.

trustJwtTtl?​

optional trustJwtTtl?: string

The trust time to live for generating JWTs in seconds. Defaults to undefined for never expiring.

trustIdentitiesAllow?​

optional trustIdentitiesAllow?: string

The allow lists for the trust identity verifier, comma separated list of identities.

trustIdentitiesDeny?​

optional trustIdentitiesDeny?: string

The deny lists for the trust identity verifier, comma separated list of identities.

rightsManagementCallbackPath?​

optional rightsManagementCallbackPath?: string

Path under which the rights management service is mounted (single source of truth). The same value drives:

  • the server route mount (via engine config)
  • the PNP service's callback URL builder (buildCallbackUrl)
  • the PNP rest-client's pathPrefix (consumer side) Defaults to rights-management. Set when deploying behind a reverse proxy with path rewriting, K8s ingress with path-based routing, or any custom mount point.

rightsManagementPolicyInformationSources?​

optional rightsManagementPolicyInformationSources?: string

The rights management policy information sources to add to the factory.

rightsManagementPolicyNegotiators?​

optional rightsManagementPolicyNegotiators?: string

The rights management policy negotiators sources to add to the factory.

rightsManagementPolicyRequesters?​

optional rightsManagementPolicyRequesters?: string

The rights management policy requesters to add to the factory.

rightsManagementPolicyExecutionActions?​

optional rightsManagementPolicyExecutionActions?: string

The rights management policy execution actions to add to the factory.

rightsManagementPolicyEnforcementProcessors?​

optional rightsManagementPolicyEnforcementProcessors?: string

The rights management policy enforcement processors to add to the factory.

rightsManagementPolicyArbiters?​

optional rightsManagementPolicyArbiters?: string

The rights management policy arbiters to add to the factory.

rightsManagementPolicyObligationEnforcers?​

optional rightsManagementPolicyObligationEnforcers?: string

The rights management policy obligation enforcers to add to the factory.

dataspaceEnabled?​

optional dataspaceEnabled?: string

Is the dataspace enabled, defaults to false.

dataspaceRetainActivityLogsFor?​

optional dataspaceRetainActivityLogsFor?: string

The length of time to retain the activity logs for in seconds, set to -1 to keep forever.

Default​

600

dataspaceActivityLogsCleanupInterval?​

optional dataspaceActivityLogsCleanupInterval?: string

The interval in seconds for cleaning up the activity logs.

Default​

3600

dataspaceAgreementCacheTtl?​

optional dataspaceAgreementCacheTtl?: string

The TTL in milliseconds for the dataspace agreement cache.

dataspaceAgreementCacheMutexTimeout?​

optional dataspaceAgreementCacheMutexTimeout?: string

The mutex timeout in milliseconds for the dataspace agreement cache.

dataspaceAgreementUnusedThreshold?​

optional dataspaceAgreementUnusedThreshold?: string

The time in milliseconds after which an unused agreement is eligible for removal.

dataspaceAgreementSweepInterval?​

optional dataspaceAgreementSweepInterval?: string

The interval in milliseconds between agreement sweep runs.

dataspaceRetryCount?​

optional dataspaceRetryCount?: string

The number of times to retry failed data plane tasks.

dataspacePushRetryCount?​

optional dataspacePushRetryCount?: string

Maximum HTTP retry attempts per push delivery task execution.

dataspacePushRetryBaseDelay?​

optional dataspacePushRetryBaseDelay?: string

Base delay in milliseconds for exponential backoff between push HTTP retries.

dataspacePushTimeout?​

optional dataspacePushTimeout?: string

Timeout in milliseconds for each push delivery HTTP POST request.

dataspacePushSubscriptionCleanupInterval?​

optional dataspacePushSubscriptionCleanupInterval?: string

Interval in milliseconds between orphaned push subscription cleanup scans.

dataspaceDataPlanePath?​

optional dataspaceDataPlanePath?: string

Base route path for the data plane service (path only, not full URL). Combined with the public origin to form the dataAddress.endpoint sent to PULL consumers and the inbox URL sent to PUSH providers.

This must be the mount-point prefix of the data plane routes, NOT a specific route path. Do NOT append sub-paths such as /entities or /inbox - those are appended automatically by each transfer handler and by the data plane REST client.

REQUIRED if PULL or PUSH transfers are supported. If not specified, PULL and PUSH transfers will not be available.

Example: "dataspace"

dataspaceAutoStartTransfers?​

optional dataspaceAutoStartTransfers?: string

Whether the provider immediately starts a transfer once it has been requested. When false the transfer stays in REQUESTED until the provider explicitly calls transferStarted.

Default​

false

dataspaceStalledNegotiationTimeout?​

optional dataspaceStalledNegotiationTimeout?: string

How long in seconds a negotiation may sit without progress before it is treated as timed out.

Default​

30

dataspaceStalledTransferTimeout?​

optional dataspaceStalledTransferTimeout?: string

How long in seconds a consumer-initiated transfer may sit in REQUESTED without the provider progressing it before it is treated as timed out.

Default​

30

dataspaceProviderTransferIdleTimeout?​

optional dataspaceProviderTransferIdleTimeout?: string

How long in seconds a provider transfer may stay idle before the idle policy marks it as stalled.

dataspaceProviderTransferPolicySweepInterval?​

optional dataspaceProviderTransferPolicySweepInterval?: string

How frequently in seconds the provider idle transfer policy sweep runs.

dataspaceCallbackPath?​

optional dataspaceCallbackPath?: string

Path under which the dataspace control plane is mounted (path only, not full URL). This must match the control-plane REST mount, as it is combined with the public origin to build the consumer's advertised callback address.

Default​

"dataspace-control-plane"

healthEnabled?​

optional healthEnabled?: string

Are the health components enabled, defaults to false.

healthInterval?​

optional healthInterval?: string

The interval in seconds for performing health checks, defaults to 60.

healthStartupInterval?​

optional healthStartupInterval?: string

The interval in seconds for performing health checks at startup, defaults to 2. This allows components that take a long time to initialize to be healthy before the first health check is performed.

healthApplicationInterval?​

optional healthApplicationInterval?: string

The interval in seconds for running the application health lifecycle (init, application, teardown), defaults to 300.

automationActionTypes?​

optional automationActionTypes?: string

The type of the automation action to create, comma separate for more than one connector. values: fetch

mutexTimeoutDefault?​

optional mutexTimeoutDefault?: string

The default mutex timeout in milliseconds, used when no component-specific timeout is set, defaults to 5000 if omitted.

auditableItemGraphMutexTimeout?​

optional auditableItemGraphMutexTimeout?: string

The mutex timeout in milliseconds for the auditable item graph component.

auditableItemStreamMutexTimeout?​

optional auditableItemStreamMutexTimeout?: string

The mutex timeout in milliseconds for the auditable item stream component.

federatedCatalogueMutexTimeout?​

optional federatedCatalogueMutexTimeout?: string

The mutex timeout in milliseconds for the federated catalogue component.

documentManagementMutexTimeout?​

optional documentManagementMutexTimeout?: string

The mutex timeout in milliseconds for the document management component.

loggingMutexTimeout?​

optional loggingMutexTimeout?: string

The mutex timeout in milliseconds for the logging component.

entityStorageMutexTimeout?​

optional entityStorageMutexTimeout?: string

The mutex timeout in milliseconds for the memory and file entity storage connectors.

rightsManagementMutexTimeout?​

optional rightsManagementMutexTimeout?: string

The mutex timeout in milliseconds for the rights management component.

extensions?​

optional extensions?: string

A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.