@twin.org/node-core 0.0.3-next.6 → 0.0.3-next.60

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -8,1131 +8,1260 @@ The engine core environment variables.
 
 ## Properties
 
-### debug?
+### debug? {#debug}
 
-> `optional` **debug**: `string`
+> `optional` **debug?**: `string`
 
 Start the engine in debug mode.
 
 ***
 
-### storageFileRoot?
+### silent? {#silent}
 
-> `optional` **storageFileRoot**: `string`
+> `optional` **silent?**: `string`
 
-The root directory for storing items like state file.
-
-***
-
-### stateFilename?
-
-> `optional` **stateFilename**: `string`
-
-The name of the state file.
+Start the engine in silent mode.
 
 ***
 
-### tenantEnabled?
+### storageFileRoot? {#storagefileroot}
 
-> `optional` **tenantEnabled**: `string`
+> `optional` **storageFileRoot?**: `string`
 
-Is multi-tenant support enabled, defaults to false.
+The root directory for storing items like state file.
 
 ***
 
-### tenantId?
+### stateFilename? {#statefilename}
 
-> `optional` **tenantId**: `string`
+> `optional` **stateFilename?**: `string`
 
-A tenant id to use as a default for the node.
+The name of the state file.
 
 ***
 
-### tenantApiKey?
+### tenantEnabled? {#tenantenabled}
 
-> `optional` **tenantApiKey**: `string`
+> `optional` **tenantEnabled?**: `string`
 
-A tenant api key to use as a default for the node.
+Is multi-tenant support enabled, defaults to false.
 
 ***
 
-### entityStorageConnectorType?
+### entityStorageConnectorType? {#entitystorageconnectortype}
 
-> `optional` **entityStorageConnectorType**: `string`
+> `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?
+### entityStorageConnectorDefault? {#entitystorageconnectordefault}
 
-> `optional` **entityStorageConnectorDefault**: `string`
+> `optional` **entityStorageConnectorDefault?**: `string`
 
 The default entity storage connector to use, defaults to the first one in the list.
 
 ***
 
-### entityStorageTablePrefix?
+### entityStorageTablePrefix? {#entitystoragetableprefix}
 
-> `optional` **entityStorageTablePrefix**: `string`
+> `optional` **entityStorageTablePrefix?**: `string`
 
 A prefix for all the table in entity-storage, can be empty.
 
 ***
 
-### awsDynamodbAuthMode?
+### awsDynamodbAuthMode? {#awsdynamodbauthmode}
 
-> `optional` **awsDynamodbAuthMode**: `string`
+> `optional` **awsDynamodbAuthMode?**: `string`
 
 AWS DynamoDB auth mode, either credentials or pod.
 
 ***
 
-### awsDynamodbAccessKeyId?
+### awsDynamodbAccessKeyId? {#awsdynamodbaccesskeyid}
 
-> `optional` **awsDynamodbAccessKeyId**: `string`
+> `optional` **awsDynamodbAccessKeyId?**: `string`
 
 AWS Dynamo DB access key id.
 
 ***
 
-### awsDynamodbEndpoint?
+### awsDynamodbEndpoint? {#awsdynamodbendpoint}
 
-> `optional` **awsDynamodbEndpoint**: `string`
+> `optional` **awsDynamodbEndpoint?**: `string`
 
 AWS Dynamo DB Endpoint if running local instance.
 
 ***
 
-### awsDynamodbRegion?
+### awsDynamodbRegion? {#awsdynamodbregion}
 
-> `optional` **awsDynamodbRegion**: `string`
+> `optional` **awsDynamodbRegion?**: `string`
 
 AWS Dynamo DB region.
 
 ***
 
-### awsDynamodbSecretAccessKey?
+### awsDynamodbSecretAccessKey? {#awsdynamodbsecretaccesskey}
 
-> `optional` **awsDynamodbSecretAccessKey**: `string`
+> `optional` **awsDynamodbSecretAccessKey?**: `string`
 
 AWS Dynamo DB secret access key.
 
 ***
 
-### awsDynamodbConnectionTimeoutMs?
+### awsDynamodbConnectionTimeoutMs? {#awsdynamodbconnectiontimeoutms}
 
-> `optional` **awsDynamodbConnectionTimeoutMs**: `string`
+> `optional` **awsDynamodbConnectionTimeoutMs?**: `string`
 
 AWS Dynamo DB connection timeout.
 
 ***
 
-### azureCosmosdbKey?
+### azureCosmosdbKey? {#azurecosmosdbkey}
 
-> `optional` **azureCosmosdbKey**: `string`
+> `optional` **azureCosmosdbKey?**: `string`
 
 Azure Cosmos DB key.
 
 ***
 
-### azureCosmosdbContainerId?
+### azureCosmosdbContainerId? {#azurecosmosdbcontainerid}
 
-> `optional` **azureCosmosdbContainerId**: `string`
+> `optional` **azureCosmosdbContainerId?**: `string`
 
 Azure Cosmos DB container id.
 
 ***
 
-### azureCosmosdbDatabaseId?
+### azureCosmosdbDatabaseId? {#azurecosmosdbdatabaseid}
 
-> `optional` **azureCosmosdbDatabaseId**: `string`
+> `optional` **azureCosmosdbDatabaseId?**: `string`
 
 Azure Cosmos DB database id.
 
 ***
 
-### azureCosmosdbEndpoint?
+### azureCosmosdbEndpoint? {#azurecosmosdbendpoint}
 
-> `optional` **azureCosmosdbEndpoint**: `string`
+> `optional` **azureCosmosdbEndpoint?**: `string`
 
 Azure Cosmos DB endpoint.
 
 ***
 
-### gcpFirestoreCollectionName?
+### gcpFirestoreCollectionName? {#gcpfirestorecollectionname}
 
-> `optional` **gcpFirestoreCollectionName**: `string`
+> `optional` **gcpFirestoreCollectionName?**: `string`
 
 GCP Firestore collection name.
 
 ***
 
-### gcpFirestoreCredentials?
+### gcpFirestoreCredentials? {#gcpfirestorecredentials}
 
-> `optional` **gcpFirestoreCredentials**: `string`
+> `optional` **gcpFirestoreCredentials?**: `string`
 
 GCP Firestore credentials.
 
 ***
 
-### gcpFirestoreDatabaseId?
+### gcpFirestoreDatabaseId? {#gcpfirestoredatabaseid}
 
-> `optional` **gcpFirestoreDatabaseId**: `string`
+> `optional` **gcpFirestoreDatabaseId?**: `string`
 
 GCP Firestore database id.
 
 ***
 
-### gcpFirestoreApiEndpoint?
+### gcpFirestoreEndpoint? {#gcpfirestoreendpoint}
 
-> `optional` **gcpFirestoreApiEndpoint**: `string`
+> `optional` **gcpFirestoreEndpoint?**: `string`
 
 GCP Firestore endpoint.
 
 ***
 
-### gcpFirestoreProjectId?
+### gcpFirestoreProjectId? {#gcpfirestoreprojectid}
 
-> `optional` **gcpFirestoreProjectId**: `string`
+> `optional` **gcpFirestoreProjectId?**: `string`
 
 GCP Firestore project id.
 
 ***
 
-### scylladbHosts?
+### scylladbHosts? {#scylladbhosts}
 
-> `optional` **scylladbHosts**: `string`
+> `optional` **scylladbHosts?**: `string`
 
 ScyllaDB hosts as comma separated string.
 
 ***
 
-### scylladbKeyspace?
+### scylladbKeyspace? {#scylladbkeyspace}
 
-> `optional` **scylladbKeyspace**: `string`
+> `optional` **scylladbKeyspace?**: `string`
 
 ScyllaDB keyspace.
 
 ***
 
-### scylladbLocalDataCenter?
+### scylladbLocalDataCenter? {#scylladblocaldatacenter}
 
-> `optional` **scylladbLocalDataCenter**: `string`
+> `optional` **scylladbLocalDataCenter?**: `string`
 
 ScyllaDB local data center.
 
 ***
 
-### scylladbPort?
+### scylladbPort? {#scylladbport}
 
-> `optional` **scylladbPort**: `string`
+> `optional` **scylladbPort?**: `string`
 
 ScyllaDB port.
 
 ***
 
-### mySqlHost?
+### mySqlHost? {#mysqlhost}
 
-> `optional` **mySqlHost**: `string`
+> `optional` **mySqlHost?**: `string`
 
 MySQL host.
 
 ***
 
-### mySqlPort?
+### mySqlPort? {#mysqlport}
 
-> `optional` **mySqlPort**: `number`
+> `optional` **mySqlPort?**: `number`
 
 MySQL port.
 
 ***
 
-### mySqlUser?
+### mySqlUser? {#mysqluser}
 
-> `optional` **mySqlUser**: `string`
+> `optional` **mySqlUser?**: `string`
 
 MySQL username.
 
 ***
 
-### mySqlPassword?
+### mySqlPassword? {#mysqlpassword}
 
-> `optional` **mySqlPassword**: `string`
+> `optional` **mySqlPassword?**: `string`
 
 MySQL password.
 
 ***
 
-### mySqlDatabase?
+### mySqlDatabase? {#mysqldatabase}
 
-> `optional` **mySqlDatabase**: `string`
+> `optional` **mySqlDatabase?**: `string`
 
 MySQL Database.
 
 ***
 
-### mongoDbHost?
+### mongoDbHost? {#mongodbhost}
 
-> `optional` **mongoDbHost**: `string`
+> `optional` **mongoDbHost?**: `string`
 
 MongoDB host.
 
 ***
 
-### mongoDbPort?
+### mongoDbPort? {#mongodbport}
 
-> `optional` **mongoDbPort**: `number`
+> `optional` **mongoDbPort?**: `number`
 
 MongoDB port.
 
 ***
 
-### mongoDbUser?
+### mongoDbUser? {#mongodbuser}
 
-> `optional` **mongoDbUser**: `string`
+> `optional` **mongoDbUser?**: `string`
 
 MongoDB username.
 
 ***
 
-### mongoDbPassword?
+### mongoDbPassword? {#mongodbpassword}
 
-> `optional` **mongoDbPassword**: `string`
+> `optional` **mongoDbPassword?**: `string`
 
 MongoDB password.
 
 ***
 
-### mongoDbDatabase?
+### mongoDbDatabase? {#mongodbdatabase}
 
-> `optional` **mongoDbDatabase**: `string`
+> `optional` **mongoDbDatabase?**: `string`
 
 MongoDB Database.
 
 ***
 
-### postgreSqlHost?
+### postgreSqlHost? {#postgresqlhost}
 
-> `optional` **postgreSqlHost**: `string`
+> `optional` **postgreSqlHost?**: `string`
 
 PostgreSQl host.
 
 ***
 
-### postgreSqlPort?
+### postgreSqlPort? {#postgresqlport}
 
-> `optional` **postgreSqlPort**: `number`
+> `optional` **postgreSqlPort?**: `number`
 
 PostgreSQl port.
 
 ***
 
-### postgreSqlUser?
+### postgreSqlUser? {#postgresqluser}
 
-> `optional` **postgreSqlUser**: `string`
+> `optional` **postgreSqlUser?**: `string`
 
 PostgreSQl username.
 
 ***
 
-### postgreSqlPassword?
+### postgreSqlPassword? {#postgresqlpassword}
 
-> `optional` **postgreSqlPassword**: `string`
+> `optional` **postgreSqlPassword?**: `string`
 
 PostgreSQl password.
 
 ***
 
-### postgreSqlDatabase?
+### postgreSqlDatabase? {#postgresqldatabase}
 
-> `optional` **postgreSqlDatabase**: `string`
+> `optional` **postgreSqlDatabase?**: `string`
 
 PostgreSQl Database.
 
 ***
 
-### ipfsBearerToken?
+### ipfsBearerToken? {#ipfsbearertoken}
 
-> `optional` **ipfsBearerToken**: `string`
+> `optional` **ipfsBearerToken?**: `string`
 
 The security token for accessing IPFS API.
 
 ***
 
-### ipfsApiUrl?
+### ipfsApiUrl? {#ipfsapiurl}
 
-> `optional` **ipfsApiUrl**: `string`
+> `optional` **ipfsApiUrl?**: `string`
 
 The url for accessing IPFS API.
 
 ***
 
-### blobStorageConnectorType?
+### blobStorageConnectorType? {#blobstorageconnectortype}
 
-> `optional` **blobStorageConnectorType**: `string`
+> `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?
+### blobStorageConnectorDefault? {#blobstorageconnectordefault}
 
-> `optional` **blobStorageConnectorDefault**: `string`
+> `optional` **blobStorageConnectorDefault?**: `string`
 
 The default blob storage connector to use, defaults to the first one in the list.
 
 ***
 
-### blobStorageConnectorPublic?
-
-> `optional` **blobStorageConnectorPublic**: `string`
-
-Blog storage connector which has public access.
-
-***
-
-### blobStorageEnableEncryption?
+### blobStorageEnableEncryption? {#blobstorageenableencryption}
 
-> `optional` **blobStorageEnableEncryption**: `string`
+> `optional` **blobStorageEnableEncryption?**: `string`
 
 Enable encryption for the blob storage.
 
 ***
 
-### blobStorageEncryptionKeyId?
+### blobStorageEncryptionKeyId? {#blobstorageencryptionkeyid}
 
-> `optional` **blobStorageEncryptionKeyId**: `string`
+> `optional` **blobStorageEncryptionKeyId?**: `string`
 
 The id of the encryption key for the blob storage.
 
 ***
 
-### blobStorageSymmetricEncryptionKey?
-
-> `optional` **blobStorageSymmetricEncryptionKey**: `string`
-
-A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
-If encryption is enabled but a key is not provided one will be generated.
-
-***
-
-### blobStoragePrefix?
+### blobStoragePrefix? {#blobstorageprefix}
 
-> `optional` **blobStoragePrefix**: `string`
+> `optional` **blobStoragePrefix?**: `string`
 
 A prefix for all the blobs in blob-storage, can be empty.
 
 ***
 
-### awsS3Region?
+### awsS3Region? {#awss3region}
 
-> `optional` **awsS3Region**: `string`
+> `optional` **awsS3Region?**: `string`
 
 AWS S3 region.
 
 ***
 
-### awsS3BucketName?
+### awsS3BucketName? {#awss3bucketname}
 
-> `optional` **awsS3BucketName**: `string`
+> `optional` **awsS3BucketName?**: `string`
 
 AWS S3 bucket name.
 
 ***
 
-### awsS3AuthMode?
+### awsS3AuthMode? {#awss3authmode}
 
-> `optional` **awsS3AuthMode**: `string`
+> `optional` **awsS3AuthMode?**: `string`
 
 AWS S3 auth mode, either credentials or pod, defaults to credentials.
 
 ***
 
-### awsS3AccessKeyId?
+### awsS3AccessKeyId? {#awss3accesskeyid}
 
-> `optional` **awsS3AccessKeyId**: `string`
+> `optional` **awsS3AccessKeyId?**: `string`
 
 AWS S3 access key id.
 
 ***
 
-### awsS3SecretAccessKey?
+### awsS3SecretAccessKey? {#awss3secretaccesskey}
 
-> `optional` **awsS3SecretAccessKey**: `string`
+> `optional` **awsS3SecretAccessKey?**: `string`
 
 AWS S3 secret access key.
 
 ***
 
-### awsS3Endpoint?
+### awsS3Endpoint? {#awss3endpoint}
 
-> `optional` **awsS3Endpoint**: `string`
+> `optional` **awsS3Endpoint?**: `string`
 
 AWS S3 endpoint.
 
 ***
 
-### azureStorageAccountKey?
+### azureStorageAccountKey? {#azurestorageaccountkey}
 
-> `optional` **azureStorageAccountKey**: `string`
+> `optional` **azureStorageAccountKey?**: `string`
 
 Azure Storage account key.
 
 ***
 
-### azureStorageAccountName?
+### azureStorageAccountName? {#azurestorageaccountname}
 
-> `optional` **azureStorageAccountName**: `string`
+> `optional` **azureStorageAccountName?**: `string`
 
 Azure Storage account name.
 
 ***
 
-### azureStorageContainerName?
+### azureStorageContainerName? {#azurestoragecontainername}
 
-> `optional` **azureStorageContainerName**: `string`
+> `optional` **azureStorageContainerName?**: `string`
 
 Azure Storage container.
 
 ***
 
-### azureStorageEndpoint?
+### azureStorageEndpoint? {#azurestorageendpoint}
 
-> `optional` **azureStorageEndpoint**: `string`
+> `optional` **azureStorageEndpoint?**: `string`
 
 Azure Storage endpoint.
 
 ***
 
-### gcpStorageBucketName?
+### gcpStorageBucketName? {#gcpstoragebucketname}
 
-> `optional` **gcpStorageBucketName**: `string`
+> `optional` **gcpStorageBucketName?**: `string`
 
 GCP Storage bucket.
 
 ***
 
-### gcpStorageCredentials?
+### gcpStorageCredentials? {#gcpstoragecredentials}
 
-> `optional` **gcpStorageCredentials**: `string`
+> `optional` **gcpStorageCredentials?**: `string`
 
 GCP Storage credentials.
 
 ***
 
-### gcpStorageEndpoint?
+### gcpStorageEndpoint? {#gcpstorageendpoint}
 
-> `optional` **gcpStorageEndpoint**: `string`
+> `optional` **gcpStorageEndpoint?**: `string`
 
 GCP Storage endpoint.
 
 ***
 
-### gcpStorageProjectId?
+### gcpStorageProjectId? {#gcpstorageprojectid}
 
-> `optional` **gcpStorageProjectId**: `string`
+> `optional` **gcpStorageProjectId?**: `string`
 
 GCP Storage project id.
 
 ***
 
-### vaultConnector?
+### vaultConnector? {#vaultconnector}
 
-> `optional` **vaultConnector**: `string`
+> `optional` **vaultConnector?**: `string`
 
 The type of the default vault connector: entity-storage, hashicorp.
 
 ***
 
-### hashicorpVaultToken?
+### vaultPrefix? {#vaultprefix}
+
+> `optional` **vaultPrefix?**: `string`
+
+Prefix to prepend to entries in the vault.
+
+***
+
+### hashicorpVaultToken? {#hashicorpvaulttoken}
 
-> `optional` **hashicorpVaultToken**: `string`
+> `optional` **hashicorpVaultToken?**: `string`
 
 Hashicorp Vault token.
 
 ***
 
-### hashicorpVaultEndpoint?
+### hashicorpVaultEndpoint? {#hashicorpvaultendpoint}
 
-> `optional` **hashicorpVaultEndpoint**: `string`
+> `optional` **hashicorpVaultEndpoint?**: `string`
 
 Hashicorp Vault endpoint.
 
 ***
 
-### loggingConnector?
+### loggingConnector? {#loggingconnector}
 
-> `optional` **loggingConnector**: `string`
+> `optional` **loggingConnector?**: `string`
 
 The type of logging task connector, can be a comma separated list: console, entity-storage.
 
 ***
 
-### eventBusConnector?
+### loggingBatchSize? {#loggingbatchsize}
+
+> `optional` **loggingBatchSize?**: `string`
+
+The batch size for the logging task, set to 1 for no batching.
+
+***
+
+### loggingBatchFlushIntervalSeconds? {#loggingbatchflushintervalseconds}
+
+> `optional` **loggingBatchFlushIntervalSeconds?**: `string`
+
+The batch flush interval in seconds for the logging task, how often to flush the logs when using batching, defaults to 5 seconds.
+
+***
+
+### loggingSilentComponents? {#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".
+
+***
+
+### eventBusConnector? {#eventbusconnector}
 
-> `optional` **eventBusConnector**: `string`
+> `optional` **eventBusConnector?**: `string`
 
 The type of event bus connector: local.
 
 ***
 
-### eventBusComponent?
+### eventBusComponent? {#eventbuscomponent}
 
-> `optional` **eventBusComponent**: `string`
+> `optional` **eventBusComponent?**: `string`
 
 The type of event bus component: service.
 
 ***
 
-### messagingEnabled?
+### messagingEnabled? {#messagingenabled}
 
-> `optional` **messagingEnabled**: `string`
+> `optional` **messagingEnabled?**: `string`
 
 Are the messaging components enabled, defaults to false.
 
 ***
 
-### awsSesRegion?
+### awsSesRegion? {#awssesregion}
 
-> `optional` **awsSesRegion**: `string`
+> `optional` **awsSesRegion?**: `string`
 
 AWS SES region.
 
 ***
 
-### awsSesAuthMode?
+### awsSesAuthMode? {#awssesauthmode}
 
-> `optional` **awsSesAuthMode**: `string`
+> `optional` **awsSesAuthMode?**: `string`
 
 AWS SES auth mode, either credentials or pod, defaults to credentials.
 
 ***
 
-### awsSesSecretAccessKey?
+### awsSesSecretAccessKey? {#awssessecretaccesskey}
 
-> `optional` **awsSesSecretAccessKey**: `string`
+> `optional` **awsSesSecretAccessKey?**: `string`
 
 AWS SES secret access key.
 
 ***
 
-### awsSesAccessKeyId?
+### awsSesAccessKeyId? {#awssesaccesskeyid}
 
-> `optional` **awsSesAccessKeyId**: `string`
+> `optional` **awsSesAccessKeyId?**: `string`
 
 AWS SES access key id.
 
 ***
 
-### awsSesEndpoint?
+### awsSesEndpoint? {#awssesendpoint}
 
-> `optional` **awsSesEndpoint**: `string`
+> `optional` **awsSesEndpoint?**: `string`
 
 AWS SES endpoint.
 
 ***
 
-### awsMessagingPushNotificationApplications?
+### awsMessagingPushNotificationApplications? {#awsmessagingpushnotificationapplications}
 
-> `optional` **awsMessagingPushNotificationApplications**: `string`
+> `optional` **awsMessagingPushNotificationApplications?**: `string`
 
-The applications for the push notifications JSON stringified array of IAwsApplicationSettings.
+The applications for the push notifications reference a separate json with @json: prefix.
 
 ***
 
-### messagingEmailConnector?
+### messagingEmailConnector? {#messagingemailconnector}
 
-> `optional` **messagingEmailConnector**: `string`
+> `optional` **messagingEmailConnector?**: `string`
 
 The type of messaging email connector: entity-storage, aws.
 
 ***
 
-### messagingSmsConnector?
+### messagingSmsConnector? {#messagingsmsconnector}
 
-> `optional` **messagingSmsConnector**: `string`
+> `optional` **messagingSmsConnector?**: `string`
 
 The type of messaging sms connector: entity-storage, aws.
 
 ***
 
-### messagingPushNotificationConnector?
+### messagingPushNotificationConnector? {#messagingpushnotificationconnector}
 
-> `optional` **messagingPushNotificationConnector**: `string`
+> `optional` **messagingPushNotificationConnector?**: `string`
 
 The type of messaging push notification connector: entity-storage, aws.
 
 ***
 
-### telemetryConnector?
+### telemetryConnector? {#telemetryconnector}
 
-> `optional` **telemetryConnector**: `string`
+> `optional` **telemetryConnector?**: `string`
 
 The type of telemetry connector: entity-storage.
 
 ***
 
-### faucetConnector?
+### openTelemetryMeterName? {#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? {#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? {#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? {#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.
+
+***
+
+### telemetryMetricsCollectorIntervalSeconds? {#telemetrymetricscollectorintervalseconds}
+
+> `optional` **telemetryMetricsCollectorIntervalSeconds?**: `string`
+
+Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
+
+***
+
+### telemetryMetricsProducers? {#telemetrymetricsproducers}
+
+> `optional` **telemetryMetricsProducers?**: `string`
+
+The type of telemetry metrics producers, can be a comma separated list: system, process.
+
+***
+
+### telemetryMetricsProducerMaxHistory? {#telemetrymetricsproducermaxhistory}
+
+> `optional` **telemetryMetricsProducerMaxHistory?**: `string`
+
+Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
+
+***
+
+### faucetConnector? {#faucetconnector}
 
-> `optional` **faucetConnector**: `string`
+> `optional` **faucetConnector?**: `string`
 
 The type of faucet connector: entity-storage, iota.
 
 ***
 
-### walletConnector?
+### walletConnector? {#walletconnector}
 
-> `optional` **walletConnector**: `string`
+> `optional` **walletConnector?**: `string`
 
 The type of wallet connector: entity-storage, iota.
 
 ***
 
-### nftConnector?
+### nftConnector? {#nftconnector}
 
-> `optional` **nftConnector**: `string`
+> `optional` **nftConnector?**: `string`
 
 The type of NFT connector: entity-storage, iota.
 
 ***
 
-### identityConnector?
+### nftPackageId? {#nftpackageid}
+
+> `optional` **nftPackageId?**: `string`
+
+The NFT deployed package id, for custom deployments.
+
+***
+
+### notarizationConnector? {#notarizationconnector}
+
+> `optional` **notarizationConnector?**: `string`
+
+The type of notarization connector: entity-storage, iota.
+
+***
+
+### identityConnector? {#identityconnector}
 
-> `optional` **identityConnector**: `string`
+> `optional` **identityConnector?**: `string`
 
 The type of identity connector: entity-storage, iota.
 
 ***
 
-### identityResolverConnector?
+### identityWalletAddressIndex? {#identitywalletaddressindex}
 
-> `optional` **identityResolverConnector**: `string`
+> `optional` **identityWalletAddressIndex?**: `string`
 
-The type of identity resolver connector: entity-storage, iota.
+The index of the wallet address to use, defaults to 0.
 
 ***
 
-### verifiableStorageConnector?
+### identityResolverConnector? {#identityresolverconnector}
 
-> `optional` **verifiableStorageConnector**: `string`
+> `optional` **identityResolverConnector?**: `string`
 
-The type of verifiable storage connector: entity-storage, iota.
+The type of identity resolver connector: entity-storage, iota.
 
 ***
 
-### iotaFaucetEndpoint?
+### iotaFaucetEndpoint? {#iotafaucetendpoint}
 
-> `optional` **iotaFaucetEndpoint**: `string`
+> `optional` **iotaFaucetEndpoint?**: `string`
 
 IOTA Faucet Endpoint.
 
 ***
 
-### iotaNodeEndpoint?
+### iotaNodeEndpoint? {#iotanodeendpoint}
 
-> `optional` **iotaNodeEndpoint**: `string`
+> `optional` **iotaNodeEndpoint?**: `string`
 
 IOTA Node Endpoint.
 
 ***
 
-### iotaNetwork?
+### iotaNetwork? {#iotanetwork}
 
-> `optional` **iotaNetwork**: `string`
+> `optional` **iotaNetwork?**: `string`
 
 IOTA network.
 
 ***
 
-### iotaCoinType?
+### iotaCoinType? {#iotacointype}
 
-> `optional` **iotaCoinType**: `string`
+> `optional` **iotaCoinType?**: `string`
 
 IOTA coin type.
 
 ***
 
-### iotaExplorerEndpoint?
+### iotaExplorerEndpoint? {#iotaexplorerendpoint}
 
-> `optional` **iotaExplorerEndpoint**: `string`
+> `optional` **iotaExplorerEndpoint?**: `string`
 
 IOTA Explorer Endpoint.
 
 ***
 
-### iotaGasStationEndpoint?
+### iotaGasStationEndpoint? {#iotagasstationendpoint}
 
-> `optional` **iotaGasStationEndpoint**: `string`
+> `optional` **iotaGasStationEndpoint?**: `string`
 
 IOTA Gas Station Endpoint.
 
 ***
 
-### iotaGasStationAuthToken?
+### iotaGasStationAuthToken? {#iotagasstationauthtoken}
 
-> `optional` **iotaGasStationAuthToken**: `string`
+> `optional` **iotaGasStationAuthToken?**: `string`
 
 IOTA Gas Station Authentication Token.
 
 ***
 
-### universalResolverEndpoint?
+### iotaIdentityPackageId? {#iotaidentitypackageid}
+
+> `optional` **iotaIdentityPackageId?**: `string`
+
+The IOTA Identity deployed package id, for custom deployments.
+
+***
+
+### universalResolverEndpoint? {#universalresolverendpoint}
 
-> `optional` **universalResolverEndpoint**: `string`
+> `optional` **universalResolverEndpoint?**: `string`
 
 Universal Resolver Endpoint.
 
 ***
 
-### identityProfileConnector?
+### identityProfileConnector? {#identityprofileconnector}
 
-> `optional` **identityProfileConnector**: `string`
+> `optional` **identityProfileConnector?**: `string`
 
 The type of identity profile connector: entity-storage.
 
 ***
 
-### immutableProofVerificationMethodId?
+### immutableProofVerificationMethodId? {#immutableproofverificationmethodid}
 
-> `optional` **immutableProofVerificationMethodId**: `string`
+> `optional` **immutableProofVerificationMethodId?**: `string`
 
 The identity verification method id to use with immutable proofs.
 
 ***
 
-### attestationConnector?
+### attestationConnector? {#attestationconnector}
 
-> `optional` **attestationConnector**: `string`
+> `optional` **attestationConnector?**: `string`
 
 The type of attestation connector: entity-storage, iota.
 
 ***
 
-### attestationVerificationMethodId?
+### attestationVerificationMethodId? {#attestationverificationmethodid}
 
-> `optional` **attestationVerificationMethodId**: `string`
+> `optional` **attestationVerificationMethodId?**: `string`
 
 The identity verification method id to use with attestation.
 
 ***
 
-### dataProcessingEnabled?
+### dataProcessingEnabled? {#dataprocessingenabled}
 
-> `optional` **dataProcessingEnabled**: `string`
+> `optional` **dataProcessingEnabled?**: `string`
 
 Is the data processing enabled, defaults to false.
 
 ***
 
-### dataConverterConnectors?
+### dataConverterConnectors? {#dataconverterconnectors}
 
-> `optional` **dataConverterConnectors**: `string`
+> `optional` **dataConverterConnectors?**: `string`
 
 The type of the default data converters, can be a comma separated list: json, xml.
 
 ***
 
-### dataExtractorConnectors?
+### dataExtractorConnectors? {#dataextractorconnectors}
 
-> `optional` **dataExtractorConnectors**: `string`
+> `optional` **dataExtractorConnectors?**: `string`
 
 The type of the default data extractor, can be a comma separated list: json-path.
 
 ***
 
-### auditableItemGraphEnabled?
+### taskSchedulerEnabled? {#taskschedulerenabled}
+
+> `optional` **taskSchedulerEnabled?**: `string`
+
+Enable the task scheduler regardless of which other components are active, defaults to false.
+
+***
+
+### auditableItemGraphEnabled? {#auditableitemgraphenabled}
 
-> `optional` **auditableItemGraphEnabled**: `string`
+> `optional` **auditableItemGraphEnabled?**: `string`
 
 Is the auditable item graph enabled, defaults to false.
 
 ***
 
-### auditableItemStreamEnabled?
+### auditableItemStreamEnabled? {#auditableitemstreamenabled}
 
-> `optional` **auditableItemStreamEnabled**: `string`
+> `optional` **auditableItemStreamEnabled?**: `string`
 
 Is the auditable item stream enabled, defaults to false.
 
 ***
 
-### documentManagementEnabled?
+### documentManagementEnabled? {#documentmanagementenabled}
 
-> `optional` **documentManagementEnabled**: `string`
+> `optional` **documentManagementEnabled?**: `string`
 
 Is the document management enabled, defaults to false.
 
 ***
 
-### synchronisedStorageEnabled?
+### federatedCatalogueEnabled? {#federatedcatalogueenabled}
 
-> `optional` **synchronisedStorageEnabled**: `string`
+> `optional` **federatedCatalogueEnabled?**: `string`
 
-Is the synchronised storage enabled, defaults to false.
+Enable the federated catalogue, defaults to false, automatically enabled if remote endpoint, filters or dataspace is enabled.
 
 ***
 
-### synchronisedStorageTrustedUrl?
+### federatedCatalogueFilters? {#federatedcataloguefilters}
 
-> `optional` **synchronisedStorageTrustedUrl**: `string`
+> `optional` **federatedCatalogueFilters?**: `string`
 
-Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
+Federated catalog filters, command separated list of filters to add.
 
 ***
 
-### synchronisedStorageVerifiableStorageKeyId?
+### federatedCatalogueRemoteEndpoint? {#federatedcatalogueremoteendpoint}
 
-> `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
+> `optional` **federatedCatalogueRemoteEndpoint?**: `string`
 
-The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
-This only required if using a custom verifiable storage item, otherwise it will default to the network name.
+Federated catalog remote endpoint, if set will use a REST client instead of local service.
 
 ***
 
-### synchronisedStorageBlobStorageEncryptionKeyId?
+### trustGenerators? {#trustgenerators}
 
-> `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `string`
+> `optional` **trustGenerators?**: `string`
 
-The key from the vault which is used to encrypt the synchronised storage blobs.
-Only required for trusted nodes, as regular nodes will request from the trusted nodes.
-Defaults to synchronised-storage-blob-encryption
+The trust generators to add to the factory, comma separated list.
 
 ***
 
-### synchronisedStorageBlobStorageKey?
+### trustVerifiers? {#trustverifiers}
 
-> `optional` **synchronisedStorageBlobStorageKey**: `string`
+> `optional` **trustVerifiers?**: `string`
 
-The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
-Only required for trusted nodes, as regular nodes will not write encrypted data.
+The trust verifiers to add to the factory, comma separated list.
 
 ***
 
-### synchronisedStorageEntityUpdateIntervalMinutes?
+### trustVerificationMethodId? {#trustverificationmethodid}
 
-> `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
+> `optional` **trustVerificationMethodId?**: `string`
 
-How often to check for entity updates in minutes.
+The verification method to use for trust identities.
+Defaults to trust-assertion.
 
-#### Default
+***
 
-```ts
-5
-```
+### trustJwtTtlSeconds? {#trustjwtttlseconds}
+
+> `optional` **trustJwtTtlSeconds?**: `string`
+
+The trust time to live for generating JWTs.
+Defaults to undefined for never expiring.
 
 ***
 
-### synchronisedStorageConsolidationIntervalMinutes?
+### trustIdentitiesAllow? {#trustidentitiesallow}
 
-> `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
+> `optional` **trustIdentitiesAllow?**: `string`
 
-Interval to perform consolidation of changesets, only used if this is a trusted node.
+The allow lists for the trust identity verifier, comma separated list of identities.
 
-#### Default
+***
 
-```ts
-60
-```
+### trustIdentitiesDeny? {#trustidentitiesdeny}
+
+> `optional` **trustIdentitiesDeny?**: `string`
+
+The deny lists for the trust identity verifier, comma separated list of identities.
 
 ***
 
-### synchronisedStorageConsolidationBatchSize?
+### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
 
-> `optional` **synchronisedStorageConsolidationBatchSize**: `string`
+> `optional` **rightsManagementCallbackPath?**: `string`
 
-The number of entities to process in a single consolidation batch, only used if this is a trusted node.
+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.
 
-#### Default
+***
 
-```ts
-1000
-```
+### rightsManagementPolicyInformationSources? {#rightsmanagementpolicyinformationsources}
+
+> `optional` **rightsManagementPolicyInformationSources?**: `string`
+
+The rights management policy information sources to add to the factory.
 
 ***
 
-### synchronisedStorageMaxConsolidations?
+### rightsManagementPolicyNegotiators? {#rightsmanagementpolicynegotiators}
 
-> `optional` **synchronisedStorageMaxConsolidations**: `string`
+> `optional` **rightsManagementPolicyNegotiators?**: `string`
 
-The maximum number of consolidations to keep in storage, only used if this is a trusted node.
+The rights management policy negotiators sources to add to the factory.
 
-#### Default
+***
 
-```ts
-5
-```
+### rightsManagementPolicyRequesters? {#rightsmanagementpolicyrequesters}
+
+> `optional` **rightsManagementPolicyRequesters?**: `string`
+
+The rights management policy requesters to add to the factory.
 
 ***
 
-### federatedCatalogueEnabled?
+### rightsManagementPolicyExecutionActions? {#rightsmanagementpolicyexecutionactions}
 
-> `optional` **federatedCatalogueEnabled**: `string`
+> `optional` **rightsManagementPolicyExecutionActions?**: `string`
 
-Is the federated catalogue enabled, defaults to false.
+The rights management policy execution actions to add to the factory.
 
 ***
 
-### federatedCatalogueFilters?
+### rightsManagementPolicyEnforcementProcessors? {#rightsmanagementpolicyenforcementprocessors}
 
-> `optional` **federatedCatalogueFilters**: `string`
+> `optional` **rightsManagementPolicyEnforcementProcessors?**: `string`
 
-Federated catalog filters, command separated list of filters to add.
+The rights management policy enforcement processors to add to the factory.
 
 ***
 
-### rightsManagementEnabled?
+### rightsManagementPolicyArbiters? {#rightsmanagementpolicyarbiters}
 
-> `optional` **rightsManagementEnabled**: `string`
+> `optional` **rightsManagementPolicyArbiters?**: `string`
 
-Is the rights management enabled, defaults to false.
+The rights management policy arbiters to add to the factory.
 
 ***
 
-### rightsManagementBaseCallbackUrl?
+### rightsManagementPolicyObligationEnforcers? {#rightsmanagementpolicyobligationenforcers}
 
-> `optional` **rightsManagementBaseCallbackUrl**: `string`
+> `optional` **rightsManagementPolicyObligationEnforcers?**: `string`
 
-What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
+The rights management policy obligation enforcers to add to the factory.
 
 ***
 
-### rightsManagementInformationSources?
+### dataspaceEnabled? {#dataspaceenabled}
 
-> `optional` **rightsManagementInformationSources**: `string`
+> `optional` **dataspaceEnabled?**: `string`
 
-The rights management configuration which includes the information sources modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+Is the dataspace enabled, defaults to false.
 
 ***
 
-### rightsManagementNegotiators?
+### dataspaceRetainActivityLogsFor? {#dataspaceretainactivitylogsfor}
 
-> `optional` **rightsManagementNegotiators**: `string`
+> `optional` **dataspaceRetainActivityLogsFor?**: `string`
 
-The rights management configuration which includes the negotiator modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+
+#### Default
+
+```ts
+10
+```
 
 ***
 
-### rightsManagementRequesters?
+### dataspaceActivityLogsCleanupInterval? {#dataspaceactivitylogscleanupinterval}
+
+> `optional` **dataspaceActivityLogsCleanupInterval?**: `string`
+
+The interval for cleaning up the activity logs.
 
-> `optional` **rightsManagementRequesters**: `string`
+#### Default
 
-The rights management configuration which includes the requester modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+```ts
+60
+```
 
 ***
 
-### rightsManagementExecutionActions?
+### dataspaceDataPlanePath? {#dataspacedataplanepath}
 
-> `optional` **rightsManagementExecutionActions**: `string`
+> `optional` **dataspaceDataPlanePath?**: `string`
 
-The rights management configuration which includes the execution actions modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The data plane path for PULL transfers (path only, not full URL).
+Will be combined with public origin.
+Required if PULL transfers should be supported.
+Example: "dataspace/entities"
 
 ***
 
-### rightsManagementEnforcementProcessors?
+### healthEnabled? {#healthenabled}
 
-> `optional` **rightsManagementEnforcementProcessors**: `string`
+> `optional` **healthEnabled?**: `string`
 
-The rights management configuration which includes the enforcement processor modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+Are the health components enabled, defaults to false.
 
 ***
 
-### rightsManagementArbiters?
+### healthIntervalSeconds? {#healthintervalseconds}
 
-> `optional` **rightsManagementArbiters**: `string`
+> `optional` **healthIntervalSeconds?**: `string`
 
-The rights management configuration which includes the arbiter modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+The interval in seconds for performing health checks, defaults to 60.
 
 ***
 
-### rightsManagementOffers?
+### healthStartupIntervalSeconds? {#healthstartupintervalseconds}
 
-> `optional` **rightsManagementOffers**: `string`
+> `optional` **healthStartupIntervalSeconds?**: `string`
 
-The rights management configuration which includes the offer modules to load.
-Use the @json: prefix to specify the path to the JSON configuration file.
+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.
 
 ***
 
-### backgroundTasksEnabled?
+### automationActionTypes? {#automationactiontypes}
 
-> `optional` **backgroundTasksEnabled**: `string`
+> `optional` **automationActionTypes?**: `string`
 
-Are background tasks enabled, defaults to false.
+The type of the automation action to create, comma separate for more than one connector.
+values: fetch
 
 ***
 
-### taskSchedulerEnabled?
+### mutexTimeoutMsDefault? {#mutextimeoutmsdefault}
 
-> `optional` **taskSchedulerEnabled**: `string`
+> `optional` **mutexTimeoutMsDefault?**: `string`
 
-Is the task scheduler enabled, defaults to false.
+The default mutex timeout in milliseconds, used when no component-specific timeout is set, defaults to 5000.
 
 ***
 
-### dataSpaceConnectorEnabled?
+### auditableItemGraphMutexTimeoutMs? {#auditableitemgraphmutextimeoutms}
 
-> `optional` **dataSpaceConnectorEnabled**: `string`
+> `optional` **auditableItemGraphMutexTimeoutMs?**: `string`
 
-Is the data space connector enabled, defaults to false.
+The mutex timeout in milliseconds for the auditable item graph component.
 
 ***
 
-### dataSpaceConnectorRetainActivityLogsFor?
+### auditableItemStreamMutexTimeoutMs? {#auditableitemstreammutextimeoutms}
 
-> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
+> `optional` **auditableItemStreamMutexTimeoutMs?**: `string`
 
-The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+The mutex timeout in milliseconds for the auditable item stream component.
 
-#### Default
+***
 
-```ts
-10
-```
+### federatedCatalogueMutexTimeoutMs? {#federatedcataloguemutextimeoutms}
+
+> `optional` **federatedCatalogueMutexTimeoutMs?**: `string`
+
+The mutex timeout in milliseconds for the federated catalogue component.
 
 ***
 
-### dataSpaceConnectorActivityLogsCleanUpInterval?
+### documentManagementMutexTimeoutMs? {#documentmanagementmutextimeoutms}
 
-> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
+> `optional` **documentManagementMutexTimeoutMs?**: `string`
 
-The interval for cleaning up the activity logs.
+The mutex timeout in milliseconds for the document management component.
 
-#### Default
+***
 
-```ts
-60
-```
+### loggingMutexTimeoutMs? {#loggingmutextimeoutms}
+
+> `optional` **loggingMutexTimeoutMs?**: `string`
+
+The mutex timeout in milliseconds for the logging component.
+
+***
+
+### entityStorageMemoryMutexTimeoutMs? {#entitystoragememorymutextimeoutms}
+
+> `optional` **entityStorageMemoryMutexTimeoutMs?**: `string`
+
+The mutex timeout in milliseconds for the memory entity storage connector.
 
 ***
 
-### vcAuthenticationEnabled?
+### entityStorageFileMutexTimeoutMs? {#entitystoragefilemutextimeoutms}
 
-> `optional` **vcAuthenticationEnabled**: `string`
+> `optional` **entityStorageFileMutexTimeoutMs?**: `string`
 
-Enable verifiable credential authentication for the API.
+The mutex timeout in milliseconds for the file entity storage connector.
 
 ***
 
-### vcAuthenticationVerificationMethodId?
+### rightsManagementMutexTimeoutMs? {#rightsmanagementmutextimeoutms}
 
-> `optional` **vcAuthenticationVerificationMethodId**: `string`
+> `optional` **rightsManagementMutexTimeoutMs?**: `string`
 
-Verifiable credential assertion for node to node communication.
-Defaults to node-authentication-assertion.
+The mutex timeout in milliseconds for the rights management component.
 
 ***
 
-### extensions?
+### extensions? {#extensions}
 
-> `optional` **extensions**: `string`
+> `optional` **extensions?**: `string`
 
 A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.