Skip to main content

Interface: IEngineEnvironmentVariables

The engine core environment variables.

Extended by​

Properties​

debug?​

optional debug?: string

Start the engine in debug mode.

silent?​

optional silent?: string

Start the engine in silent mode.

storageFileRoot?​

optional storageFileRoot?: string

The root directory for storing items like state file.

stateFilename?​

optional stateFilename?: string

The name of the state file.

nodeIdentityEnabled?​

optional nodeIdentityEnabled?: string

Does the node have a unique ID, defaults to true.

tenantEnabled?​

optional tenantEnabled?: string

Is multi-tenant support enabled, defaults to false.

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.

awsDynamodbConnectionTimeoutMs?​

optional awsDynamodbConnectionTimeoutMs?: string

AWS Dynamo DB connection timeout.

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.

gcpFirestoreApiEndpoint?​

optional gcpFirestoreApiEndpoint?: 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.

mySqlHost?​

optional mySqlHost?: string

MySQL host.

mySqlPort?​

optional mySqlPort?: number

MySQL port.

mySqlUser?​

optional mySqlUser?: string

MySQL username.

mySqlPassword?​

optional mySqlPassword?: string

MySQL password.

mySqlDatabase?​

optional mySqlDatabase?: string

MySQL Database.

mongoDbHost?​

optional mongoDbHost?: string

MongoDB host.

mongoDbPort?​

optional mongoDbPort?: number

MongoDB port.

mongoDbUser?​

optional mongoDbUser?: string

MongoDB username.

mongoDbPassword?​

optional mongoDbPassword?: string

MongoDB password.

mongoDbDatabase?​

optional mongoDbDatabase?: string

MongoDB Database.

postgreSqlHost?​

optional postgreSqlHost?: string

PostgreSQl host.

postgreSqlPort?​

optional postgreSqlPort?: number

PostgreSQl port.

postgreSqlUser?​

optional postgreSqlUser?: string

PostgreSQl username.

postgreSqlPassword?​

optional postgreSqlPassword?: string

PostgreSQl password.

postgreSqlDatabase?​

optional postgreSqlDatabase?: string

PostgreSQl Database.

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.

blobStorageConnectorPublic?​

optional blobStorageConnectorPublic?: string

Blog storage connector which has public access.

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.

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: entity-storage.

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.

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.

identityResolverConnector?​

optional identityResolverConnector?: string

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

verifiableStorageConnector?​

optional verifiableStorageConnector?: string

The type of verifiable storage 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.

iotaExplorerEndpoint?​

optional iotaExplorerEndpoint?: string

IOTA Explorer Endpoint.

iotaGasStationEndpoint?​

optional iotaGasStationEndpoint?: string

IOTA Gas Station Endpoint.

iotaGasStationAuthToken?​

optional iotaGasStationAuthToken?: string

IOTA Gas Station Authentication Token.

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.

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.

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.

synchronisedStorageEnabled?​

optional synchronisedStorageEnabled?: string

Is the synchronised storage enabled, defaults to false.

synchronisedStorageTrustedUrl?​

optional synchronisedStorageTrustedUrl?: string

Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.

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.

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

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.

synchronisedStorageEntityUpdateIntervalMinutes?​

optional synchronisedStorageEntityUpdateIntervalMinutes?: string

How often to check for entity updates in minutes.

Default​

5

synchronisedStorageConsolidationIntervalMinutes?​

optional synchronisedStorageConsolidationIntervalMinutes?: string

Interval to perform consolidation of changesets, only used if this is a trusted node.

Default​

60

synchronisedStorageConsolidationBatchSize?​

optional synchronisedStorageConsolidationBatchSize?: string

The number of entities to process in a single consolidation batch, only used if this is a trusted node.

Default​

1000

synchronisedStorageMaxConsolidations?​

optional synchronisedStorageMaxConsolidations?: string

The maximum number of consolidations to keep in storage, only used if this is a trusted node.

Default​

5

federatedCatalogueEnabled?​

optional federatedCatalogueEnabled?: string

Is the federated catalogue enabled, defaults to false.

federatedCatalogueFilters?​

optional federatedCatalogueFilters?: string

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

trustEnabled?​

optional trustEnabled?: string

Is the trust management enabled, defaults to false.

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.

trustJwtTtlSeconds?​

optional trustJwtTtlSeconds?: string

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

rightsManagementEnabled?​

optional rightsManagementEnabled?: string

Is the rights management enabled, defaults to false.

rightsManagementCallbackPath?​

optional rightsManagementCallbackPath?: string

What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.

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.

backgroundTasksEnabled?​

optional backgroundTasksEnabled?: string

Are background tasks enabled, defaults to false.

taskSchedulerEnabled?​

optional taskSchedulerEnabled?: string

Is the task scheduler enabled, defaults to false.

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 minutes, set to -1 to keep forever.

Default​

10

dataspaceActivityLogsCleanUpInterval?​

optional dataspaceActivityLogsCleanUpInterval?: string

The interval for cleaning up the activity logs.

Default​

60

dataspaceDataPlanePath?​

optional dataspaceDataPlanePath?: string

The data plane path for PULL transfers (path only, not full URL). Will be combined with public origin from hosting component. Required if PULL transfers should be supported. Example: "dataspace/entities"

extensions?​

optional extensions?: string

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