@twin.org/node-core 0.0.2-next.8 → 0.0.3-next.1

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -2,11 +2,1686 @@
 
 The engine server environment variables.
 
+## Extends
+
+- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md)
+
 ## Extended by
 
-- [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+- [`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
+
+## Properties
+
+### debug?
+
+> `optional` **debug**: `string`
+
+Start the engine in debug mode.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`debug`](IEngineEnvironmentVariables.md#debug)
+
+***
+
+### storageFileRoot?
+
+> `optional` **storageFileRoot**: `string`
+
+The root directory for storing items like state file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
+
+***
+
+### stateFilename?
+
+> `optional` **stateFilename**: `string`
+
+The name of the state file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
+
+***
+
+### tenantEnabled?
+
+> `optional` **tenantEnabled**: `string`
+
+Is multi-tenant support enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantEnabled`](IEngineEnvironmentVariables.md#tenantenabled)
+
+***
+
+### tenantId?
+
+> `optional` **tenantId**: `string`
+
+A tenant id to use as a default for the node.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantId`](IEngineEnvironmentVariables.md#tenantid)
+
+***
+
+### tenantApiKey?
+
+> `optional` **tenantApiKey**: `string`
+
+A tenant api key to use as a default for the node.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantApiKey`](IEngineEnvironmentVariables.md#tenantapikey)
+
+***
+
+### 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
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorType`](IEngineEnvironmentVariables.md#entitystorageconnectortype)
+
+***
+
+### entityStorageConnectorDefault?
+
+> `optional` **entityStorageConnectorDefault**: `string`
+
+The default entity storage connector to use, defaults to the first one in the list.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineEnvironmentVariables.md#entitystorageconnectordefault)
+
+***
+
+### entityStorageTablePrefix?
+
+> `optional` **entityStorageTablePrefix**: `string`
+
+A prefix for all the table in entity-storage, can be empty.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineEnvironmentVariables.md#entitystoragetableprefix)
+
+***
+
+### awsDynamodbAuthMode?
+
+> `optional` **awsDynamodbAuthMode**: `string`
+
+AWS DynamoDB auth mode, either credentials or pod.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineEnvironmentVariables.md#awsdynamodbauthmode)
+
+***
+
+### awsDynamodbAccessKeyId?
+
+> `optional` **awsDynamodbAccessKeyId**: `string`
+
+AWS Dynamo DB access key id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAccessKeyId`](IEngineEnvironmentVariables.md#awsdynamodbaccesskeyid)
+
+***
+
+### awsDynamodbEndpoint?
+
+> `optional` **awsDynamodbEndpoint**: `string`
+
+AWS Dynamo DB Endpoint if running local instance.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbEndpoint`](IEngineEnvironmentVariables.md#awsdynamodbendpoint)
+
+***
+
+### awsDynamodbRegion?
+
+> `optional` **awsDynamodbRegion**: `string`
+
+AWS Dynamo DB region.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineEnvironmentVariables.md#awsdynamodbregion)
+
+***
+
+### awsDynamodbSecretAccessKey?
+
+> `optional` **awsDynamodbSecretAccessKey**: `string`
+
+AWS Dynamo DB secret access key.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineEnvironmentVariables.md#awsdynamodbsecretaccesskey)
+
+***
+
+### azureCosmosdbKey?
+
+> `optional` **azureCosmosdbKey**: `string`
+
+Azure Cosmos DB key.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineEnvironmentVariables.md#azurecosmosdbkey)
+
+***
+
+### azureCosmosdbContainerId?
+
+> `optional` **azureCosmosdbContainerId**: `string`
+
+Azure Cosmos DB container id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineEnvironmentVariables.md#azurecosmosdbcontainerid)
+
+***
+
+### azureCosmosdbDatabaseId?
+
+> `optional` **azureCosmosdbDatabaseId**: `string`
+
+Azure Cosmos DB database id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineEnvironmentVariables.md#azurecosmosdbdatabaseid)
+
+***
+
+### azureCosmosdbEndpoint?
+
+> `optional` **azureCosmosdbEndpoint**: `string`
+
+Azure Cosmos DB endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineEnvironmentVariables.md#azurecosmosdbendpoint)
+
+***
+
+### gcpFirestoreCollectionName?
+
+> `optional` **gcpFirestoreCollectionName**: `string`
+
+GCP Firestore collection name.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineEnvironmentVariables.md#gcpfirestorecollectionname)
+
+***
+
+### gcpFirestoreCredentials?
+
+> `optional` **gcpFirestoreCredentials**: `string`
+
+GCP Firestore credentials.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineEnvironmentVariables.md#gcpfirestorecredentials)
+
+***
+
+### gcpFirestoreDatabaseId?
+
+> `optional` **gcpFirestoreDatabaseId**: `string`
+
+GCP Firestore database id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineEnvironmentVariables.md#gcpfirestoredatabaseid)
+
+***
+
+### gcpFirestoreApiEndpoint?
+
+> `optional` **gcpFirestoreApiEndpoint**: `string`
+
+GCP Firestore endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineEnvironmentVariables.md#gcpfirestoreapiendpoint)
+
+***
+
+### gcpFirestoreProjectId?
+
+> `optional` **gcpFirestoreProjectId**: `string`
+
+GCP Firestore project id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineEnvironmentVariables.md#gcpfirestoreprojectid)
+
+***
+
+### scylladbHosts?
+
+> `optional` **scylladbHosts**: `string`
+
+ScyllaDB hosts as comma separated string.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbHosts`](IEngineEnvironmentVariables.md#scylladbhosts)
+
+***
+
+### scylladbKeyspace?
+
+> `optional` **scylladbKeyspace**: `string`
+
+ScyllaDB keyspace.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbKeyspace`](IEngineEnvironmentVariables.md#scylladbkeyspace)
+
+***
+
+### scylladbLocalDataCenter?
+
+> `optional` **scylladbLocalDataCenter**: `string`
+
+ScyllaDB local data center.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineEnvironmentVariables.md#scylladblocaldatacenter)
+
+***
+
+### scylladbPort?
+
+> `optional` **scylladbPort**: `string`
+
+ScyllaDB port.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbPort`](IEngineEnvironmentVariables.md#scylladbport)
+
+***
+
+### mySqlHost?
+
+> `optional` **mySqlHost**: `string`
+
+MySQL host.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlHost`](IEngineEnvironmentVariables.md#mysqlhost)
+
+***
+
+### mySqlPort?
+
+> `optional` **mySqlPort**: `number`
+
+MySQL port.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPort`](IEngineEnvironmentVariables.md#mysqlport)
+
+***
+
+### mySqlUser?
+
+> `optional` **mySqlUser**: `string`
+
+MySQL username.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlUser`](IEngineEnvironmentVariables.md#mysqluser)
+
+***
+
+### mySqlPassword?
+
+> `optional` **mySqlPassword**: `string`
+
+MySQL password.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPassword`](IEngineEnvironmentVariables.md#mysqlpassword)
+
+***
+
+### mySqlDatabase?
+
+> `optional` **mySqlDatabase**: `string`
+
+MySQL Database.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlDatabase`](IEngineEnvironmentVariables.md#mysqldatabase)
+
+***
+
+### mongoDbHost?
+
+> `optional` **mongoDbHost**: `string`
+
+MongoDB host.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbHost`](IEngineEnvironmentVariables.md#mongodbhost)
+
+***
+
+### mongoDbPort?
+
+> `optional` **mongoDbPort**: `number`
+
+MongoDB port.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPort`](IEngineEnvironmentVariables.md#mongodbport)
+
+***
+
+### mongoDbUser?
+
+> `optional` **mongoDbUser**: `string`
+
+MongoDB username.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbUser`](IEngineEnvironmentVariables.md#mongodbuser)
+
+***
+
+### mongoDbPassword?
+
+> `optional` **mongoDbPassword**: `string`
+
+MongoDB password.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPassword`](IEngineEnvironmentVariables.md#mongodbpassword)
+
+***
+
+### mongoDbDatabase?
+
+> `optional` **mongoDbDatabase**: `string`
+
+MongoDB Database.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbDatabase`](IEngineEnvironmentVariables.md#mongodbdatabase)
+
+***
+
+### postgreSqlHost?
+
+> `optional` **postgreSqlHost**: `string`
+
+PostgreSQl host.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlHost`](IEngineEnvironmentVariables.md#postgresqlhost)
+
+***
+
+### postgreSqlPort?
+
+> `optional` **postgreSqlPort**: `number`
+
+PostgreSQl port.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPort`](IEngineEnvironmentVariables.md#postgresqlport)
+
+***
+
+### postgreSqlUser?
+
+> `optional` **postgreSqlUser**: `string`
+
+PostgreSQl username.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlUser`](IEngineEnvironmentVariables.md#postgresqluser)
+
+***
+
+### postgreSqlPassword?
+
+> `optional` **postgreSqlPassword**: `string`
+
+PostgreSQl password.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPassword`](IEngineEnvironmentVariables.md#postgresqlpassword)
+
+***
+
+### postgreSqlDatabase?
+
+> `optional` **postgreSqlDatabase**: `string`
+
+PostgreSQl Database.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineEnvironmentVariables.md#postgresqldatabase)
+
+***
+
+### ipfsBearerToken?
+
+> `optional` **ipfsBearerToken**: `string`
+
+The security token for accessing IPFS API.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsBearerToken`](IEngineEnvironmentVariables.md#ipfsbearertoken)
+
+***
+
+### ipfsApiUrl?
+
+> `optional` **ipfsApiUrl**: `string`
+
+The url for accessing IPFS API.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsApiUrl`](IEngineEnvironmentVariables.md#ipfsapiurl)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineEnvironmentVariables.md#blobstorageconnectortype)
+
+***
+
+### blobStorageConnectorDefault?
+
+> `optional` **blobStorageConnectorDefault**: `string`
+
+The default blob storage connector to use, defaults to the first one in the list.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineEnvironmentVariables.md#blobstorageconnectordefault)
+
+***
+
+### blobStorageConnectorPublic?
+
+> `optional` **blobStorageConnectorPublic**: `string`
+
+Blog storage connector which has public access.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineEnvironmentVariables.md#blobstorageconnectorpublic)
+
+***
+
+### blobStorageEnableEncryption?
+
+> `optional` **blobStorageEnableEncryption**: `string`
+
+Enable encryption for the blob storage.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineEnvironmentVariables.md#blobstorageenableencryption)
+
+***
+
+### blobStorageEncryptionKeyId?
+
+> `optional` **blobStorageEncryptionKeyId**: `string`
+
+The id of the encryption key for the blob storage.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#blobstorageencryptionkeyid)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
+
+***
+
+### blobStoragePrefix?
+
+> `optional` **blobStoragePrefix**: `string`
+
+A prefix for all the blobs in blob-storage, can be empty.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStoragePrefix`](IEngineEnvironmentVariables.md#blobstorageprefix)
+
+***
+
+### awsS3Region?
+
+> `optional` **awsS3Region**: `string`
+
+AWS S3 region.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
+
+***
+
+### awsS3BucketName?
+
+> `optional` **awsS3BucketName**: `string`
+
+AWS S3 bucket name.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3BucketName`](IEngineEnvironmentVariables.md#awss3bucketname)
+
+***
+
+### awsS3AuthMode?
+
+> `optional` **awsS3AuthMode**: `string`
+
+AWS S3 auth mode, either credentials or pod, defaults to credentials.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AuthMode`](IEngineEnvironmentVariables.md#awss3authmode)
+
+***
+
+### awsS3AccessKeyId?
+
+> `optional` **awsS3AccessKeyId**: `string`
+
+AWS S3 access key id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
+
+***
+
+### awsS3SecretAccessKey?
+
+> `optional` **awsS3SecretAccessKey**: `string`
+
+AWS S3 secret access key.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineEnvironmentVariables.md#awss3secretaccesskey)
+
+***
+
+### awsS3Endpoint?
+
+> `optional` **awsS3Endpoint**: `string`
+
+AWS S3 endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
+
+***
+
+### azureStorageAccountKey?
+
+> `optional` **azureStorageAccountKey**: `string`
+
+Azure Storage account key.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineEnvironmentVariables.md#azurestorageaccountkey)
+
+***
+
+### azureStorageAccountName?
+
+> `optional` **azureStorageAccountName**: `string`
+
+Azure Storage account name.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountName`](IEngineEnvironmentVariables.md#azurestorageaccountname)
+
+***
+
+### azureStorageContainerName?
+
+> `optional` **azureStorageContainerName**: `string`
+
+Azure Storage container.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageContainerName`](IEngineEnvironmentVariables.md#azurestoragecontainername)
+
+***
+
+### azureStorageEndpoint?
+
+> `optional` **azureStorageEndpoint**: `string`
+
+Azure Storage endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineEnvironmentVariables.md#azurestorageendpoint)
+
+***
+
+### gcpStorageBucketName?
+
+> `optional` **gcpStorageBucketName**: `string`
+
+GCP Storage bucket.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineEnvironmentVariables.md#gcpstoragebucketname)
+
+***
+
+### gcpStorageCredentials?
+
+> `optional` **gcpStorageCredentials**: `string`
+
+GCP Storage credentials.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineEnvironmentVariables.md#gcpstoragecredentials)
+
+***
+
+### gcpStorageEndpoint?
+
+> `optional` **gcpStorageEndpoint**: `string`
+
+GCP Storage endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineEnvironmentVariables.md#gcpstorageendpoint)
+
+***
+
+### gcpStorageProjectId?
+
+> `optional` **gcpStorageProjectId**: `string`
+
+GCP Storage project id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineEnvironmentVariables.md#gcpstorageprojectid)
+
+***
+
+### vaultConnector?
+
+> `optional` **vaultConnector**: `string`
+
+The type of the default vault connector: entity-storage, hashicorp.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultConnector`](IEngineEnvironmentVariables.md#vaultconnector)
+
+***
+
+### hashicorpVaultToken?
+
+> `optional` **hashicorpVaultToken**: `string`
+
+Hashicorp Vault token.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineEnvironmentVariables.md#hashicorpvaulttoken)
+
+***
+
+### hashicorpVaultEndpoint?
+
+> `optional` **hashicorpVaultEndpoint**: `string`
+
+Hashicorp Vault endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineEnvironmentVariables.md#hashicorpvaultendpoint)
+
+***
+
+### loggingConnector?
+
+> `optional` **loggingConnector**: `string`
+
+The type of logging task connector, can be a comma separated list: console, entity-storage.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingConnector`](IEngineEnvironmentVariables.md#loggingconnector)
+
+***
+
+### backgroundTaskConnector?
+
+> `optional` **backgroundTaskConnector**: `string`
+
+The type of background task connector: entity-storage.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineEnvironmentVariables.md#backgroundtaskconnector)
+
+***
+
+### eventBusConnector?
+
+> `optional` **eventBusConnector**: `string`
+
+The type of event bus connector: local.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusConnector`](IEngineEnvironmentVariables.md#eventbusconnector)
+
+***
+
+### eventBusComponent?
+
+> `optional` **eventBusComponent**: `string`
+
+The type of event bus component: service.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusComponent`](IEngineEnvironmentVariables.md#eventbuscomponent)
+
+***
+
+### messagingEnabled?
+
+> `optional` **messagingEnabled**: `string`
+
+Are the messaging components enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEnabled`](IEngineEnvironmentVariables.md#messagingenabled)
+
+***
+
+### awsSesRegion?
+
+> `optional` **awsSesRegion**: `string`
+
+AWS SES region.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesRegion`](IEngineEnvironmentVariables.md#awssesregion)
+
+***
+
+### awsSesAuthMode?
+
+> `optional` **awsSesAuthMode**: `string`
+
+AWS SES auth mode, either credentials or pod, defaults to credentials.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAuthMode`](IEngineEnvironmentVariables.md#awssesauthmode)
+
+***
+
+### awsSesSecretAccessKey?
+
+> `optional` **awsSesSecretAccessKey**: `string`
+
+AWS SES secret access key.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineEnvironmentVariables.md#awssessecretaccesskey)
+
+***
+
+### awsSesAccessKeyId?
+
+> `optional` **awsSesAccessKeyId**: `string`
+
+AWS SES access key id.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineEnvironmentVariables.md#awssesaccesskeyid)
+
+***
+
+### awsSesEndpoint?
+
+> `optional` **awsSesEndpoint**: `string`
+
+AWS SES endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesEndpoint`](IEngineEnvironmentVariables.md#awssesendpoint)
+
+***
+
+### awsMessagingPushNotificationApplications?
+
+> `optional` **awsMessagingPushNotificationApplications**: `string`
+
+The applications for the push notifications JSON stringified array of IAwsApplicationSettings.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineEnvironmentVariables.md#awsmessagingpushnotificationapplications)
+
+***
+
+### messagingEmailConnector?
+
+> `optional` **messagingEmailConnector**: `string`
+
+The type of messaging email connector: entity-storage, aws.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEmailConnector`](IEngineEnvironmentVariables.md#messagingemailconnector)
+
+***
+
+### messagingSmsConnector?
+
+> `optional` **messagingSmsConnector**: `string`
+
+The type of messaging sms connector: entity-storage, aws.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingSmsConnector`](IEngineEnvironmentVariables.md#messagingsmsconnector)
+
+***
+
+### messagingPushNotificationConnector?
+
+> `optional` **messagingPushNotificationConnector**: `string`
+
+The type of messaging push notification connector: entity-storage, aws.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineEnvironmentVariables.md#messagingpushnotificationconnector)
+
+***
+
+### telemetryConnector?
+
+> `optional` **telemetryConnector**: `string`
+
+The type of telemetry connector: entity-storage.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryConnector`](IEngineEnvironmentVariables.md#telemetryconnector)
+
+***
+
+### faucetConnector?
+
+> `optional` **faucetConnector**: `string`
+
+The type of faucet connector: entity-storage, iota.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`faucetConnector`](IEngineEnvironmentVariables.md#faucetconnector)
+
+***
+
+### walletConnector?
+
+> `optional` **walletConnector**: `string`
+
+The type of wallet connector: entity-storage, iota.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`walletConnector`](IEngineEnvironmentVariables.md#walletconnector)
+
+***
+
+### nftConnector?
+
+> `optional` **nftConnector**: `string`
+
+The type of NFT connector: entity-storage, iota.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nftConnector`](IEngineEnvironmentVariables.md#nftconnector)
+
+***
+
+### identityConnector?
+
+> `optional` **identityConnector**: `string`
+
+The type of identity connector: entity-storage, iota.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityConnector`](IEngineEnvironmentVariables.md#identityconnector)
+
+***
+
+### identityResolverConnector?
+
+> `optional` **identityResolverConnector**: `string`
+
+The type of identity resolver connector: entity-storage, iota.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityResolverConnector`](IEngineEnvironmentVariables.md#identityresolverconnector)
+
+***
+
+### verifiableStorageConnector?
+
+> `optional` **verifiableStorageConnector**: `string`
+
+The type of verifiable storage connector: entity-storage, iota.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineEnvironmentVariables.md#verifiablestorageconnector)
+
+***
+
+### iotaFaucetEndpoint?
+
+> `optional` **iotaFaucetEndpoint**: `string`
+
+IOTA Faucet Endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineEnvironmentVariables.md#iotafaucetendpoint)
+
+***
+
+### iotaNodeEndpoint?
+
+> `optional` **iotaNodeEndpoint**: `string`
+
+IOTA Node Endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineEnvironmentVariables.md#iotanodeendpoint)
+
+***
+
+### iotaNetwork?
+
+> `optional` **iotaNetwork**: `string`
+
+IOTA network.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNetwork`](IEngineEnvironmentVariables.md#iotanetwork)
+
+***
+
+### iotaCoinType?
+
+> `optional` **iotaCoinType**: `string`
+
+IOTA coin type.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaCoinType`](IEngineEnvironmentVariables.md#iotacointype)
+
+***
+
+### iotaExplorerEndpoint?
+
+> `optional` **iotaExplorerEndpoint**: `string`
+
+IOTA Explorer Endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineEnvironmentVariables.md#iotaexplorerendpoint)
+
+***
+
+### iotaGasStationEndpoint?
+
+> `optional` **iotaGasStationEndpoint**: `string`
+
+IOTA Gas Station Endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineEnvironmentVariables.md#iotagasstationendpoint)
+
+***
+
+### iotaGasStationAuthToken?
+
+> `optional` **iotaGasStationAuthToken**: `string`
+
+IOTA Gas Station Authentication Token.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineEnvironmentVariables.md#iotagasstationauthtoken)
+
+***
+
+### universalResolverEndpoint?
+
+> `optional` **universalResolverEndpoint**: `string`
+
+Universal Resolver Endpoint.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineEnvironmentVariables.md#universalresolverendpoint)
+
+***
+
+### identityProfileConnector?
+
+> `optional` **identityProfileConnector**: `string`
+
+The type of identity profile connector: entity-storage.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityProfileConnector`](IEngineEnvironmentVariables.md#identityprofileconnector)
+
+***
+
+### immutableProofVerificationMethodId?
+
+> `optional` **immutableProofVerificationMethodId**: `string`
+
+The identity verification method id to use with immutable proofs.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineEnvironmentVariables.md#immutableproofverificationmethodid)
+
+***
+
+### attestationConnector?
+
+> `optional` **attestationConnector**: `string`
+
+The type of attestation connector: entity-storage, iota.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationConnector`](IEngineEnvironmentVariables.md#attestationconnector)
+
+***
+
+### attestationVerificationMethodId?
+
+> `optional` **attestationVerificationMethodId**: `string`
+
+The identity verification method id to use with attestation.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineEnvironmentVariables.md#attestationverificationmethodid)
+
+***
+
+### dataProcessingEnabled?
+
+> `optional` **dataProcessingEnabled**: `string`
+
+Is the data processing enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataProcessingEnabled`](IEngineEnvironmentVariables.md#dataprocessingenabled)
 
-## Properties
+***
+
+### dataConverterConnectors?
+
+> `optional` **dataConverterConnectors**: `string`
+
+The type of the default data converters, can be a comma separated list: json, xml.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataConverterConnectors`](IEngineEnvironmentVariables.md#dataconverterconnectors)
+
+***
+
+### dataExtractorConnectors?
+
+> `optional` **dataExtractorConnectors**: `string`
+
+The type of the default data extractor, can be a comma separated list: json-path.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineEnvironmentVariables.md#dataextractorconnectors)
+
+***
+
+### auditableItemGraphEnabled?
+
+> `optional` **auditableItemGraphEnabled**: `string`
+
+Is the auditable item graph enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`auditableItemGraphEnabled`](IEngineEnvironmentVariables.md#auditableitemgraphenabled)
+
+***
+
+### auditableItemStreamEnabled?
+
+> `optional` **auditableItemStreamEnabled**: `string`
+
+Is the auditable item stream enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`auditableItemStreamEnabled`](IEngineEnvironmentVariables.md#auditableitemstreamenabled)
+
+***
+
+### documentManagementEnabled?
+
+> `optional` **documentManagementEnabled**: `string`
+
+Is the document management enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`documentManagementEnabled`](IEngineEnvironmentVariables.md#documentmanagementenabled)
+
+***
+
+### synchronisedStorageEnabled?
+
+> `optional` **synchronisedStorageEnabled**: `string`
+
+Is the synchronised storage enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineEnvironmentVariables.md#synchronisedstorageenabled)
+
+***
+
+### synchronisedStorageTrustedUrl?
+
+> `optional` **synchronisedStorageTrustedUrl**: `string`
+
+Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineEnvironmentVariables.md#synchronisedstoragetrustedurl)
+
+***
+
+### synchronisedStorageVerifiableStorageKeyId?
+
+> `optional` **synchronisedStorageVerifiableStorageKeyId**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
+
+***
+
+### synchronisedStorageBlobStorageEncryptionKeyId?
+
+> `optional` **synchronisedStorageBlobStorageEncryptionKeyId**: `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
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
+
+***
+
+### synchronisedStorageBlobStorageKey?
+
+> `optional` **synchronisedStorageBlobStorageKey**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstoragekey)
+
+***
+
+### synchronisedStorageEntityUpdateIntervalMinutes?
+
+> `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`
+
+How often to check for entity updates in minutes.
+
+#### Default
+
+```ts
+5
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
+
+***
+
+### synchronisedStorageConsolidationIntervalMinutes?
+
+> `optional` **synchronisedStorageConsolidationIntervalMinutes**: `string`
+
+Interval to perform consolidation of changesets, only used if this is a trusted node.
+
+#### Default
+
+```ts
+60
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
+
+***
+
+### synchronisedStorageConsolidationBatchSize?
+
+> `optional` **synchronisedStorageConsolidationBatchSize**: `string`
+
+The number of entities to process in a single consolidation batch, only used if this is a trusted node.
+
+#### Default
+
+```ts
+1000
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
+
+***
+
+### synchronisedStorageMaxConsolidations?
+
+> `optional` **synchronisedStorageMaxConsolidations**: `string`
+
+The maximum number of consolidations to keep in storage, only used if this is a trusted node.
+
+#### Default
+
+```ts
+5
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
+
+***
+
+### federatedCatalogueEnabled?
+
+> `optional` **federatedCatalogueEnabled**: `string`
+
+Is the federated catalogue enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
+
+***
+
+### federatedCatalogueCacheTtlMs?
+
+> `optional` **federatedCatalogueCacheTtlMs**: `number`
+
+Federated catalog TTL for the cache.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineEnvironmentVariables.md#federatedcataloguecachettlms)
+
+***
+
+### federatedCatalogueClearingHouseApproverList?
+
+> `optional` **federatedCatalogueClearingHouseApproverList**: `string`
+
+Federated catalog clearing house approver list, stringified array of DIDs.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
+
+***
+
+### rightsManagementEnabled?
+
+> `optional` **rightsManagementEnabled**: `string`
+
+Is the rights management enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineEnvironmentVariables.md#rightsmanagementenabled)
+
+***
+
+### rightsManagementBaseCallbackUrl?
+
+> `optional` **rightsManagementBaseCallbackUrl**: `string`
+
+What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineEnvironmentVariables.md#rightsmanagementbasecallbackurl)
+
+***
+
+### rightsManagementInformationSources?
+
+> `optional` **rightsManagementInformationSources**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementinformationsources)
+
+***
+
+### rightsManagementNegotiators?
+
+> `optional` **rightsManagementNegotiators**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementnegotiators)
+
+***
+
+### rightsManagementRequesters?
+
+> `optional` **rightsManagementRequesters**: `string`
+
+The rights management configuration which includes the requester modules to load.
+Use the @json: prefix to specify the path to the JSON configuration file.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementRequesters`](IEngineEnvironmentVariables.md#rightsmanagementrequesters)
+
+***
+
+### rightsManagementExecutionActions?
+
+> `optional` **rightsManagementExecutionActions**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementexecutionactions)
+
+***
+
+### rightsManagementEnforcementProcessors?
+
+> `optional` **rightsManagementEnforcementProcessors**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementenforcementprocessors)
+
+***
+
+### rightsManagementArbiters?
+
+> `optional` **rightsManagementArbiters**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementArbiters`](IEngineEnvironmentVariables.md#rightsmanagementarbiters)
+
+***
+
+### rightsManagementOffers?
+
+> `optional` **rightsManagementOffers**: `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.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementOffers`](IEngineEnvironmentVariables.md#rightsmanagementoffers)
+
+***
+
+### taskSchedulerEnabled?
+
+> `optional` **taskSchedulerEnabled**: `string`
+
+Is the task scheduler enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineEnvironmentVariables.md#taskschedulerenabled)
+
+***
+
+### dataSpaceConnectorEnabled?
+
+> `optional` **dataSpaceConnectorEnabled**: `string`
+
+Is the data space connector enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineEnvironmentVariables.md#dataspaceconnectorenabled)
+
+***
+
+### dataSpaceConnectorRetainActivityLogsFor?
+
+> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
+
+The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+
+#### Default
+
+```ts
+10
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
+
+***
+
+### dataSpaceConnectorActivityLogsCleanUpInterval?
+
+> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
+
+The interval for cleaning up the activity logs.
+
+#### Default
+
+```ts
+60
+```
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
+
+***
+
+### vcAuthenticationEnabled?
+
+> `optional` **vcAuthenticationEnabled**: `string`
+
+Enable verifiable credential authentication for the API.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineEnvironmentVariables.md#vcauthenticationenabled)
+
+***
+
+### vcAuthenticationVerificationMethodId?
+
+> `optional` **vcAuthenticationVerificationMethodId**: `string`
+
+Verifiable credential assertion for node to node communication.
+Defaults to node-authentication-assertion.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineEnvironmentVariables.md#vcauthenticationverificationmethodid)
+
+***
+
+### extensions?
+
+> `optional` **extensions**: `string`
+
+A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`extensions`](IEngineEnvironmentVariables.md#extensions)
+
+***
 
 ### port?
 
@@ -88,8 +1763,24 @@ Additional MIME type processors to include, comma separated.
 
 ***
 
-### disableNodeIdentity?
+### routeLoggingIncludeBody?
+
+> `optional` **routeLoggingIncludeBody**: `string`
+
+Include the body in the REST logging output, useful for debugging.
+
+***
+
+### routeLoggingFullBase64?
+
+> `optional` **routeLoggingFullBase64**: `string`
+
+Include the full base 64 output in the REST logging output, useful for debugging.
+
+***
+
+### routeLoggingObfuscateProperties?
 
-> `optional` **disableNodeIdentity**: `string`
+> `optional` **routeLoggingObfuscateProperties**: `string`
 
-Disable Node Identity route processors.
+List of properties to obfuscate in the REST logging output, comma separated.