Skip to main content

Interface: INodeEnvironmentVariables

The environment variables for the node.

Extends​

Properties​

debug?​

optional debug: string

Start the engine in debug mode.

Inherited from​

IEngineEnvironmentVariables.debug

storageFileRoot?​

optional storageFileRoot: string

The root directory for storing items like state file.

Inherited from​

IEngineEnvironmentVariables.storageFileRoot

stateFilename?​

optional stateFilename: string

The name of the state file.

Inherited from​

IEngineEnvironmentVariables.stateFilename

entityStorageConnectorType?​

optional entityStorageConnectorType: string

The type of the default entity storage: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql.

Inherited from​

IEngineEnvironmentVariables.entityStorageConnectorType

entityStorageTablePrefix?​

optional entityStorageTablePrefix: string

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

Inherited from​

IEngineEnvironmentVariables.entityStorageTablePrefix

entityFileEnable?​

optional entityFileEnable: string

Enable the file entity storage connector.

Inherited from​

IEngineEnvironmentVariables.entityFileEnable

entityMemoryEnable?​

optional entityMemoryEnable: string

Enable the memory entity storage connector.

Inherited from​

IEngineEnvironmentVariables.entityMemoryEnable

awsDynamodbAccessKeyId?​

optional awsDynamodbAccessKeyId: string

AWS Dynamo DB access key id.

Inherited from​

IEngineEnvironmentVariables.awsDynamodbAccessKeyId

awsDynamodbEndpoint?​

optional awsDynamodbEndpoint: string

AWS Dynamo DB Endpoint if running local instance.

Inherited from​

IEngineEnvironmentVariables.awsDynamodbEndpoint

awsDynamodbRegion?​

optional awsDynamodbRegion: string

AWS Dynamo DB region.

Inherited from​

IEngineEnvironmentVariables.awsDynamodbRegion

awsDynamodbSecretAccessKey?​

optional awsDynamodbSecretAccessKey: string

AWS Dynamo DB secret access key.

Inherited from​

IEngineEnvironmentVariables.awsDynamodbSecretAccessKey

azureCosmosdbKey?​

optional azureCosmosdbKey: string

Azure Cosmos DB key.

Inherited from​

IEngineEnvironmentVariables.azureCosmosdbKey

azureCosmosdbContainerId?​

optional azureCosmosdbContainerId: string

Azure Cosmos DB container id.

Inherited from​

IEngineEnvironmentVariables.azureCosmosdbContainerId

azureCosmosdbDatabaseId?​

optional azureCosmosdbDatabaseId: string

Azure Cosmos DB database id.

Inherited from​

IEngineEnvironmentVariables.azureCosmosdbDatabaseId

azureCosmosdbEndpoint?​

optional azureCosmosdbEndpoint: string

Azure Cosmos DB endpoint.

Inherited from​

IEngineEnvironmentVariables.azureCosmosdbEndpoint

gcpFirestoreCollectionName?​

optional gcpFirestoreCollectionName: string

GCP Firestore collection name.

Inherited from​

IEngineEnvironmentVariables.gcpFirestoreCollectionName

gcpFirestoreCredentials?​

optional gcpFirestoreCredentials: string

GCP Firestore credentials.

Inherited from​

IEngineEnvironmentVariables.gcpFirestoreCredentials

gcpFirestoreDatabaseId?​

optional gcpFirestoreDatabaseId: string

GCP Firestore database id.

Inherited from​

IEngineEnvironmentVariables.gcpFirestoreDatabaseId

gcpFirestoreApiEndpoint?​

optional gcpFirestoreApiEndpoint: string

GCP Firestore endpoint.

Inherited from​

IEngineEnvironmentVariables.gcpFirestoreApiEndpoint

gcpFirestoreProjectId?​

optional gcpFirestoreProjectId: string

GCP Firestore project id.

Inherited from​

IEngineEnvironmentVariables.gcpFirestoreProjectId

scylladbHosts?​

optional scylladbHosts: string

ScyllaDB hosts as comma separated string.

Inherited from​

IEngineEnvironmentVariables.scylladbHosts

scylladbKeyspace?​

optional scylladbKeyspace: string

ScyllaDB keyspace.

Inherited from​

IEngineEnvironmentVariables.scylladbKeyspace

scylladbLocalDataCenter?​

optional scylladbLocalDataCenter: string

ScyllaDB local data center.

Inherited from​

IEngineEnvironmentVariables.scylladbLocalDataCenter

mySqlHost?​

optional mySqlHost: string

MySQL host.

Inherited from​

IEngineEnvironmentVariables.mySqlHost

mySqlPort?​

optional mySqlPort: number

MySQL port.

Inherited from​

IEngineEnvironmentVariables.mySqlPort

mySqlUser?​

optional mySqlUser: string

MySQL username.

Inherited from​

IEngineEnvironmentVariables.mySqlUser

mySqlPassword?​

optional mySqlPassword: string

MySQL password.

Inherited from​

IEngineEnvironmentVariables.mySqlPassword

mySqlDatabase?​

optional mySqlDatabase: string

MySQL Database.

Inherited from​

IEngineEnvironmentVariables.mySqlDatabase

mongoDbHost?​

optional mongoDbHost: string

MongoDB host.

Inherited from​

IEngineEnvironmentVariables.mongoDbHost

mongoDbPort?​

optional mongoDbPort: number

MongoDB port.

Inherited from​

IEngineEnvironmentVariables.mongoDbPort

mongoDbUser?​

optional mongoDbUser: string

MongoDB username.

Inherited from​

IEngineEnvironmentVariables.mongoDbUser

mongoDbPassword?​

optional mongoDbPassword: string

MongoDB password.

Inherited from​

IEngineEnvironmentVariables.mongoDbPassword

mongoDbDatabase?​

optional mongoDbDatabase: string

MongoDB Database.

Inherited from​

IEngineEnvironmentVariables.mongoDbDatabase

postgreSqlHost?​

optional postgreSqlHost: string

PostgreSQl host.

Inherited from​

IEngineEnvironmentVariables.postgreSqlHost

postgreSqlPort?​

optional postgreSqlPort: number

PostgreSQl port.

Inherited from​

IEngineEnvironmentVariables.postgreSqlPort

postgreSqlUser?​

optional postgreSqlUser: string

PostgreSQl username.

Inherited from​

IEngineEnvironmentVariables.postgreSqlUser

postgreSqlPassword?​

optional postgreSqlPassword: string

PostgreSQl password.

Inherited from​

IEngineEnvironmentVariables.postgreSqlPassword

postgreSqlDatabase?​

optional postgreSqlDatabase: string

PostgreSQl Database.

Inherited from​

IEngineEnvironmentVariables.postgreSqlDatabase

ipfsBearerToken?​

optional ipfsBearerToken: string

The security token for accessing IPFS API.

Inherited from​

IEngineEnvironmentVariables.ipfsBearerToken

ipfsApiUrl?​

optional ipfsApiUrl: string

The url for accessing IPFS API.

Inherited from​

IEngineEnvironmentVariables.ipfsApiUrl

blobStorageConnectorType?​

optional blobStorageConnectorType: string

The type of the default blob storage: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.

Inherited from​

IEngineEnvironmentVariables.blobStorageConnectorType

blobStorageEnableEncryption?​

optional blobStorageEnableEncryption: string

Enable encryption for the blob storage.

Inherited from​

IEngineEnvironmentVariables.blobStorageEnableEncryption

blobStorageEncryptionKey?​

optional blobStorageEncryptionKey: string

The encryption key for the blob storage.

Inherited from​

IEngineEnvironmentVariables.blobStorageEncryptionKey

blobStoragePrefix?​

optional blobStoragePrefix: string

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

Inherited from​

IEngineEnvironmentVariables.blobStoragePrefix

blobFileEnable?​

optional blobFileEnable: string

Enable the file blob storage connector.

Inherited from​

IEngineEnvironmentVariables.blobFileEnable

blobMemoryEnable?​

optional blobMemoryEnable: string

Enable the memory blob storage connector.

Inherited from​

IEngineEnvironmentVariables.blobMemoryEnable

awsS3AccessKeyId?​

optional awsS3AccessKeyId: string

AWS S3 access key id.

Inherited from​

IEngineEnvironmentVariables.awsS3AccessKeyId

awsS3BucketName?​

optional awsS3BucketName: string

AWS S3 bucket name.

Inherited from​

IEngineEnvironmentVariables.awsS3BucketName

awsS3Endpoint?​

optional awsS3Endpoint: string

AWS S3 endpoint.

Inherited from​

IEngineEnvironmentVariables.awsS3Endpoint

awsS3Region?​

optional awsS3Region: string

AWS S3 region.

Inherited from​

IEngineEnvironmentVariables.awsS3Region

awsS3SecretAccessKey?​

optional awsS3SecretAccessKey: string

AWS S3 secret access key.

Inherited from​

IEngineEnvironmentVariables.awsS3SecretAccessKey

azureStorageAccountKey?​

optional azureStorageAccountKey: string

Azure Storage account key.

Inherited from​

IEngineEnvironmentVariables.azureStorageAccountKey

azureStorageAccountName?​

optional azureStorageAccountName: string

Azure Storage account name.

Inherited from​

IEngineEnvironmentVariables.azureStorageAccountName

azureStorageContainerName?​

optional azureStorageContainerName: string

Azure Storage container.

Inherited from​

IEngineEnvironmentVariables.azureStorageContainerName

azureStorageEndpoint?​

optional azureStorageEndpoint: string

Azure Storage endpoint.

Inherited from​

IEngineEnvironmentVariables.azureStorageEndpoint

gcpStorageBucketName?​

optional gcpStorageBucketName: string

GCP Storage bucket.

Inherited from​

IEngineEnvironmentVariables.gcpStorageBucketName

gcpStorageCredentials?​

optional gcpStorageCredentials: string

GCP Storage credentials.

Inherited from​

IEngineEnvironmentVariables.gcpStorageCredentials

gcpStorageEndpoint?​

optional gcpStorageEndpoint: string

GCP Storage endpoint.

Inherited from​

IEngineEnvironmentVariables.gcpStorageEndpoint

gcpStorageProjectId?​

optional gcpStorageProjectId: string

GCP Storage project id.

Inherited from​

IEngineEnvironmentVariables.gcpStorageProjectId

vaultConnector?​

optional vaultConnector: string

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

Inherited from​

IEngineEnvironmentVariables.vaultConnector

hashicorpVaultToken?​

optional hashicorpVaultToken: string

Hashicorp Vault token.

Inherited from​

IEngineEnvironmentVariables.hashicorpVaultToken

hashicorpVaultEndpoint?​

optional hashicorpVaultEndpoint: string

Hashicorp Vault endpoint.

Inherited from​

IEngineEnvironmentVariables.hashicorpVaultEndpoint

loggingConnector?​

optional loggingConnector: string

The type of background task connector, can be a comma separated list: console, entity-storage.

Inherited from​

IEngineEnvironmentVariables.loggingConnector

backgroundTaskConnector?​

optional backgroundTaskConnector: string

The type of background task connector: entity-storage.

Inherited from​

IEngineEnvironmentVariables.backgroundTaskConnector

eventBusConnector?​

optional eventBusConnector: string

The type of event bus connector: local.

Inherited from​

IEngineEnvironmentVariables.eventBusConnector

eventBusComponent?​

optional eventBusComponent: string

The type of event bus component: service.

Inherited from​

IEngineEnvironmentVariables.eventBusComponent

messagingEmailConnector?​

optional messagingEmailConnector: string

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

Inherited from​

IEngineEnvironmentVariables.messagingEmailConnector

messagingSmsConnector?​

optional messagingSmsConnector: string

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

Inherited from​

IEngineEnvironmentVariables.messagingSmsConnector

messagingPushNotificationConnector?​

optional messagingPushNotificationConnector: string

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

Inherited from​

IEngineEnvironmentVariables.messagingPushNotificationConnector

awsMessagingPushNotificationApplications?​

optional awsMessagingPushNotificationApplications: string

The applications for the push notifications JSON stringified array of IAwsApplicationSettings.

Inherited from​

IEngineEnvironmentVariables.awsMessagingPushNotificationApplications

messagingComponent?​

optional messagingComponent: string

The type of messaging component: service.

Inherited from​

IEngineEnvironmentVariables.messagingComponent

telemetryConnector?​

optional telemetryConnector: string

The type of telemetry connector: entity-storage.

Inherited from​

IEngineEnvironmentVariables.telemetryConnector

faucetConnector?​

optional faucetConnector: string

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

Inherited from​

IEngineEnvironmentVariables.faucetConnector

walletConnector?​

optional walletConnector: string

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

Inherited from​

IEngineEnvironmentVariables.walletConnector

nftConnector?​

optional nftConnector: string

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

Inherited from​

IEngineEnvironmentVariables.nftConnector

identityConnector?​

optional identityConnector: string

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

Inherited from​

IEngineEnvironmentVariables.identityConnector

identityResolverConnector?​

optional identityResolverConnector: string

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

Inherited from​

IEngineEnvironmentVariables.identityResolverConnector

verifiableStorageConnector?​

optional verifiableStorageConnector: string

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

Inherited from​

IEngineEnvironmentVariables.verifiableStorageConnector

iotaFaucetEndpoint?​

optional iotaFaucetEndpoint: string

IOTA Faucet Endpoint.

Inherited from​

IEngineEnvironmentVariables.iotaFaucetEndpoint

iotaNodeEndpoint?​

optional iotaNodeEndpoint: string

IOTA Node Endpoint.

Inherited from​

IEngineEnvironmentVariables.iotaNodeEndpoint

iotaNetwork?​

optional iotaNetwork: string

IOTA network.

Inherited from​

IEngineEnvironmentVariables.iotaNetwork

iotaCoinType?​

optional iotaCoinType: string

IOTA coin type.

Inherited from​

IEngineEnvironmentVariables.iotaCoinType

iotaExplorerEndpoint?​

optional iotaExplorerEndpoint: string

IOTA Explorer Endpoint.

Inherited from​

IEngineEnvironmentVariables.iotaExplorerEndpoint

iotaGasStationEndpoint?​

optional iotaGasStationEndpoint: string

IOTA Gas Station Endpoint.

Inherited from​

IEngineEnvironmentVariables.iotaGasStationEndpoint

iotaGasStationAuthToken?​

optional iotaGasStationAuthToken: string

IOTA Gas Station Authentication Token.

Inherited from​

IEngineEnvironmentVariables.iotaGasStationAuthToken

universalResolverEndpoint?​

optional universalResolverEndpoint: string

Universal Resolver Endpoint.

Inherited from​

IEngineEnvironmentVariables.universalResolverEndpoint

identityProfileConnector?​

optional identityProfileConnector: string

The type of identity profile connector: entity-storage.

Inherited from​

IEngineEnvironmentVariables.identityProfileConnector

immutableProofVerificationMethodId?​

optional immutableProofVerificationMethodId: string

The identity verification method id to use with immutable proofs.

Inherited from​

IEngineEnvironmentVariables.immutableProofVerificationMethodId

attestationConnector?​

optional attestationConnector: string

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

Inherited from​

IEngineEnvironmentVariables.attestationConnector

attestationVerificationMethodId?​

optional attestationVerificationMethodId: string

The identity verification method id to use with attestation.

Inherited from​

IEngineEnvironmentVariables.attestationVerificationMethodId

dataConverterConnectors?​

optional dataConverterConnectors: string

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

Inherited from​

IEngineEnvironmentVariables.dataConverterConnectors

dataExtractorConnectors?​

optional dataExtractorConnectors: string

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

Inherited from​

IEngineEnvironmentVariables.dataExtractorConnectors

federatedCatalogueCacheTtlMs?​

optional federatedCatalogueCacheTtlMs: number

Federated catalog TTL for the cache.

Inherited from​

IEngineEnvironmentVariables.federatedCatalogueCacheTtlMs

federatedCatalogueClearingHouseApproverList?​

optional federatedCatalogueClearingHouseApproverList: string

Federated catalog clearing house approver list, stringified array of DIDs.

Inherited from​

IEngineEnvironmentVariables.federatedCatalogueClearingHouseApproverList

rightsManagementEnabled?​

optional rightsManagementEnabled: string

Is the rights management enabled, defaults to false.

Inherited from​

IEngineEnvironmentVariables.rightsManagementEnabled

taskSchedulerEnabled?​

optional taskSchedulerEnabled: string

Is the task scheduler enabled, defaults to true.

Inherited from​

IEngineEnvironmentVariables.taskSchedulerEnabled

port?​

optional port: string

The port to serve the API from.

Inherited from​

IEngineServerEnvironmentVariables.port

host?​

optional host: string

The host to serve the API from.

Inherited from​

IEngineServerEnvironmentVariables.host

corsOrigins?​

optional corsOrigins: string

The CORS origins to allow, defaults to *.

Inherited from​

IEngineServerEnvironmentVariables.corsOrigins

httpMethods?​

optional httpMethods: string

The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.

Inherited from​

IEngineServerEnvironmentVariables.httpMethods

httpAllowedHeaders?​

optional httpAllowedHeaders: string

The CORS headers to allow.

Inherited from​

IEngineServerEnvironmentVariables.httpAllowedHeaders

httpExposedHeaders?​

optional httpExposedHeaders: string

The CORS headers to expose.

Inherited from​

IEngineServerEnvironmentVariables.httpExposedHeaders

authAdminProcessorType?​

optional authAdminProcessorType: string

The type of auth admin processor to use on the API: entity-storage.

Inherited from​

IEngineServerEnvironmentVariables.authAdminProcessorType

authProcessorType?​

optional authProcessorType: string

The type of auth processor to use on the API: entity-storage.

Inherited from​

IEngineServerEnvironmentVariables.authProcessorType

authSigningKeyId?​

optional authSigningKeyId: string

The id of the key in the vault to use for signing in auth operations.

Inherited from​

IEngineServerEnvironmentVariables.authSigningKeyId

mimeTypeProcessors?​

optional mimeTypeProcessors: string

Additional MIME type processors to include, comma separated.

Inherited from​

IEngineServerEnvironmentVariables.mimeTypeProcessors

disableNodeIdentity?​

optional disableNodeIdentity: string

Disable Node Identity route processors.

Inherited from​

IEngineServerEnvironmentVariables.disableNodeIdentity

features?​

optional features: string

The features that are enabled on the node.

Default​

[NodeFeatures.NodeIdentity]

identity?​

optional identity: string

The identity of the node which, if empty and node-identity feature is enabled it will be generated.

mnemonic?​

optional mnemonic: string

The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.

username?​

optional username: string

If the node-user feature is enabled, this will be the name of the user.

Default​

admin@node

password?​

optional password: string

If the node-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.