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​

IEngineServerEnvironmentVariables.debug

storageFileRoot?​

optional storageFileRoot: string

The root directory for storing items like state file.

Inherited from​

IEngineServerEnvironmentVariables.storageFileRoot

stateFilename?​

optional stateFilename: string

The name of the state file.

Inherited from​

IEngineServerEnvironmentVariables.stateFilename

tenantEnabled?​

optional tenantEnabled: string

Is multi-tenant support enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.tenantEnabled

tenantId?​

optional tenantId: string

A tenant id to use as a default for the node.

Inherited from​

IEngineServerEnvironmentVariables.tenantId

tenantApiKey?​

optional tenantApiKey: string

A tenant api key to use as a default for the node.

Inherited from​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.entityStorageConnectorType

entityStorageConnectorDefault?​

optional entityStorageConnectorDefault: string

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

Inherited from​

IEngineServerEnvironmentVariables.entityStorageConnectorDefault

entityStorageTablePrefix?​

optional entityStorageTablePrefix: string

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

Inherited from​

IEngineServerEnvironmentVariables.entityStorageTablePrefix

awsDynamodbAuthMode?​

optional awsDynamodbAuthMode: string

AWS DynamoDB auth mode, either credentials or pod.

Inherited from​

IEngineServerEnvironmentVariables.awsDynamodbAuthMode

awsDynamodbAccessKeyId?​

optional awsDynamodbAccessKeyId: string

AWS Dynamo DB access key id.

Inherited from​

IEngineServerEnvironmentVariables.awsDynamodbAccessKeyId

awsDynamodbEndpoint?​

optional awsDynamodbEndpoint: string

AWS Dynamo DB Endpoint if running local instance.

Inherited from​

IEngineServerEnvironmentVariables.awsDynamodbEndpoint

awsDynamodbRegion?​

optional awsDynamodbRegion: string

AWS Dynamo DB region.

Inherited from​

IEngineServerEnvironmentVariables.awsDynamodbRegion

awsDynamodbSecretAccessKey?​

optional awsDynamodbSecretAccessKey: string

AWS Dynamo DB secret access key.

Inherited from​

IEngineServerEnvironmentVariables.awsDynamodbSecretAccessKey

azureCosmosdbKey?​

optional azureCosmosdbKey: string

Azure Cosmos DB key.

Inherited from​

IEngineServerEnvironmentVariables.azureCosmosdbKey

azureCosmosdbContainerId?​

optional azureCosmosdbContainerId: string

Azure Cosmos DB container id.

Inherited from​

IEngineServerEnvironmentVariables.azureCosmosdbContainerId

azureCosmosdbDatabaseId?​

optional azureCosmosdbDatabaseId: string

Azure Cosmos DB database id.

Inherited from​

IEngineServerEnvironmentVariables.azureCosmosdbDatabaseId

azureCosmosdbEndpoint?​

optional azureCosmosdbEndpoint: string

Azure Cosmos DB endpoint.

Inherited from​

IEngineServerEnvironmentVariables.azureCosmosdbEndpoint

gcpFirestoreCollectionName?​

optional gcpFirestoreCollectionName: string

GCP Firestore collection name.

Inherited from​

IEngineServerEnvironmentVariables.gcpFirestoreCollectionName

gcpFirestoreCredentials?​

optional gcpFirestoreCredentials: string

GCP Firestore credentials.

Inherited from​

IEngineServerEnvironmentVariables.gcpFirestoreCredentials

gcpFirestoreDatabaseId?​

optional gcpFirestoreDatabaseId: string

GCP Firestore database id.

Inherited from​

IEngineServerEnvironmentVariables.gcpFirestoreDatabaseId

gcpFirestoreApiEndpoint?​

optional gcpFirestoreApiEndpoint: string

GCP Firestore endpoint.

Inherited from​

IEngineServerEnvironmentVariables.gcpFirestoreApiEndpoint

gcpFirestoreProjectId?​

optional gcpFirestoreProjectId: string

GCP Firestore project id.

Inherited from​

IEngineServerEnvironmentVariables.gcpFirestoreProjectId

scylladbHosts?​

optional scylladbHosts: string

ScyllaDB hosts as comma separated string.

Inherited from​

IEngineServerEnvironmentVariables.scylladbHosts

scylladbKeyspace?​

optional scylladbKeyspace: string

ScyllaDB keyspace.

Inherited from​

IEngineServerEnvironmentVariables.scylladbKeyspace

scylladbLocalDataCenter?​

optional scylladbLocalDataCenter: string

ScyllaDB local data center.

Inherited from​

IEngineServerEnvironmentVariables.scylladbLocalDataCenter

scylladbPort?​

optional scylladbPort: string

ScyllaDB port.

Inherited from​

IEngineServerEnvironmentVariables.scylladbPort

mySqlHost?​

optional mySqlHost: string

MySQL host.

Inherited from​

IEngineServerEnvironmentVariables.mySqlHost

mySqlPort?​

optional mySqlPort: number

MySQL port.

Inherited from​

IEngineServerEnvironmentVariables.mySqlPort

mySqlUser?​

optional mySqlUser: string

MySQL username.

Inherited from​

IEngineServerEnvironmentVariables.mySqlUser

mySqlPassword?​

optional mySqlPassword: string

MySQL password.

Inherited from​

IEngineServerEnvironmentVariables.mySqlPassword

mySqlDatabase?​

optional mySqlDatabase: string

MySQL Database.

Inherited from​

IEngineServerEnvironmentVariables.mySqlDatabase

mongoDbHost?​

optional mongoDbHost: string

MongoDB host.

Inherited from​

IEngineServerEnvironmentVariables.mongoDbHost

mongoDbPort?​

optional mongoDbPort: number

MongoDB port.

Inherited from​

IEngineServerEnvironmentVariables.mongoDbPort

mongoDbUser?​

optional mongoDbUser: string

MongoDB username.

Inherited from​

IEngineServerEnvironmentVariables.mongoDbUser

mongoDbPassword?​

optional mongoDbPassword: string

MongoDB password.

Inherited from​

IEngineServerEnvironmentVariables.mongoDbPassword

mongoDbDatabase?​

optional mongoDbDatabase: string

MongoDB Database.

Inherited from​

IEngineServerEnvironmentVariables.mongoDbDatabase

postgreSqlHost?​

optional postgreSqlHost: string

PostgreSQl host.

Inherited from​

IEngineServerEnvironmentVariables.postgreSqlHost

postgreSqlPort?​

optional postgreSqlPort: number

PostgreSQl port.

Inherited from​

IEngineServerEnvironmentVariables.postgreSqlPort

postgreSqlUser?​

optional postgreSqlUser: string

PostgreSQl username.

Inherited from​

IEngineServerEnvironmentVariables.postgreSqlUser

postgreSqlPassword?​

optional postgreSqlPassword: string

PostgreSQl password.

Inherited from​

IEngineServerEnvironmentVariables.postgreSqlPassword

postgreSqlDatabase?​

optional postgreSqlDatabase: string

PostgreSQl Database.

Inherited from​

IEngineServerEnvironmentVariables.postgreSqlDatabase

ipfsBearerToken?​

optional ipfsBearerToken: string

The security token for accessing IPFS API.

Inherited from​

IEngineServerEnvironmentVariables.ipfsBearerToken

ipfsApiUrl?​

optional ipfsApiUrl: string

The url for accessing IPFS API.

Inherited from​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.blobStorageConnectorType

blobStorageConnectorDefault?​

optional blobStorageConnectorDefault: string

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

Inherited from​

IEngineServerEnvironmentVariables.blobStorageConnectorDefault

blobStorageConnectorPublic?​

optional blobStorageConnectorPublic: string

Blog storage connector which has public access.

Inherited from​

IEngineServerEnvironmentVariables.blobStorageConnectorPublic

blobStorageEnableEncryption?​

optional blobStorageEnableEncryption: string

Enable encryption for the blob storage.

Inherited from​

IEngineServerEnvironmentVariables.blobStorageEnableEncryption

blobStorageEncryptionKeyId?​

optional blobStorageEncryptionKeyId: string

The id of the encryption key for the blob storage.

Inherited from​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.blobStorageSymmetricEncryptionKey

blobStoragePrefix?​

optional blobStoragePrefix: string

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

Inherited from​

IEngineServerEnvironmentVariables.blobStoragePrefix

awsS3Region?​

optional awsS3Region: string

AWS S3 region.

Inherited from​

IEngineServerEnvironmentVariables.awsS3Region

awsS3BucketName?​

optional awsS3BucketName: string

AWS S3 bucket name.

Inherited from​

IEngineServerEnvironmentVariables.awsS3BucketName

awsS3AuthMode?​

optional awsS3AuthMode: string

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

Inherited from​

IEngineServerEnvironmentVariables.awsS3AuthMode

awsS3AccessKeyId?​

optional awsS3AccessKeyId: string

AWS S3 access key id.

Inherited from​

IEngineServerEnvironmentVariables.awsS3AccessKeyId

awsS3SecretAccessKey?​

optional awsS3SecretAccessKey: string

AWS S3 secret access key.

Inherited from​

IEngineServerEnvironmentVariables.awsS3SecretAccessKey

awsS3Endpoint?​

optional awsS3Endpoint: string

AWS S3 endpoint.

Inherited from​

IEngineServerEnvironmentVariables.awsS3Endpoint

azureStorageAccountKey?​

optional azureStorageAccountKey: string

Azure Storage account key.

Inherited from​

IEngineServerEnvironmentVariables.azureStorageAccountKey

azureStorageAccountName?​

optional azureStorageAccountName: string

Azure Storage account name.

Inherited from​

IEngineServerEnvironmentVariables.azureStorageAccountName

azureStorageContainerName?​

optional azureStorageContainerName: string

Azure Storage container.

Inherited from​

IEngineServerEnvironmentVariables.azureStorageContainerName

azureStorageEndpoint?​

optional azureStorageEndpoint: string

Azure Storage endpoint.

Inherited from​

IEngineServerEnvironmentVariables.azureStorageEndpoint

gcpStorageBucketName?​

optional gcpStorageBucketName: string

GCP Storage bucket.

Inherited from​

IEngineServerEnvironmentVariables.gcpStorageBucketName

gcpStorageCredentials?​

optional gcpStorageCredentials: string

GCP Storage credentials.

Inherited from​

IEngineServerEnvironmentVariables.gcpStorageCredentials

gcpStorageEndpoint?​

optional gcpStorageEndpoint: string

GCP Storage endpoint.

Inherited from​

IEngineServerEnvironmentVariables.gcpStorageEndpoint

gcpStorageProjectId?​

optional gcpStorageProjectId: string

GCP Storage project id.

Inherited from​

IEngineServerEnvironmentVariables.gcpStorageProjectId

vaultConnector?​

optional vaultConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.vaultConnector

hashicorpVaultToken?​

optional hashicorpVaultToken: string

Hashicorp Vault token.

Inherited from​

IEngineServerEnvironmentVariables.hashicorpVaultToken

hashicorpVaultEndpoint?​

optional hashicorpVaultEndpoint: string

Hashicorp Vault endpoint.

Inherited from​

IEngineServerEnvironmentVariables.hashicorpVaultEndpoint

loggingConnector?​

optional loggingConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.loggingConnector

backgroundTaskConnector?​

optional backgroundTaskConnector: string

The type of background task connector: entity-storage.

Inherited from​

IEngineServerEnvironmentVariables.backgroundTaskConnector

eventBusConnector?​

optional eventBusConnector: string

The type of event bus connector: local.

Inherited from​

IEngineServerEnvironmentVariables.eventBusConnector

eventBusComponent?​

optional eventBusComponent: string

The type of event bus component: service.

Inherited from​

IEngineServerEnvironmentVariables.eventBusComponent

messagingEnabled?​

optional messagingEnabled: string

Are the messaging components enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.messagingEnabled

awsSesRegion?​

optional awsSesRegion: string

AWS SES region.

Inherited from​

IEngineServerEnvironmentVariables.awsSesRegion

awsSesAuthMode?​

optional awsSesAuthMode: string

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

Inherited from​

IEngineServerEnvironmentVariables.awsSesAuthMode

awsSesSecretAccessKey?​

optional awsSesSecretAccessKey: string

AWS SES secret access key.

Inherited from​

IEngineServerEnvironmentVariables.awsSesSecretAccessKey

awsSesAccessKeyId?​

optional awsSesAccessKeyId: string

AWS SES access key id.

Inherited from​

IEngineServerEnvironmentVariables.awsSesAccessKeyId

awsSesEndpoint?​

optional awsSesEndpoint: string

AWS SES endpoint.

Inherited from​

IEngineServerEnvironmentVariables.awsSesEndpoint

awsMessagingPushNotificationApplications?​

optional awsMessagingPushNotificationApplications: string

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

Inherited from​

IEngineServerEnvironmentVariables.awsMessagingPushNotificationApplications

messagingEmailConnector?​

optional messagingEmailConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.messagingEmailConnector

messagingSmsConnector?​

optional messagingSmsConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.messagingSmsConnector

messagingPushNotificationConnector?​

optional messagingPushNotificationConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.messagingPushNotificationConnector

telemetryConnector?​

optional telemetryConnector: string

The type of telemetry connector: entity-storage.

Inherited from​

IEngineServerEnvironmentVariables.telemetryConnector

faucetConnector?​

optional faucetConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.faucetConnector

walletConnector?​

optional walletConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.walletConnector

nftConnector?​

optional nftConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.nftConnector

identityConnector?​

optional identityConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.identityConnector

identityResolverConnector?​

optional identityResolverConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.identityResolverConnector

verifiableStorageConnector?​

optional verifiableStorageConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.verifiableStorageConnector

iotaFaucetEndpoint?​

optional iotaFaucetEndpoint: string

IOTA Faucet Endpoint.

Inherited from​

IEngineServerEnvironmentVariables.iotaFaucetEndpoint

iotaNodeEndpoint?​

optional iotaNodeEndpoint: string

IOTA Node Endpoint.

Inherited from​

IEngineServerEnvironmentVariables.iotaNodeEndpoint

iotaNetwork?​

optional iotaNetwork: string

IOTA network.

Inherited from​

IEngineServerEnvironmentVariables.iotaNetwork

iotaCoinType?​

optional iotaCoinType: string

IOTA coin type.

Inherited from​

IEngineServerEnvironmentVariables.iotaCoinType

iotaExplorerEndpoint?​

optional iotaExplorerEndpoint: string

IOTA Explorer Endpoint.

Inherited from​

IEngineServerEnvironmentVariables.iotaExplorerEndpoint

iotaGasStationEndpoint?​

optional iotaGasStationEndpoint: string

IOTA Gas Station Endpoint.

Inherited from​

IEngineServerEnvironmentVariables.iotaGasStationEndpoint

iotaGasStationAuthToken?​

optional iotaGasStationAuthToken: string

IOTA Gas Station Authentication Token.

Inherited from​

IEngineServerEnvironmentVariables.iotaGasStationAuthToken

universalResolverEndpoint?​

optional universalResolverEndpoint: string

Universal Resolver Endpoint.

Inherited from​

IEngineServerEnvironmentVariables.universalResolverEndpoint

identityProfileConnector?​

optional identityProfileConnector: string

The type of identity profile connector: entity-storage.

Inherited from​

IEngineServerEnvironmentVariables.identityProfileConnector

immutableProofVerificationMethodId?​

optional immutableProofVerificationMethodId: string

The identity verification method id to use with immutable proofs.

Inherited from​

IEngineServerEnvironmentVariables.immutableProofVerificationMethodId

attestationConnector?​

optional attestationConnector: string

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

Inherited from​

IEngineServerEnvironmentVariables.attestationConnector

attestationVerificationMethodId?​

optional attestationVerificationMethodId: string

The identity verification method id to use with attestation.

Inherited from​

IEngineServerEnvironmentVariables.attestationVerificationMethodId

dataProcessingEnabled?​

optional dataProcessingEnabled: string

Is the data processing enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.dataProcessingEnabled

dataConverterConnectors?​

optional dataConverterConnectors: string

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

Inherited from​

IEngineServerEnvironmentVariables.dataConverterConnectors

dataExtractorConnectors?​

optional dataExtractorConnectors: string

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

Inherited from​

IEngineServerEnvironmentVariables.dataExtractorConnectors

auditableItemGraphEnabled?​

optional auditableItemGraphEnabled: string

Is the auditable item graph enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.auditableItemGraphEnabled

auditableItemStreamEnabled?​

optional auditableItemStreamEnabled: string

Is the auditable item stream enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.auditableItemStreamEnabled

documentManagementEnabled?​

optional documentManagementEnabled: string

Is the document management enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.documentManagementEnabled

synchronisedStorageEnabled?​

optional synchronisedStorageEnabled: string

Is the synchronised storage enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.synchronisedStorageBlobStorageKey

synchronisedStorageEntityUpdateIntervalMinutes?​

optional synchronisedStorageEntityUpdateIntervalMinutes: string

How often to check for entity updates in minutes.

Default​

5

Inherited from​

IEngineServerEnvironmentVariables.synchronisedStorageEntityUpdateIntervalMinutes

synchronisedStorageConsolidationIntervalMinutes?​

optional synchronisedStorageConsolidationIntervalMinutes: string

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

Default​

60

Inherited from​

IEngineServerEnvironmentVariables.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​

1000

Inherited from​

IEngineServerEnvironmentVariables.synchronisedStorageConsolidationBatchSize

synchronisedStorageMaxConsolidations?​

optional synchronisedStorageMaxConsolidations: string

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

Default​

5

Inherited from​

IEngineServerEnvironmentVariables.synchronisedStorageMaxConsolidations

federatedCatalogueEnabled?​

optional federatedCatalogueEnabled: string

Is the federated catalogue enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.federatedCatalogueEnabled

federatedCatalogueCacheTtlMs?​

optional federatedCatalogueCacheTtlMs: number

Federated catalog TTL for the cache.

Inherited from​

IEngineServerEnvironmentVariables.federatedCatalogueCacheTtlMs

federatedCatalogueClearingHouseApproverList?​

optional federatedCatalogueClearingHouseApproverList: string

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

Inherited from​

IEngineServerEnvironmentVariables.federatedCatalogueClearingHouseApproverList

rightsManagementEnabled?​

optional rightsManagementEnabled: string

Is the rights management enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.rightsManagementEnabled

rightsManagementBaseCallbackUrl?​

optional rightsManagementBaseCallbackUrl: string

What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.

Inherited from​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.rightsManagementOffers

taskSchedulerEnabled?​

optional taskSchedulerEnabled: string

Is the task scheduler enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.taskSchedulerEnabled

dataSpaceConnectorEnabled?​

optional dataSpaceConnectorEnabled: string

Is the data space connector enabled, defaults to false.

Inherited from​

IEngineServerEnvironmentVariables.dataSpaceConnectorEnabled

dataSpaceConnectorRetainActivityLogsFor?​

optional dataSpaceConnectorRetainActivityLogsFor: string

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

Default​

10

Inherited from​

IEngineServerEnvironmentVariables.dataSpaceConnectorRetainActivityLogsFor

dataSpaceConnectorActivityLogsCleanUpInterval?​

optional dataSpaceConnectorActivityLogsCleanUpInterval: string

The interval for cleaning up the activity logs.

Default​

60

Inherited from​

IEngineServerEnvironmentVariables.dataSpaceConnectorActivityLogsCleanUpInterval

vcAuthenticationEnabled?​

optional vcAuthenticationEnabled: string

Enable verifiable credential authentication for the API.

Inherited from​

IEngineServerEnvironmentVariables.vcAuthenticationEnabled

vcAuthenticationVerificationMethodId?​

optional vcAuthenticationVerificationMethodId: string

Verifiable credential assertion for node to node communication. Defaults to node-authentication-assertion.

Inherited from​

IEngineServerEnvironmentVariables.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​

IEngineServerEnvironmentVariables.extensions

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

routeLoggingIncludeBody?​

optional routeLoggingIncludeBody: string

Include the body in the REST logging output, useful for debugging.

Inherited from​

IEngineServerEnvironmentVariables.routeLoggingIncludeBody

routeLoggingFullBase64?​

optional routeLoggingFullBase64: string

Include the full base 64 output in the REST logging output, useful for debugging.

Inherited from​

IEngineServerEnvironmentVariables.routeLoggingFullBase64

routeLoggingObfuscateProperties?​

optional routeLoggingObfuscateProperties: string

List of properties to obfuscate in the REST logging output, comma separated.

Inherited from​

IEngineServerEnvironmentVariables.routeLoggingObfuscateProperties

features?​

optional features: string

The features that are enabled on the node.

Default​

[]

nodeIdentity?​

optional nodeIdentity: string

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

nodeMnemonic?​

optional nodeMnemonic: string

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

organizationIdentity?​

optional organizationIdentity: string

If the node-admin-user feature is enabled, this will be the organization of the user, if one is not provided it will be generated

organizationMnemonic?​

optional organizationMnemonic: string

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

adminUserIdentity?​

optional adminUserIdentity: string

If the node-admin-user feature is enabled, this will be the identity of the user, if one is not provided it will be generated

adminUserMnemonic?​

optional adminUserMnemonic: string

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

adminUserName?​

optional adminUserName: string

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

Default​

admin@node

adminUserPassword?​

optional adminUserPassword: string

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

extensionsMaxSizeMb?​

optional extensionsMaxSizeMb: number

Maximum size in MB for HTTPS extensions downloads.

Default​

10

extensionsClearCache?​

optional extensionsClearCache: boolean

Whether to clear the extensions cache on startup.

Default​

false

extensionsCacheDirectory?​

optional extensionsCacheDirectory: string

Custom directory for extensions cache storage.

Default​

".tmp"

extensionsCacheTtlHours?​

optional extensionsCacheTtlHours: number

TTL in hours for HTTPS extensions cache.

Default​

24

extensionsForceRefresh?​

optional extensionsForceRefresh: boolean

Force refresh of all cached extensions.

Default​

false