@twin.org/node-core 0.0.3-next.6 → 0.0.3-next.60
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/es/builders/engineEnvBuilder.js +538 -213
- package/dist/es/builders/engineEnvBuilder.js.map +1 -1
- package/dist/es/builders/engineServerEnvBuilder.js +86 -39
- package/dist/es/builders/engineServerEnvBuilder.js.map +1 -1
- package/dist/es/builders/extensionsBuilder.js +3 -3
- package/dist/es/builders/extensionsBuilder.js.map +1 -1
- package/dist/es/cli.js +254 -0
- package/dist/es/cli.js.map +1 -0
- package/dist/es/commands/bootstrapLegacy.js +311 -0
- package/dist/es/commands/bootstrapLegacy.js.map +1 -0
- package/dist/es/commands/help.js +86 -0
- package/dist/es/commands/help.js.map +1 -0
- package/dist/es/commands/identityCreate.js +377 -0
- package/dist/es/commands/identityCreate.js.map +1 -0
- package/dist/es/commands/identityImports.js +83 -0
- package/dist/es/commands/identityImports.js.map +1 -0
- package/dist/es/commands/identityVerifiableCredentialCreate.js +146 -0
- package/dist/es/commands/identityVerifiableCredentialCreate.js.map +1 -0
- package/dist/es/commands/identityVerificationMethodCreate.js +230 -0
- package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -0
- package/dist/es/commands/identityVerificationMethodImport.js +127 -0
- package/dist/es/commands/identityVerificationMethodImport.js.map +1 -0
- package/dist/es/commands/nodeSetIdentity.js +69 -0
- package/dist/es/commands/nodeSetIdentity.js.map +1 -0
- package/dist/es/commands/removeTenantOrgAlias.js +83 -0
- package/dist/es/commands/removeTenantOrgAlias.js.map +1 -0
- package/dist/es/commands/setNodeOrgId.js +62 -0
- package/dist/es/commands/setNodeOrgId.js.map +1 -0
- package/dist/es/commands/setTenantOrgId.js +99 -0
- package/dist/es/commands/setTenantOrgId.js.map +1 -0
- package/dist/es/commands/tenantCreate.js +165 -0
- package/dist/es/commands/tenantCreate.js.map +1 -0
- package/dist/es/commands/tenantImport.js +108 -0
- package/dist/es/commands/tenantImport.js.map +1 -0
- package/dist/es/commands/tenantUpdate.js +108 -0
- package/dist/es/commands/tenantUpdate.js.map +1 -0
- package/dist/es/commands/userCreate.js +239 -0
- package/dist/es/commands/userCreate.js.map +1 -0
- package/dist/es/commands/userUpdate.js +154 -0
- package/dist/es/commands/userUpdate.js.map +1 -0
- package/dist/es/commands/vaultKeyCreate.js +191 -0
- package/dist/es/commands/vaultKeyCreate.js.map +1 -0
- package/dist/es/commands/vaultKeyImport.js +105 -0
- package/dist/es/commands/vaultKeyImport.js.map +1 -0
- package/dist/es/defaults.js +37 -2
- package/dist/es/defaults.js.map +1 -1
- package/dist/es/index.js +11 -4
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/ICliArgs.js +4 -0
- package/dist/es/models/ICliArgs.js.map +1 -0
- package/dist/es/models/ICliCommand.js +2 -0
- package/dist/es/models/ICliCommand.js.map +1 -0
- package/dist/es/models/ICliCommandDefinition.js +2 -0
- package/dist/es/models/ICliCommandDefinition.js.map +1 -0
- package/dist/es/models/ICliCommandDefinitionParam.js +2 -0
- package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -0
- package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -1
- package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -1
- package/dist/es/models/INodeEngineState.js.map +1 -1
- package/dist/es/models/INodeEnvironmentVariables.js.map +1 -1
- package/dist/es/models/INodeOptions.js.map +1 -1
- package/dist/es/models/cliCommandParamType.js +4 -0
- package/dist/es/models/cliCommandParamType.js.map +1 -0
- package/dist/es/models/nodeExtensionInitialiseEngineMethod.js +2 -0
- package/dist/es/models/nodeExtensionInitialiseEngineMethod.js.map +1 -0
- package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js +2 -0
- package/dist/es/models/nodeExtensionInitialiseEngineServerMethod.js.map +1 -0
- package/dist/es/models/nodeExtensionInitialiseMethod.js +2 -0
- package/dist/es/models/nodeExtensionInitialiseMethod.js.map +1 -0
- package/dist/es/models/nodeExtensionShutdownMethod.js +4 -0
- package/dist/es/models/nodeExtensionShutdownMethod.js.map +1 -0
- package/dist/es/node.js +87 -40
- package/dist/es/node.js.map +1 -1
- package/dist/es/start.js +189 -0
- package/dist/es/start.js.map +1 -0
- package/dist/es/utils.js +24 -27
- package/dist/es/utils.js.map +1 -1
- package/dist/types/builders/engineEnvBuilder.d.ts +60 -5
- package/dist/types/builders/engineServerEnvBuilder.d.ts +11 -2
- package/dist/types/builders/extensionsBuilder.d.ts +3 -3
- package/dist/types/cli.d.ts +56 -0
- package/dist/types/commands/bootstrapLegacy.d.ts +67 -0
- package/dist/types/commands/help.d.ts +24 -0
- package/dist/types/commands/identityCreate.d.ts +45 -0
- package/dist/types/commands/identityImports.d.ts +25 -0
- package/dist/types/commands/identityVerifiableCredentialCreate.d.ts +43 -0
- package/dist/types/commands/identityVerificationMethodCreate.d.ts +47 -0
- package/dist/types/commands/identityVerificationMethodImport.d.ts +32 -0
- package/dist/types/commands/nodeSetIdentity.d.ts +23 -0
- package/dist/types/commands/removeTenantOrgAlias.d.ts +24 -0
- package/dist/types/commands/setNodeOrgId.d.ts +24 -0
- package/dist/types/commands/setTenantOrgId.d.ts +38 -0
- package/dist/types/commands/tenantCreate.d.ts +41 -0
- package/dist/types/commands/tenantImport.d.ts +29 -0
- package/dist/types/commands/tenantUpdate.d.ts +29 -0
- package/dist/types/commands/userCreate.d.ts +51 -0
- package/dist/types/commands/userUpdate.d.ts +40 -0
- package/dist/types/commands/vaultKeyCreate.d.ts +43 -0
- package/dist/types/commands/vaultKeyImport.d.ts +29 -0
- package/dist/types/defaults.d.ts +30 -2
- package/dist/types/index.d.ts +11 -4
- package/dist/types/models/ICliArgs.d.ts +20 -0
- package/dist/types/models/ICliCommand.d.ts +17 -0
- package/dist/types/models/ICliCommandDefinition.d.ts +46 -0
- package/dist/types/models/ICliCommandDefinitionParam.d.ts +35 -0
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +168 -95
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +8 -0
- package/dist/types/models/INodeEngineState.d.ts +2 -9
- package/dist/types/models/INodeEnvironmentVariables.d.ts +0 -38
- package/dist/types/models/INodeOptions.d.ts +6 -2
- package/dist/types/models/cliCommandParamType.d.ts +4 -0
- package/dist/types/models/nodeExtensionInitialiseEngineMethod.d.ts +8 -0
- package/dist/types/models/nodeExtensionInitialiseEngineServerMethod.d.ts +9 -0
- package/dist/types/models/nodeExtensionInitialiseMethod.d.ts +9 -0
- package/dist/types/models/nodeExtensionShutdownMethod.d.ts +6 -0
- package/dist/types/node.d.ts +5 -4
- package/dist/types/{server.d.ts → start.d.ts} +4 -2
- package/dist/types/utils.d.ts +9 -10
- package/docs/changelog.md +675 -180
- package/docs/examples.md +99 -1
- package/docs/reference/functions/buildConfiguration.md +1 -1
- package/docs/reference/functions/buildEngineConfiguration.md +1 -7
- package/docs/reference/functions/buildEngineServerConfiguration.md +1 -1
- package/docs/reference/functions/constructCliCommand.md +27 -0
- package/docs/reference/functions/executeCommand.md +29 -0
- package/docs/reference/functions/extensionsInitialiseEngine.md +1 -1
- package/docs/reference/functions/extensionsInitialiseEngineServer.md +1 -1
- package/docs/reference/functions/getEnvDefaults.md +19 -0
- package/docs/reference/functions/getScriptDirectory.md +19 -0
- package/docs/reference/functions/initialiseLocales.md +2 -0
- package/docs/reference/functions/isAuthEntityStorageRequired.md +20 -0
- package/docs/reference/functions/isAutomationRequired.md +20 -0
- package/docs/reference/functions/isBackgroundTasksRequired.md +20 -0
- package/docs/reference/functions/isFederatedCatalogueRequired.md +20 -0
- package/docs/reference/functions/isImmutableProofRequired.md +20 -0
- package/docs/reference/functions/isRightsManagementRequired.md +23 -0
- package/docs/reference/functions/isTaskSchedulerRequired.md +20 -0
- package/docs/reference/functions/isTelemetryRequired.md +20 -0
- package/docs/reference/functions/isTrustRequired.md +20 -0
- package/docs/reference/functions/loadJsonFile.md +1 -1
- package/docs/reference/functions/loadTextFile.md +1 -1
- package/docs/reference/functions/parseCommandLineArgs.md +19 -0
- package/docs/reference/functions/processEnvOptions.md +27 -0
- package/docs/reference/functions/registerCommands.md +9 -0
- package/docs/reference/functions/resolvePackageEntryPoint.md +2 -2
- package/docs/reference/functions/run.md +8 -2
- package/docs/reference/functions/shutdownExtensions.md +1 -1
- package/docs/reference/functions/start.md +9 -3
- package/docs/reference/functions/substituteEnvOptions.md +25 -0
- package/docs/reference/index.md +24 -14
- package/docs/reference/interfaces/ICacheMetadata.md +3 -3
- package/docs/reference/interfaces/ICliArgs.md +35 -0
- package/docs/reference/interfaces/ICliCommand.md +23 -0
- package/docs/reference/interfaces/ICliCommandDefinition.md +101 -0
- package/docs/reference/interfaces/ICliCommandDefinitionParam.md +65 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +488 -359
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +652 -431
- package/docs/reference/interfaces/IModuleProtocol.md +3 -3
- package/docs/reference/interfaces/INodeEngineState.md +6 -21
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +661 -516
- package/docs/reference/interfaces/INodeOptions.md +44 -36
- package/docs/reference/interfaces/IProtocolHandlerResult.md +2 -2
- package/docs/reference/type-aliases/CliCommandParamType.md +5 -0
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +3 -1
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +3 -1
- package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +3 -1
- package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +3 -1
- package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +2 -0
- package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +2 -0
- package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +2 -0
- package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md +2 -0
- package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md +2 -0
- package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +2 -0
- package/docs/reference/variables/ModuleProtocol.md +5 -5
- package/docs/reference/variables/TRUST_VERIFICATION_METHOD_ID.md +5 -0
- package/locales/en.json +674 -30
- package/package.json +10 -6
- package/dist/es/bootstrap.js +0 -366
- package/dist/es/bootstrap.js.map +0 -1
- package/dist/es/identity.js +0 -182
- package/dist/es/identity.js.map +0 -1
- package/dist/es/models/nodeExtensionMethods.js +0 -2
- package/dist/es/models/nodeExtensionMethods.js.map +0 -1
- package/dist/es/models/nodeFeatures.js +0 -21
- package/dist/es/models/nodeFeatures.js.map +0 -1
- package/dist/es/server.js +0 -81
- package/dist/es/server.js.map +0 -1
- package/dist/types/bootstrap.d.ts +0 -68
- package/dist/types/identity.d.ts +0 -14
- package/dist/types/models/nodeExtensionMethods.d.ts +0 -27
- package/dist/types/models/nodeFeatures.d.ts +0 -21
- package/docs/detailed-guide.md +0 -129
- package/docs/reference/functions/bootstrap.md +0 -29
- package/docs/reference/functions/bootstrapAuth.md +0 -35
- package/docs/reference/functions/bootstrapBlobEncryption.md +0 -35
- package/docs/reference/functions/bootstrapImmutableProofMethod.md +0 -35
- package/docs/reference/functions/bootstrapNodeAdminUser.md +0 -35
- package/docs/reference/functions/bootstrapNodeId.md +0 -35
- package/docs/reference/functions/bootstrapSynchronisedStorage.md +0 -35
- package/docs/reference/functions/bootstrapTenantId.md +0 -35
- package/docs/reference/functions/getFeatures.md +0 -19
- package/docs/reference/type-aliases/NodeFeatures.md +0 -5
- package/docs/reference/variables/NodeFeatures.md +0 -25
- package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +0 -3
- package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +0 -3
|
@@ -12,9 +12,9 @@ The engine server environment variables.
|
|
|
12
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
15
|
-
### debug?
|
|
15
|
+
### debug? {#debug}
|
|
16
16
|
|
|
17
|
-
> `optional` **debug
|
|
17
|
+
> `optional` **debug?**: `string`
|
|
18
18
|
|
|
19
19
|
Start the engine in debug mode.
|
|
20
20
|
|
|
@@ -24,69 +24,57 @@ Start the engine in debug mode.
|
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
27
|
-
###
|
|
27
|
+
### silent? {#silent}
|
|
28
28
|
|
|
29
|
-
> `optional` **
|
|
29
|
+
> `optional` **silent?**: `string`
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Start the engine in silent mode.
|
|
32
32
|
|
|
33
33
|
#### Inherited from
|
|
34
34
|
|
|
35
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
35
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`silent`](IEngineEnvironmentVariables.md#silent)
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
###
|
|
39
|
+
### storageFileRoot? {#storagefileroot}
|
|
40
40
|
|
|
41
|
-
> `optional` **
|
|
41
|
+
> `optional` **storageFileRoot?**: `string`
|
|
42
42
|
|
|
43
|
-
The
|
|
44
|
-
|
|
45
|
-
#### Inherited from
|
|
46
|
-
|
|
47
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
|
|
48
|
-
|
|
49
|
-
***
|
|
50
|
-
|
|
51
|
-
### tenantEnabled?
|
|
52
|
-
|
|
53
|
-
> `optional` **tenantEnabled**: `string`
|
|
54
|
-
|
|
55
|
-
Is multi-tenant support enabled, defaults to false.
|
|
43
|
+
The root directory for storing items like state file.
|
|
56
44
|
|
|
57
45
|
#### Inherited from
|
|
58
46
|
|
|
59
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
47
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
|
|
60
48
|
|
|
61
49
|
***
|
|
62
50
|
|
|
63
|
-
###
|
|
51
|
+
### stateFilename? {#statefilename}
|
|
64
52
|
|
|
65
|
-
> `optional` **
|
|
53
|
+
> `optional` **stateFilename?**: `string`
|
|
66
54
|
|
|
67
|
-
|
|
55
|
+
The name of the state file.
|
|
68
56
|
|
|
69
57
|
#### Inherited from
|
|
70
58
|
|
|
71
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
59
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
|
|
72
60
|
|
|
73
61
|
***
|
|
74
62
|
|
|
75
|
-
###
|
|
63
|
+
### tenantEnabled? {#tenantenabled}
|
|
76
64
|
|
|
77
|
-
> `optional` **
|
|
65
|
+
> `optional` **tenantEnabled?**: `string`
|
|
78
66
|
|
|
79
|
-
|
|
67
|
+
Is multi-tenant support enabled, defaults to false.
|
|
80
68
|
|
|
81
69
|
#### Inherited from
|
|
82
70
|
|
|
83
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
71
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`tenantEnabled`](IEngineEnvironmentVariables.md#tenantenabled)
|
|
84
72
|
|
|
85
73
|
***
|
|
86
74
|
|
|
87
|
-
### entityStorageConnectorType?
|
|
75
|
+
### entityStorageConnectorType? {#entitystorageconnectortype}
|
|
88
76
|
|
|
89
|
-
> `optional` **entityStorageConnectorType
|
|
77
|
+
> `optional` **entityStorageConnectorType?**: `string`
|
|
90
78
|
|
|
91
79
|
The type of the entity storage to create, comma separate for more than one connector.
|
|
92
80
|
values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
|
|
@@ -97,9 +85,9 @@ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, m
|
|
|
97
85
|
|
|
98
86
|
***
|
|
99
87
|
|
|
100
|
-
### entityStorageConnectorDefault?
|
|
88
|
+
### entityStorageConnectorDefault? {#entitystorageconnectordefault}
|
|
101
89
|
|
|
102
|
-
> `optional` **entityStorageConnectorDefault
|
|
90
|
+
> `optional` **entityStorageConnectorDefault?**: `string`
|
|
103
91
|
|
|
104
92
|
The default entity storage connector to use, defaults to the first one in the list.
|
|
105
93
|
|
|
@@ -109,9 +97,9 @@ The default entity storage connector to use, defaults to the first one in the li
|
|
|
109
97
|
|
|
110
98
|
***
|
|
111
99
|
|
|
112
|
-
### entityStorageTablePrefix?
|
|
100
|
+
### entityStorageTablePrefix? {#entitystoragetableprefix}
|
|
113
101
|
|
|
114
|
-
> `optional` **entityStorageTablePrefix
|
|
102
|
+
> `optional` **entityStorageTablePrefix?**: `string`
|
|
115
103
|
|
|
116
104
|
A prefix for all the table in entity-storage, can be empty.
|
|
117
105
|
|
|
@@ -121,9 +109,9 @@ A prefix for all the table in entity-storage, can be empty.
|
|
|
121
109
|
|
|
122
110
|
***
|
|
123
111
|
|
|
124
|
-
### awsDynamodbAuthMode?
|
|
112
|
+
### awsDynamodbAuthMode? {#awsdynamodbauthmode}
|
|
125
113
|
|
|
126
|
-
> `optional` **awsDynamodbAuthMode
|
|
114
|
+
> `optional` **awsDynamodbAuthMode?**: `string`
|
|
127
115
|
|
|
128
116
|
AWS DynamoDB auth mode, either credentials or pod.
|
|
129
117
|
|
|
@@ -133,9 +121,9 @@ AWS DynamoDB auth mode, either credentials or pod.
|
|
|
133
121
|
|
|
134
122
|
***
|
|
135
123
|
|
|
136
|
-
### awsDynamodbAccessKeyId?
|
|
124
|
+
### awsDynamodbAccessKeyId? {#awsdynamodbaccesskeyid}
|
|
137
125
|
|
|
138
|
-
> `optional` **awsDynamodbAccessKeyId
|
|
126
|
+
> `optional` **awsDynamodbAccessKeyId?**: `string`
|
|
139
127
|
|
|
140
128
|
AWS Dynamo DB access key id.
|
|
141
129
|
|
|
@@ -145,9 +133,9 @@ AWS Dynamo DB access key id.
|
|
|
145
133
|
|
|
146
134
|
***
|
|
147
135
|
|
|
148
|
-
### awsDynamodbEndpoint?
|
|
136
|
+
### awsDynamodbEndpoint? {#awsdynamodbendpoint}
|
|
149
137
|
|
|
150
|
-
> `optional` **awsDynamodbEndpoint
|
|
138
|
+
> `optional` **awsDynamodbEndpoint?**: `string`
|
|
151
139
|
|
|
152
140
|
AWS Dynamo DB Endpoint if running local instance.
|
|
153
141
|
|
|
@@ -157,9 +145,9 @@ AWS Dynamo DB Endpoint if running local instance.
|
|
|
157
145
|
|
|
158
146
|
***
|
|
159
147
|
|
|
160
|
-
### awsDynamodbRegion?
|
|
148
|
+
### awsDynamodbRegion? {#awsdynamodbregion}
|
|
161
149
|
|
|
162
|
-
> `optional` **awsDynamodbRegion
|
|
150
|
+
> `optional` **awsDynamodbRegion?**: `string`
|
|
163
151
|
|
|
164
152
|
AWS Dynamo DB region.
|
|
165
153
|
|
|
@@ -169,9 +157,9 @@ AWS Dynamo DB region.
|
|
|
169
157
|
|
|
170
158
|
***
|
|
171
159
|
|
|
172
|
-
### awsDynamodbSecretAccessKey?
|
|
160
|
+
### awsDynamodbSecretAccessKey? {#awsdynamodbsecretaccesskey}
|
|
173
161
|
|
|
174
|
-
> `optional` **awsDynamodbSecretAccessKey
|
|
162
|
+
> `optional` **awsDynamodbSecretAccessKey?**: `string`
|
|
175
163
|
|
|
176
164
|
AWS Dynamo DB secret access key.
|
|
177
165
|
|
|
@@ -181,9 +169,9 @@ AWS Dynamo DB secret access key.
|
|
|
181
169
|
|
|
182
170
|
***
|
|
183
171
|
|
|
184
|
-
### awsDynamodbConnectionTimeoutMs?
|
|
172
|
+
### awsDynamodbConnectionTimeoutMs? {#awsdynamodbconnectiontimeoutms}
|
|
185
173
|
|
|
186
|
-
> `optional` **awsDynamodbConnectionTimeoutMs
|
|
174
|
+
> `optional` **awsDynamodbConnectionTimeoutMs?**: `string`
|
|
187
175
|
|
|
188
176
|
AWS Dynamo DB connection timeout.
|
|
189
177
|
|
|
@@ -193,9 +181,9 @@ AWS Dynamo DB connection timeout.
|
|
|
193
181
|
|
|
194
182
|
***
|
|
195
183
|
|
|
196
|
-
### azureCosmosdbKey?
|
|
184
|
+
### azureCosmosdbKey? {#azurecosmosdbkey}
|
|
197
185
|
|
|
198
|
-
> `optional` **azureCosmosdbKey
|
|
186
|
+
> `optional` **azureCosmosdbKey?**: `string`
|
|
199
187
|
|
|
200
188
|
Azure Cosmos DB key.
|
|
201
189
|
|
|
@@ -205,9 +193,9 @@ Azure Cosmos DB key.
|
|
|
205
193
|
|
|
206
194
|
***
|
|
207
195
|
|
|
208
|
-
### azureCosmosdbContainerId?
|
|
196
|
+
### azureCosmosdbContainerId? {#azurecosmosdbcontainerid}
|
|
209
197
|
|
|
210
|
-
> `optional` **azureCosmosdbContainerId
|
|
198
|
+
> `optional` **azureCosmosdbContainerId?**: `string`
|
|
211
199
|
|
|
212
200
|
Azure Cosmos DB container id.
|
|
213
201
|
|
|
@@ -217,9 +205,9 @@ Azure Cosmos DB container id.
|
|
|
217
205
|
|
|
218
206
|
***
|
|
219
207
|
|
|
220
|
-
### azureCosmosdbDatabaseId?
|
|
208
|
+
### azureCosmosdbDatabaseId? {#azurecosmosdbdatabaseid}
|
|
221
209
|
|
|
222
|
-
> `optional` **azureCosmosdbDatabaseId
|
|
210
|
+
> `optional` **azureCosmosdbDatabaseId?**: `string`
|
|
223
211
|
|
|
224
212
|
Azure Cosmos DB database id.
|
|
225
213
|
|
|
@@ -229,9 +217,9 @@ Azure Cosmos DB database id.
|
|
|
229
217
|
|
|
230
218
|
***
|
|
231
219
|
|
|
232
|
-
### azureCosmosdbEndpoint?
|
|
220
|
+
### azureCosmosdbEndpoint? {#azurecosmosdbendpoint}
|
|
233
221
|
|
|
234
|
-
> `optional` **azureCosmosdbEndpoint
|
|
222
|
+
> `optional` **azureCosmosdbEndpoint?**: `string`
|
|
235
223
|
|
|
236
224
|
Azure Cosmos DB endpoint.
|
|
237
225
|
|
|
@@ -241,9 +229,9 @@ Azure Cosmos DB endpoint.
|
|
|
241
229
|
|
|
242
230
|
***
|
|
243
231
|
|
|
244
|
-
### gcpFirestoreCollectionName?
|
|
232
|
+
### gcpFirestoreCollectionName? {#gcpfirestorecollectionname}
|
|
245
233
|
|
|
246
|
-
> `optional` **gcpFirestoreCollectionName
|
|
234
|
+
> `optional` **gcpFirestoreCollectionName?**: `string`
|
|
247
235
|
|
|
248
236
|
GCP Firestore collection name.
|
|
249
237
|
|
|
@@ -253,9 +241,9 @@ GCP Firestore collection name.
|
|
|
253
241
|
|
|
254
242
|
***
|
|
255
243
|
|
|
256
|
-
### gcpFirestoreCredentials?
|
|
244
|
+
### gcpFirestoreCredentials? {#gcpfirestorecredentials}
|
|
257
245
|
|
|
258
|
-
> `optional` **gcpFirestoreCredentials
|
|
246
|
+
> `optional` **gcpFirestoreCredentials?**: `string`
|
|
259
247
|
|
|
260
248
|
GCP Firestore credentials.
|
|
261
249
|
|
|
@@ -265,9 +253,9 @@ GCP Firestore credentials.
|
|
|
265
253
|
|
|
266
254
|
***
|
|
267
255
|
|
|
268
|
-
### gcpFirestoreDatabaseId?
|
|
256
|
+
### gcpFirestoreDatabaseId? {#gcpfirestoredatabaseid}
|
|
269
257
|
|
|
270
|
-
> `optional` **gcpFirestoreDatabaseId
|
|
258
|
+
> `optional` **gcpFirestoreDatabaseId?**: `string`
|
|
271
259
|
|
|
272
260
|
GCP Firestore database id.
|
|
273
261
|
|
|
@@ -277,21 +265,21 @@ GCP Firestore database id.
|
|
|
277
265
|
|
|
278
266
|
***
|
|
279
267
|
|
|
280
|
-
###
|
|
268
|
+
### gcpFirestoreEndpoint? {#gcpfirestoreendpoint}
|
|
281
269
|
|
|
282
|
-
> `optional` **
|
|
270
|
+
> `optional` **gcpFirestoreEndpoint?**: `string`
|
|
283
271
|
|
|
284
272
|
GCP Firestore endpoint.
|
|
285
273
|
|
|
286
274
|
#### Inherited from
|
|
287
275
|
|
|
288
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
276
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreEndpoint`](IEngineEnvironmentVariables.md#gcpfirestoreendpoint)
|
|
289
277
|
|
|
290
278
|
***
|
|
291
279
|
|
|
292
|
-
### gcpFirestoreProjectId?
|
|
280
|
+
### gcpFirestoreProjectId? {#gcpfirestoreprojectid}
|
|
293
281
|
|
|
294
|
-
> `optional` **gcpFirestoreProjectId
|
|
282
|
+
> `optional` **gcpFirestoreProjectId?**: `string`
|
|
295
283
|
|
|
296
284
|
GCP Firestore project id.
|
|
297
285
|
|
|
@@ -301,9 +289,9 @@ GCP Firestore project id.
|
|
|
301
289
|
|
|
302
290
|
***
|
|
303
291
|
|
|
304
|
-
### scylladbHosts?
|
|
292
|
+
### scylladbHosts? {#scylladbhosts}
|
|
305
293
|
|
|
306
|
-
> `optional` **scylladbHosts
|
|
294
|
+
> `optional` **scylladbHosts?**: `string`
|
|
307
295
|
|
|
308
296
|
ScyllaDB hosts as comma separated string.
|
|
309
297
|
|
|
@@ -313,9 +301,9 @@ ScyllaDB hosts as comma separated string.
|
|
|
313
301
|
|
|
314
302
|
***
|
|
315
303
|
|
|
316
|
-
### scylladbKeyspace?
|
|
304
|
+
### scylladbKeyspace? {#scylladbkeyspace}
|
|
317
305
|
|
|
318
|
-
> `optional` **scylladbKeyspace
|
|
306
|
+
> `optional` **scylladbKeyspace?**: `string`
|
|
319
307
|
|
|
320
308
|
ScyllaDB keyspace.
|
|
321
309
|
|
|
@@ -325,9 +313,9 @@ ScyllaDB keyspace.
|
|
|
325
313
|
|
|
326
314
|
***
|
|
327
315
|
|
|
328
|
-
### scylladbLocalDataCenter?
|
|
316
|
+
### scylladbLocalDataCenter? {#scylladblocaldatacenter}
|
|
329
317
|
|
|
330
|
-
> `optional` **scylladbLocalDataCenter
|
|
318
|
+
> `optional` **scylladbLocalDataCenter?**: `string`
|
|
331
319
|
|
|
332
320
|
ScyllaDB local data center.
|
|
333
321
|
|
|
@@ -337,9 +325,9 @@ ScyllaDB local data center.
|
|
|
337
325
|
|
|
338
326
|
***
|
|
339
327
|
|
|
340
|
-
### scylladbPort?
|
|
328
|
+
### scylladbPort? {#scylladbport}
|
|
341
329
|
|
|
342
|
-
> `optional` **scylladbPort
|
|
330
|
+
> `optional` **scylladbPort?**: `string`
|
|
343
331
|
|
|
344
332
|
ScyllaDB port.
|
|
345
333
|
|
|
@@ -349,9 +337,9 @@ ScyllaDB port.
|
|
|
349
337
|
|
|
350
338
|
***
|
|
351
339
|
|
|
352
|
-
### mySqlHost?
|
|
340
|
+
### mySqlHost? {#mysqlhost}
|
|
353
341
|
|
|
354
|
-
> `optional` **mySqlHost
|
|
342
|
+
> `optional` **mySqlHost?**: `string`
|
|
355
343
|
|
|
356
344
|
MySQL host.
|
|
357
345
|
|
|
@@ -361,9 +349,9 @@ MySQL host.
|
|
|
361
349
|
|
|
362
350
|
***
|
|
363
351
|
|
|
364
|
-
### mySqlPort?
|
|
352
|
+
### mySqlPort? {#mysqlport}
|
|
365
353
|
|
|
366
|
-
> `optional` **mySqlPort
|
|
354
|
+
> `optional` **mySqlPort?**: `number`
|
|
367
355
|
|
|
368
356
|
MySQL port.
|
|
369
357
|
|
|
@@ -373,9 +361,9 @@ MySQL port.
|
|
|
373
361
|
|
|
374
362
|
***
|
|
375
363
|
|
|
376
|
-
### mySqlUser?
|
|
364
|
+
### mySqlUser? {#mysqluser}
|
|
377
365
|
|
|
378
|
-
> `optional` **mySqlUser
|
|
366
|
+
> `optional` **mySqlUser?**: `string`
|
|
379
367
|
|
|
380
368
|
MySQL username.
|
|
381
369
|
|
|
@@ -385,9 +373,9 @@ MySQL username.
|
|
|
385
373
|
|
|
386
374
|
***
|
|
387
375
|
|
|
388
|
-
### mySqlPassword?
|
|
376
|
+
### mySqlPassword? {#mysqlpassword}
|
|
389
377
|
|
|
390
|
-
> `optional` **mySqlPassword
|
|
378
|
+
> `optional` **mySqlPassword?**: `string`
|
|
391
379
|
|
|
392
380
|
MySQL password.
|
|
393
381
|
|
|
@@ -397,9 +385,9 @@ MySQL password.
|
|
|
397
385
|
|
|
398
386
|
***
|
|
399
387
|
|
|
400
|
-
### mySqlDatabase?
|
|
388
|
+
### mySqlDatabase? {#mysqldatabase}
|
|
401
389
|
|
|
402
|
-
> `optional` **mySqlDatabase
|
|
390
|
+
> `optional` **mySqlDatabase?**: `string`
|
|
403
391
|
|
|
404
392
|
MySQL Database.
|
|
405
393
|
|
|
@@ -409,9 +397,9 @@ MySQL Database.
|
|
|
409
397
|
|
|
410
398
|
***
|
|
411
399
|
|
|
412
|
-
### mongoDbHost?
|
|
400
|
+
### mongoDbHost? {#mongodbhost}
|
|
413
401
|
|
|
414
|
-
> `optional` **mongoDbHost
|
|
402
|
+
> `optional` **mongoDbHost?**: `string`
|
|
415
403
|
|
|
416
404
|
MongoDB host.
|
|
417
405
|
|
|
@@ -421,9 +409,9 @@ MongoDB host.
|
|
|
421
409
|
|
|
422
410
|
***
|
|
423
411
|
|
|
424
|
-
### mongoDbPort?
|
|
412
|
+
### mongoDbPort? {#mongodbport}
|
|
425
413
|
|
|
426
|
-
> `optional` **mongoDbPort
|
|
414
|
+
> `optional` **mongoDbPort?**: `number`
|
|
427
415
|
|
|
428
416
|
MongoDB port.
|
|
429
417
|
|
|
@@ -433,9 +421,9 @@ MongoDB port.
|
|
|
433
421
|
|
|
434
422
|
***
|
|
435
423
|
|
|
436
|
-
### mongoDbUser?
|
|
424
|
+
### mongoDbUser? {#mongodbuser}
|
|
437
425
|
|
|
438
|
-
> `optional` **mongoDbUser
|
|
426
|
+
> `optional` **mongoDbUser?**: `string`
|
|
439
427
|
|
|
440
428
|
MongoDB username.
|
|
441
429
|
|
|
@@ -445,9 +433,9 @@ MongoDB username.
|
|
|
445
433
|
|
|
446
434
|
***
|
|
447
435
|
|
|
448
|
-
### mongoDbPassword?
|
|
436
|
+
### mongoDbPassword? {#mongodbpassword}
|
|
449
437
|
|
|
450
|
-
> `optional` **mongoDbPassword
|
|
438
|
+
> `optional` **mongoDbPassword?**: `string`
|
|
451
439
|
|
|
452
440
|
MongoDB password.
|
|
453
441
|
|
|
@@ -457,9 +445,9 @@ MongoDB password.
|
|
|
457
445
|
|
|
458
446
|
***
|
|
459
447
|
|
|
460
|
-
### mongoDbDatabase?
|
|
448
|
+
### mongoDbDatabase? {#mongodbdatabase}
|
|
461
449
|
|
|
462
|
-
> `optional` **mongoDbDatabase
|
|
450
|
+
> `optional` **mongoDbDatabase?**: `string`
|
|
463
451
|
|
|
464
452
|
MongoDB Database.
|
|
465
453
|
|
|
@@ -469,9 +457,9 @@ MongoDB Database.
|
|
|
469
457
|
|
|
470
458
|
***
|
|
471
459
|
|
|
472
|
-
### postgreSqlHost?
|
|
460
|
+
### postgreSqlHost? {#postgresqlhost}
|
|
473
461
|
|
|
474
|
-
> `optional` **postgreSqlHost
|
|
462
|
+
> `optional` **postgreSqlHost?**: `string`
|
|
475
463
|
|
|
476
464
|
PostgreSQl host.
|
|
477
465
|
|
|
@@ -481,9 +469,9 @@ PostgreSQl host.
|
|
|
481
469
|
|
|
482
470
|
***
|
|
483
471
|
|
|
484
|
-
### postgreSqlPort?
|
|
472
|
+
### postgreSqlPort? {#postgresqlport}
|
|
485
473
|
|
|
486
|
-
> `optional` **postgreSqlPort
|
|
474
|
+
> `optional` **postgreSqlPort?**: `number`
|
|
487
475
|
|
|
488
476
|
PostgreSQl port.
|
|
489
477
|
|
|
@@ -493,9 +481,9 @@ PostgreSQl port.
|
|
|
493
481
|
|
|
494
482
|
***
|
|
495
483
|
|
|
496
|
-
### postgreSqlUser?
|
|
484
|
+
### postgreSqlUser? {#postgresqluser}
|
|
497
485
|
|
|
498
|
-
> `optional` **postgreSqlUser
|
|
486
|
+
> `optional` **postgreSqlUser?**: `string`
|
|
499
487
|
|
|
500
488
|
PostgreSQl username.
|
|
501
489
|
|
|
@@ -505,9 +493,9 @@ PostgreSQl username.
|
|
|
505
493
|
|
|
506
494
|
***
|
|
507
495
|
|
|
508
|
-
### postgreSqlPassword?
|
|
496
|
+
### postgreSqlPassword? {#postgresqlpassword}
|
|
509
497
|
|
|
510
|
-
> `optional` **postgreSqlPassword
|
|
498
|
+
> `optional` **postgreSqlPassword?**: `string`
|
|
511
499
|
|
|
512
500
|
PostgreSQl password.
|
|
513
501
|
|
|
@@ -517,9 +505,9 @@ PostgreSQl password.
|
|
|
517
505
|
|
|
518
506
|
***
|
|
519
507
|
|
|
520
|
-
### postgreSqlDatabase?
|
|
508
|
+
### postgreSqlDatabase? {#postgresqldatabase}
|
|
521
509
|
|
|
522
|
-
> `optional` **postgreSqlDatabase
|
|
510
|
+
> `optional` **postgreSqlDatabase?**: `string`
|
|
523
511
|
|
|
524
512
|
PostgreSQl Database.
|
|
525
513
|
|
|
@@ -529,9 +517,9 @@ PostgreSQl Database.
|
|
|
529
517
|
|
|
530
518
|
***
|
|
531
519
|
|
|
532
|
-
### ipfsBearerToken?
|
|
520
|
+
### ipfsBearerToken? {#ipfsbearertoken}
|
|
533
521
|
|
|
534
|
-
> `optional` **ipfsBearerToken
|
|
522
|
+
> `optional` **ipfsBearerToken?**: `string`
|
|
535
523
|
|
|
536
524
|
The security token for accessing IPFS API.
|
|
537
525
|
|
|
@@ -541,9 +529,9 @@ The security token for accessing IPFS API.
|
|
|
541
529
|
|
|
542
530
|
***
|
|
543
531
|
|
|
544
|
-
### ipfsApiUrl?
|
|
532
|
+
### ipfsApiUrl? {#ipfsapiurl}
|
|
545
533
|
|
|
546
|
-
> `optional` **ipfsApiUrl
|
|
534
|
+
> `optional` **ipfsApiUrl?**: `string`
|
|
547
535
|
|
|
548
536
|
The url for accessing IPFS API.
|
|
549
537
|
|
|
@@ -553,9 +541,9 @@ The url for accessing IPFS API.
|
|
|
553
541
|
|
|
554
542
|
***
|
|
555
543
|
|
|
556
|
-
### blobStorageConnectorType?
|
|
544
|
+
### blobStorageConnectorType? {#blobstorageconnectortype}
|
|
557
545
|
|
|
558
|
-
> `optional` **blobStorageConnectorType
|
|
546
|
+
> `optional` **blobStorageConnectorType?**: `string`
|
|
559
547
|
|
|
560
548
|
The type of the entity storage to create, comma separate for more than one connector.
|
|
561
549
|
values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
|
|
@@ -566,9 +554,9 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
|
|
|
566
554
|
|
|
567
555
|
***
|
|
568
556
|
|
|
569
|
-
### blobStorageConnectorDefault?
|
|
557
|
+
### blobStorageConnectorDefault? {#blobstorageconnectordefault}
|
|
570
558
|
|
|
571
|
-
> `optional` **blobStorageConnectorDefault
|
|
559
|
+
> `optional` **blobStorageConnectorDefault?**: `string`
|
|
572
560
|
|
|
573
561
|
The default blob storage connector to use, defaults to the first one in the list.
|
|
574
562
|
|
|
@@ -578,21 +566,9 @@ The default blob storage connector to use, defaults to the first one in the list
|
|
|
578
566
|
|
|
579
567
|
***
|
|
580
568
|
|
|
581
|
-
###
|
|
582
|
-
|
|
583
|
-
> `optional` **blobStorageConnectorPublic**: `string`
|
|
584
|
-
|
|
585
|
-
Blog storage connector which has public access.
|
|
586
|
-
|
|
587
|
-
#### Inherited from
|
|
588
|
-
|
|
589
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineEnvironmentVariables.md#blobstorageconnectorpublic)
|
|
590
|
-
|
|
591
|
-
***
|
|
592
|
-
|
|
593
|
-
### blobStorageEnableEncryption?
|
|
569
|
+
### blobStorageEnableEncryption? {#blobstorageenableencryption}
|
|
594
570
|
|
|
595
|
-
> `optional` **blobStorageEnableEncryption
|
|
571
|
+
> `optional` **blobStorageEnableEncryption?**: `string`
|
|
596
572
|
|
|
597
573
|
Enable encryption for the blob storage.
|
|
598
574
|
|
|
@@ -602,9 +578,9 @@ Enable encryption for the blob storage.
|
|
|
602
578
|
|
|
603
579
|
***
|
|
604
580
|
|
|
605
|
-
### blobStorageEncryptionKeyId?
|
|
581
|
+
### blobStorageEncryptionKeyId? {#blobstorageencryptionkeyid}
|
|
606
582
|
|
|
607
|
-
> `optional` **blobStorageEncryptionKeyId
|
|
583
|
+
> `optional` **blobStorageEncryptionKeyId?**: `string`
|
|
608
584
|
|
|
609
585
|
The id of the encryption key for the blob storage.
|
|
610
586
|
|
|
@@ -614,22 +590,9 @@ The id of the encryption key for the blob storage.
|
|
|
614
590
|
|
|
615
591
|
***
|
|
616
592
|
|
|
617
|
-
###
|
|
618
|
-
|
|
619
|
-
> `optional` **blobStorageSymmetricEncryptionKey**: `string`
|
|
593
|
+
### blobStoragePrefix? {#blobstorageprefix}
|
|
620
594
|
|
|
621
|
-
|
|
622
|
-
If encryption is enabled but a key is not provided one will be generated.
|
|
623
|
-
|
|
624
|
-
#### Inherited from
|
|
625
|
-
|
|
626
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
|
|
627
|
-
|
|
628
|
-
***
|
|
629
|
-
|
|
630
|
-
### blobStoragePrefix?
|
|
631
|
-
|
|
632
|
-
> `optional` **blobStoragePrefix**: `string`
|
|
595
|
+
> `optional` **blobStoragePrefix?**: `string`
|
|
633
596
|
|
|
634
597
|
A prefix for all the blobs in blob-storage, can be empty.
|
|
635
598
|
|
|
@@ -639,9 +602,9 @@ A prefix for all the blobs in blob-storage, can be empty.
|
|
|
639
602
|
|
|
640
603
|
***
|
|
641
604
|
|
|
642
|
-
### awsS3Region?
|
|
605
|
+
### awsS3Region? {#awss3region}
|
|
643
606
|
|
|
644
|
-
> `optional` **awsS3Region
|
|
607
|
+
> `optional` **awsS3Region?**: `string`
|
|
645
608
|
|
|
646
609
|
AWS S3 region.
|
|
647
610
|
|
|
@@ -651,9 +614,9 @@ AWS S3 region.
|
|
|
651
614
|
|
|
652
615
|
***
|
|
653
616
|
|
|
654
|
-
### awsS3BucketName?
|
|
617
|
+
### awsS3BucketName? {#awss3bucketname}
|
|
655
618
|
|
|
656
|
-
> `optional` **awsS3BucketName
|
|
619
|
+
> `optional` **awsS3BucketName?**: `string`
|
|
657
620
|
|
|
658
621
|
AWS S3 bucket name.
|
|
659
622
|
|
|
@@ -663,9 +626,9 @@ AWS S3 bucket name.
|
|
|
663
626
|
|
|
664
627
|
***
|
|
665
628
|
|
|
666
|
-
### awsS3AuthMode?
|
|
629
|
+
### awsS3AuthMode? {#awss3authmode}
|
|
667
630
|
|
|
668
|
-
> `optional` **awsS3AuthMode
|
|
631
|
+
> `optional` **awsS3AuthMode?**: `string`
|
|
669
632
|
|
|
670
633
|
AWS S3 auth mode, either credentials or pod, defaults to credentials.
|
|
671
634
|
|
|
@@ -675,9 +638,9 @@ AWS S3 auth mode, either credentials or pod, defaults to credentials.
|
|
|
675
638
|
|
|
676
639
|
***
|
|
677
640
|
|
|
678
|
-
### awsS3AccessKeyId?
|
|
641
|
+
### awsS3AccessKeyId? {#awss3accesskeyid}
|
|
679
642
|
|
|
680
|
-
> `optional` **awsS3AccessKeyId
|
|
643
|
+
> `optional` **awsS3AccessKeyId?**: `string`
|
|
681
644
|
|
|
682
645
|
AWS S3 access key id.
|
|
683
646
|
|
|
@@ -687,9 +650,9 @@ AWS S3 access key id.
|
|
|
687
650
|
|
|
688
651
|
***
|
|
689
652
|
|
|
690
|
-
### awsS3SecretAccessKey?
|
|
653
|
+
### awsS3SecretAccessKey? {#awss3secretaccesskey}
|
|
691
654
|
|
|
692
|
-
> `optional` **awsS3SecretAccessKey
|
|
655
|
+
> `optional` **awsS3SecretAccessKey?**: `string`
|
|
693
656
|
|
|
694
657
|
AWS S3 secret access key.
|
|
695
658
|
|
|
@@ -699,9 +662,9 @@ AWS S3 secret access key.
|
|
|
699
662
|
|
|
700
663
|
***
|
|
701
664
|
|
|
702
|
-
### awsS3Endpoint?
|
|
665
|
+
### awsS3Endpoint? {#awss3endpoint}
|
|
703
666
|
|
|
704
|
-
> `optional` **awsS3Endpoint
|
|
667
|
+
> `optional` **awsS3Endpoint?**: `string`
|
|
705
668
|
|
|
706
669
|
AWS S3 endpoint.
|
|
707
670
|
|
|
@@ -711,9 +674,9 @@ AWS S3 endpoint.
|
|
|
711
674
|
|
|
712
675
|
***
|
|
713
676
|
|
|
714
|
-
### azureStorageAccountKey?
|
|
677
|
+
### azureStorageAccountKey? {#azurestorageaccountkey}
|
|
715
678
|
|
|
716
|
-
> `optional` **azureStorageAccountKey
|
|
679
|
+
> `optional` **azureStorageAccountKey?**: `string`
|
|
717
680
|
|
|
718
681
|
Azure Storage account key.
|
|
719
682
|
|
|
@@ -723,9 +686,9 @@ Azure Storage account key.
|
|
|
723
686
|
|
|
724
687
|
***
|
|
725
688
|
|
|
726
|
-
### azureStorageAccountName?
|
|
689
|
+
### azureStorageAccountName? {#azurestorageaccountname}
|
|
727
690
|
|
|
728
|
-
> `optional` **azureStorageAccountName
|
|
691
|
+
> `optional` **azureStorageAccountName?**: `string`
|
|
729
692
|
|
|
730
693
|
Azure Storage account name.
|
|
731
694
|
|
|
@@ -735,9 +698,9 @@ Azure Storage account name.
|
|
|
735
698
|
|
|
736
699
|
***
|
|
737
700
|
|
|
738
|
-
### azureStorageContainerName?
|
|
701
|
+
### azureStorageContainerName? {#azurestoragecontainername}
|
|
739
702
|
|
|
740
|
-
> `optional` **azureStorageContainerName
|
|
703
|
+
> `optional` **azureStorageContainerName?**: `string`
|
|
741
704
|
|
|
742
705
|
Azure Storage container.
|
|
743
706
|
|
|
@@ -747,9 +710,9 @@ Azure Storage container.
|
|
|
747
710
|
|
|
748
711
|
***
|
|
749
712
|
|
|
750
|
-
### azureStorageEndpoint?
|
|
713
|
+
### azureStorageEndpoint? {#azurestorageendpoint}
|
|
751
714
|
|
|
752
|
-
> `optional` **azureStorageEndpoint
|
|
715
|
+
> `optional` **azureStorageEndpoint?**: `string`
|
|
753
716
|
|
|
754
717
|
Azure Storage endpoint.
|
|
755
718
|
|
|
@@ -759,9 +722,9 @@ Azure Storage endpoint.
|
|
|
759
722
|
|
|
760
723
|
***
|
|
761
724
|
|
|
762
|
-
### gcpStorageBucketName?
|
|
725
|
+
### gcpStorageBucketName? {#gcpstoragebucketname}
|
|
763
726
|
|
|
764
|
-
> `optional` **gcpStorageBucketName
|
|
727
|
+
> `optional` **gcpStorageBucketName?**: `string`
|
|
765
728
|
|
|
766
729
|
GCP Storage bucket.
|
|
767
730
|
|
|
@@ -771,9 +734,9 @@ GCP Storage bucket.
|
|
|
771
734
|
|
|
772
735
|
***
|
|
773
736
|
|
|
774
|
-
### gcpStorageCredentials?
|
|
737
|
+
### gcpStorageCredentials? {#gcpstoragecredentials}
|
|
775
738
|
|
|
776
|
-
> `optional` **gcpStorageCredentials
|
|
739
|
+
> `optional` **gcpStorageCredentials?**: `string`
|
|
777
740
|
|
|
778
741
|
GCP Storage credentials.
|
|
779
742
|
|
|
@@ -783,9 +746,9 @@ GCP Storage credentials.
|
|
|
783
746
|
|
|
784
747
|
***
|
|
785
748
|
|
|
786
|
-
### gcpStorageEndpoint?
|
|
749
|
+
### gcpStorageEndpoint? {#gcpstorageendpoint}
|
|
787
750
|
|
|
788
|
-
> `optional` **gcpStorageEndpoint
|
|
751
|
+
> `optional` **gcpStorageEndpoint?**: `string`
|
|
789
752
|
|
|
790
753
|
GCP Storage endpoint.
|
|
791
754
|
|
|
@@ -795,9 +758,9 @@ GCP Storage endpoint.
|
|
|
795
758
|
|
|
796
759
|
***
|
|
797
760
|
|
|
798
|
-
### gcpStorageProjectId?
|
|
761
|
+
### gcpStorageProjectId? {#gcpstorageprojectid}
|
|
799
762
|
|
|
800
|
-
> `optional` **gcpStorageProjectId
|
|
763
|
+
> `optional` **gcpStorageProjectId?**: `string`
|
|
801
764
|
|
|
802
765
|
GCP Storage project id.
|
|
803
766
|
|
|
@@ -807,9 +770,9 @@ GCP Storage project id.
|
|
|
807
770
|
|
|
808
771
|
***
|
|
809
772
|
|
|
810
|
-
### vaultConnector?
|
|
773
|
+
### vaultConnector? {#vaultconnector}
|
|
811
774
|
|
|
812
|
-
> `optional` **vaultConnector
|
|
775
|
+
> `optional` **vaultConnector?**: `string`
|
|
813
776
|
|
|
814
777
|
The type of the default vault connector: entity-storage, hashicorp.
|
|
815
778
|
|
|
@@ -819,9 +782,21 @@ The type of the default vault connector: entity-storage, hashicorp.
|
|
|
819
782
|
|
|
820
783
|
***
|
|
821
784
|
|
|
822
|
-
###
|
|
785
|
+
### vaultPrefix? {#vaultprefix}
|
|
786
|
+
|
|
787
|
+
> `optional` **vaultPrefix?**: `string`
|
|
788
|
+
|
|
789
|
+
Prefix to prepend to entries in the vault.
|
|
790
|
+
|
|
791
|
+
#### Inherited from
|
|
792
|
+
|
|
793
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultPrefix`](IEngineEnvironmentVariables.md#vaultprefix)
|
|
794
|
+
|
|
795
|
+
***
|
|
796
|
+
|
|
797
|
+
### hashicorpVaultToken? {#hashicorpvaulttoken}
|
|
823
798
|
|
|
824
|
-
> `optional` **hashicorpVaultToken
|
|
799
|
+
> `optional` **hashicorpVaultToken?**: `string`
|
|
825
800
|
|
|
826
801
|
Hashicorp Vault token.
|
|
827
802
|
|
|
@@ -831,9 +806,9 @@ Hashicorp Vault token.
|
|
|
831
806
|
|
|
832
807
|
***
|
|
833
808
|
|
|
834
|
-
### hashicorpVaultEndpoint?
|
|
809
|
+
### hashicorpVaultEndpoint? {#hashicorpvaultendpoint}
|
|
835
810
|
|
|
836
|
-
> `optional` **hashicorpVaultEndpoint
|
|
811
|
+
> `optional` **hashicorpVaultEndpoint?**: `string`
|
|
837
812
|
|
|
838
813
|
Hashicorp Vault endpoint.
|
|
839
814
|
|
|
@@ -843,9 +818,9 @@ Hashicorp Vault endpoint.
|
|
|
843
818
|
|
|
844
819
|
***
|
|
845
820
|
|
|
846
|
-
### loggingConnector?
|
|
821
|
+
### loggingConnector? {#loggingconnector}
|
|
847
822
|
|
|
848
|
-
> `optional` **loggingConnector
|
|
823
|
+
> `optional` **loggingConnector?**: `string`
|
|
849
824
|
|
|
850
825
|
The type of logging task connector, can be a comma separated list: console, entity-storage.
|
|
851
826
|
|
|
@@ -855,9 +830,45 @@ The type of logging task connector, can be a comma separated list: console, enti
|
|
|
855
830
|
|
|
856
831
|
***
|
|
857
832
|
|
|
858
|
-
###
|
|
833
|
+
### loggingBatchSize? {#loggingbatchsize}
|
|
834
|
+
|
|
835
|
+
> `optional` **loggingBatchSize?**: `string`
|
|
836
|
+
|
|
837
|
+
The batch size for the logging task, set to 1 for no batching.
|
|
838
|
+
|
|
839
|
+
#### Inherited from
|
|
840
|
+
|
|
841
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingBatchSize`](IEngineEnvironmentVariables.md#loggingbatchsize)
|
|
842
|
+
|
|
843
|
+
***
|
|
844
|
+
|
|
845
|
+
### loggingBatchFlushIntervalSeconds? {#loggingbatchflushintervalseconds}
|
|
846
|
+
|
|
847
|
+
> `optional` **loggingBatchFlushIntervalSeconds?**: `string`
|
|
848
|
+
|
|
849
|
+
The batch flush interval in seconds for the logging task, how often to flush the logs when using batching, defaults to 5 seconds.
|
|
850
|
+
|
|
851
|
+
#### Inherited from
|
|
852
|
+
|
|
853
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingBatchFlushIntervalSeconds`](IEngineEnvironmentVariables.md#loggingbatchflushintervalseconds)
|
|
854
|
+
|
|
855
|
+
***
|
|
856
|
+
|
|
857
|
+
### loggingSilentComponents? {#loggingsilentcomponents}
|
|
858
|
+
|
|
859
|
+
> `optional` **loggingSilentComponents?**: `string`
|
|
860
|
+
|
|
861
|
+
A list of components to exclude from logging, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
|
|
862
|
+
|
|
863
|
+
#### Inherited from
|
|
864
|
+
|
|
865
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingSilentComponents`](IEngineEnvironmentVariables.md#loggingsilentcomponents)
|
|
866
|
+
|
|
867
|
+
***
|
|
868
|
+
|
|
869
|
+
### eventBusConnector? {#eventbusconnector}
|
|
859
870
|
|
|
860
|
-
> `optional` **eventBusConnector
|
|
871
|
+
> `optional` **eventBusConnector?**: `string`
|
|
861
872
|
|
|
862
873
|
The type of event bus connector: local.
|
|
863
874
|
|
|
@@ -867,9 +878,9 @@ The type of event bus connector: local.
|
|
|
867
878
|
|
|
868
879
|
***
|
|
869
880
|
|
|
870
|
-
### eventBusComponent?
|
|
881
|
+
### eventBusComponent? {#eventbuscomponent}
|
|
871
882
|
|
|
872
|
-
> `optional` **eventBusComponent
|
|
883
|
+
> `optional` **eventBusComponent?**: `string`
|
|
873
884
|
|
|
874
885
|
The type of event bus component: service.
|
|
875
886
|
|
|
@@ -879,9 +890,9 @@ The type of event bus component: service.
|
|
|
879
890
|
|
|
880
891
|
***
|
|
881
892
|
|
|
882
|
-
### messagingEnabled?
|
|
893
|
+
### messagingEnabled? {#messagingenabled}
|
|
883
894
|
|
|
884
|
-
> `optional` **messagingEnabled
|
|
895
|
+
> `optional` **messagingEnabled?**: `string`
|
|
885
896
|
|
|
886
897
|
Are the messaging components enabled, defaults to false.
|
|
887
898
|
|
|
@@ -891,9 +902,9 @@ Are the messaging components enabled, defaults to false.
|
|
|
891
902
|
|
|
892
903
|
***
|
|
893
904
|
|
|
894
|
-
### awsSesRegion?
|
|
905
|
+
### awsSesRegion? {#awssesregion}
|
|
895
906
|
|
|
896
|
-
> `optional` **awsSesRegion
|
|
907
|
+
> `optional` **awsSesRegion?**: `string`
|
|
897
908
|
|
|
898
909
|
AWS SES region.
|
|
899
910
|
|
|
@@ -903,9 +914,9 @@ AWS SES region.
|
|
|
903
914
|
|
|
904
915
|
***
|
|
905
916
|
|
|
906
|
-
### awsSesAuthMode?
|
|
917
|
+
### awsSesAuthMode? {#awssesauthmode}
|
|
907
918
|
|
|
908
|
-
> `optional` **awsSesAuthMode
|
|
919
|
+
> `optional` **awsSesAuthMode?**: `string`
|
|
909
920
|
|
|
910
921
|
AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
911
922
|
|
|
@@ -915,9 +926,9 @@ AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
|
915
926
|
|
|
916
927
|
***
|
|
917
928
|
|
|
918
|
-
### awsSesSecretAccessKey?
|
|
929
|
+
### awsSesSecretAccessKey? {#awssessecretaccesskey}
|
|
919
930
|
|
|
920
|
-
> `optional` **awsSesSecretAccessKey
|
|
931
|
+
> `optional` **awsSesSecretAccessKey?**: `string`
|
|
921
932
|
|
|
922
933
|
AWS SES secret access key.
|
|
923
934
|
|
|
@@ -927,9 +938,9 @@ AWS SES secret access key.
|
|
|
927
938
|
|
|
928
939
|
***
|
|
929
940
|
|
|
930
|
-
### awsSesAccessKeyId?
|
|
941
|
+
### awsSesAccessKeyId? {#awssesaccesskeyid}
|
|
931
942
|
|
|
932
|
-
> `optional` **awsSesAccessKeyId
|
|
943
|
+
> `optional` **awsSesAccessKeyId?**: `string`
|
|
933
944
|
|
|
934
945
|
AWS SES access key id.
|
|
935
946
|
|
|
@@ -939,9 +950,9 @@ AWS SES access key id.
|
|
|
939
950
|
|
|
940
951
|
***
|
|
941
952
|
|
|
942
|
-
### awsSesEndpoint?
|
|
953
|
+
### awsSesEndpoint? {#awssesendpoint}
|
|
943
954
|
|
|
944
|
-
> `optional` **awsSesEndpoint
|
|
955
|
+
> `optional` **awsSesEndpoint?**: `string`
|
|
945
956
|
|
|
946
957
|
AWS SES endpoint.
|
|
947
958
|
|
|
@@ -951,11 +962,11 @@ AWS SES endpoint.
|
|
|
951
962
|
|
|
952
963
|
***
|
|
953
964
|
|
|
954
|
-
### awsMessagingPushNotificationApplications?
|
|
965
|
+
### awsMessagingPushNotificationApplications? {#awsmessagingpushnotificationapplications}
|
|
955
966
|
|
|
956
|
-
> `optional` **awsMessagingPushNotificationApplications
|
|
967
|
+
> `optional` **awsMessagingPushNotificationApplications?**: `string`
|
|
957
968
|
|
|
958
|
-
The applications for the push notifications
|
|
969
|
+
The applications for the push notifications reference a separate json with @json: prefix.
|
|
959
970
|
|
|
960
971
|
#### Inherited from
|
|
961
972
|
|
|
@@ -963,9 +974,9 @@ The applications for the push notifications JSON stringified array of IAwsApplic
|
|
|
963
974
|
|
|
964
975
|
***
|
|
965
976
|
|
|
966
|
-
### messagingEmailConnector?
|
|
977
|
+
### messagingEmailConnector? {#messagingemailconnector}
|
|
967
978
|
|
|
968
|
-
> `optional` **messagingEmailConnector
|
|
979
|
+
> `optional` **messagingEmailConnector?**: `string`
|
|
969
980
|
|
|
970
981
|
The type of messaging email connector: entity-storage, aws.
|
|
971
982
|
|
|
@@ -975,9 +986,9 @@ The type of messaging email connector: entity-storage, aws.
|
|
|
975
986
|
|
|
976
987
|
***
|
|
977
988
|
|
|
978
|
-
### messagingSmsConnector?
|
|
989
|
+
### messagingSmsConnector? {#messagingsmsconnector}
|
|
979
990
|
|
|
980
|
-
> `optional` **messagingSmsConnector
|
|
991
|
+
> `optional` **messagingSmsConnector?**: `string`
|
|
981
992
|
|
|
982
993
|
The type of messaging sms connector: entity-storage, aws.
|
|
983
994
|
|
|
@@ -987,9 +998,9 @@ The type of messaging sms connector: entity-storage, aws.
|
|
|
987
998
|
|
|
988
999
|
***
|
|
989
1000
|
|
|
990
|
-
### messagingPushNotificationConnector?
|
|
1001
|
+
### messagingPushNotificationConnector? {#messagingpushnotificationconnector}
|
|
991
1002
|
|
|
992
|
-
> `optional` **messagingPushNotificationConnector
|
|
1003
|
+
> `optional` **messagingPushNotificationConnector?**: `string`
|
|
993
1004
|
|
|
994
1005
|
The type of messaging push notification connector: entity-storage, aws.
|
|
995
1006
|
|
|
@@ -999,9 +1010,9 @@ The type of messaging push notification connector: entity-storage, aws.
|
|
|
999
1010
|
|
|
1000
1011
|
***
|
|
1001
1012
|
|
|
1002
|
-
### telemetryConnector?
|
|
1013
|
+
### telemetryConnector? {#telemetryconnector}
|
|
1003
1014
|
|
|
1004
|
-
> `optional` **telemetryConnector
|
|
1015
|
+
> `optional` **telemetryConnector?**: `string`
|
|
1005
1016
|
|
|
1006
1017
|
The type of telemetry connector: entity-storage.
|
|
1007
1018
|
|
|
@@ -1011,9 +1022,93 @@ The type of telemetry connector: entity-storage.
|
|
|
1011
1022
|
|
|
1012
1023
|
***
|
|
1013
1024
|
|
|
1014
|
-
###
|
|
1025
|
+
### openTelemetryMeterName? {#opentelemetrymetername}
|
|
1026
|
+
|
|
1027
|
+
> `optional` **openTelemetryMeterName?**: `string`
|
|
1028
|
+
|
|
1029
|
+
The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.
|
|
1015
1030
|
|
|
1016
|
-
|
|
1031
|
+
#### Inherited from
|
|
1032
|
+
|
|
1033
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterName`](IEngineEnvironmentVariables.md#opentelemetrymetername)
|
|
1034
|
+
|
|
1035
|
+
***
|
|
1036
|
+
|
|
1037
|
+
### openTelemetryMeterVersion? {#opentelemetrymeterversion}
|
|
1038
|
+
|
|
1039
|
+
> `optional` **openTelemetryMeterVersion?**: `string`
|
|
1040
|
+
|
|
1041
|
+
The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.
|
|
1042
|
+
|
|
1043
|
+
#### Inherited from
|
|
1044
|
+
|
|
1045
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterVersion`](IEngineEnvironmentVariables.md#opentelemetrymeterversion)
|
|
1046
|
+
|
|
1047
|
+
***
|
|
1048
|
+
|
|
1049
|
+
### openTelemetryReader? {#opentelemetryreader}
|
|
1050
|
+
|
|
1051
|
+
> `optional` **openTelemetryReader?**: `string`
|
|
1052
|
+
|
|
1053
|
+
The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.
|
|
1054
|
+
|
|
1055
|
+
#### Inherited from
|
|
1056
|
+
|
|
1057
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryReader`](IEngineEnvironmentVariables.md#opentelemetryreader)
|
|
1058
|
+
|
|
1059
|
+
***
|
|
1060
|
+
|
|
1061
|
+
### openTelemetryPrometheusPort? {#opentelemetryprometheusport}
|
|
1062
|
+
|
|
1063
|
+
> `optional` **openTelemetryPrometheusPort?**: `string`
|
|
1064
|
+
|
|
1065
|
+
The port to use for the Open Telemetry Prometheus metrics server, only required if using open-telemetry as telemetry connector and prometheus as reader, defaults to 9464.
|
|
1066
|
+
|
|
1067
|
+
#### Inherited from
|
|
1068
|
+
|
|
1069
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryPrometheusPort`](IEngineEnvironmentVariables.md#opentelemetryprometheusport)
|
|
1070
|
+
|
|
1071
|
+
***
|
|
1072
|
+
|
|
1073
|
+
### telemetryMetricsCollectorIntervalSeconds? {#telemetrymetricscollectorintervalseconds}
|
|
1074
|
+
|
|
1075
|
+
> `optional` **telemetryMetricsCollectorIntervalSeconds?**: `string`
|
|
1076
|
+
|
|
1077
|
+
Polling interval in seconds for the telemetry metrics collector. Defaults to 60.
|
|
1078
|
+
|
|
1079
|
+
#### Inherited from
|
|
1080
|
+
|
|
1081
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsCollectorIntervalSeconds`](IEngineEnvironmentVariables.md#telemetrymetricscollectorintervalseconds)
|
|
1082
|
+
|
|
1083
|
+
***
|
|
1084
|
+
|
|
1085
|
+
### telemetryMetricsProducers? {#telemetrymetricsproducers}
|
|
1086
|
+
|
|
1087
|
+
> `optional` **telemetryMetricsProducers?**: `string`
|
|
1088
|
+
|
|
1089
|
+
The type of telemetry metrics producers, can be a comma separated list: system, process.
|
|
1090
|
+
|
|
1091
|
+
#### Inherited from
|
|
1092
|
+
|
|
1093
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducers`](IEngineEnvironmentVariables.md#telemetrymetricsproducers)
|
|
1094
|
+
|
|
1095
|
+
***
|
|
1096
|
+
|
|
1097
|
+
### telemetryMetricsProducerMaxHistory? {#telemetrymetricsproducermaxhistory}
|
|
1098
|
+
|
|
1099
|
+
> `optional` **telemetryMetricsProducerMaxHistory?**: `string`
|
|
1100
|
+
|
|
1101
|
+
Maximum number of values retained per telemetry metric (count-based history cap). Defaults to 1440.
|
|
1102
|
+
|
|
1103
|
+
#### Inherited from
|
|
1104
|
+
|
|
1105
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryMetricsProducerMaxHistory`](IEngineEnvironmentVariables.md#telemetrymetricsproducermaxhistory)
|
|
1106
|
+
|
|
1107
|
+
***
|
|
1108
|
+
|
|
1109
|
+
### faucetConnector? {#faucetconnector}
|
|
1110
|
+
|
|
1111
|
+
> `optional` **faucetConnector?**: `string`
|
|
1017
1112
|
|
|
1018
1113
|
The type of faucet connector: entity-storage, iota.
|
|
1019
1114
|
|
|
@@ -1023,9 +1118,9 @@ The type of faucet connector: entity-storage, iota.
|
|
|
1023
1118
|
|
|
1024
1119
|
***
|
|
1025
1120
|
|
|
1026
|
-
### walletConnector?
|
|
1121
|
+
### walletConnector? {#walletconnector}
|
|
1027
1122
|
|
|
1028
|
-
> `optional` **walletConnector
|
|
1123
|
+
> `optional` **walletConnector?**: `string`
|
|
1029
1124
|
|
|
1030
1125
|
The type of wallet connector: entity-storage, iota.
|
|
1031
1126
|
|
|
@@ -1035,9 +1130,9 @@ The type of wallet connector: entity-storage, iota.
|
|
|
1035
1130
|
|
|
1036
1131
|
***
|
|
1037
1132
|
|
|
1038
|
-
### nftConnector?
|
|
1133
|
+
### nftConnector? {#nftconnector}
|
|
1039
1134
|
|
|
1040
|
-
> `optional` **nftConnector
|
|
1135
|
+
> `optional` **nftConnector?**: `string`
|
|
1041
1136
|
|
|
1042
1137
|
The type of NFT connector: entity-storage, iota.
|
|
1043
1138
|
|
|
@@ -1047,9 +1142,33 @@ The type of NFT connector: entity-storage, iota.
|
|
|
1047
1142
|
|
|
1048
1143
|
***
|
|
1049
1144
|
|
|
1050
|
-
###
|
|
1145
|
+
### nftPackageId? {#nftpackageid}
|
|
1146
|
+
|
|
1147
|
+
> `optional` **nftPackageId?**: `string`
|
|
1148
|
+
|
|
1149
|
+
The NFT deployed package id, for custom deployments.
|
|
1051
1150
|
|
|
1052
|
-
|
|
1151
|
+
#### Inherited from
|
|
1152
|
+
|
|
1153
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nftPackageId`](IEngineEnvironmentVariables.md#nftpackageid)
|
|
1154
|
+
|
|
1155
|
+
***
|
|
1156
|
+
|
|
1157
|
+
### notarizationConnector? {#notarizationconnector}
|
|
1158
|
+
|
|
1159
|
+
> `optional` **notarizationConnector?**: `string`
|
|
1160
|
+
|
|
1161
|
+
The type of notarization connector: entity-storage, iota.
|
|
1162
|
+
|
|
1163
|
+
#### Inherited from
|
|
1164
|
+
|
|
1165
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`notarizationConnector`](IEngineEnvironmentVariables.md#notarizationconnector)
|
|
1166
|
+
|
|
1167
|
+
***
|
|
1168
|
+
|
|
1169
|
+
### identityConnector? {#identityconnector}
|
|
1170
|
+
|
|
1171
|
+
> `optional` **identityConnector?**: `string`
|
|
1053
1172
|
|
|
1054
1173
|
The type of identity connector: entity-storage, iota.
|
|
1055
1174
|
|
|
@@ -1059,33 +1178,33 @@ The type of identity connector: entity-storage, iota.
|
|
|
1059
1178
|
|
|
1060
1179
|
***
|
|
1061
1180
|
|
|
1062
|
-
###
|
|
1181
|
+
### identityWalletAddressIndex? {#identitywalletaddressindex}
|
|
1063
1182
|
|
|
1064
|
-
> `optional` **
|
|
1183
|
+
> `optional` **identityWalletAddressIndex?**: `string`
|
|
1065
1184
|
|
|
1066
|
-
The
|
|
1185
|
+
The index of the wallet address to use, defaults to 0.
|
|
1067
1186
|
|
|
1068
1187
|
#### Inherited from
|
|
1069
1188
|
|
|
1070
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1189
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineEnvironmentVariables.md#identitywalletaddressindex)
|
|
1071
1190
|
|
|
1072
1191
|
***
|
|
1073
1192
|
|
|
1074
|
-
###
|
|
1193
|
+
### identityResolverConnector? {#identityresolverconnector}
|
|
1075
1194
|
|
|
1076
|
-
> `optional` **
|
|
1195
|
+
> `optional` **identityResolverConnector?**: `string`
|
|
1077
1196
|
|
|
1078
|
-
The type of
|
|
1197
|
+
The type of identity resolver connector: entity-storage, iota.
|
|
1079
1198
|
|
|
1080
1199
|
#### Inherited from
|
|
1081
1200
|
|
|
1082
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1201
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityResolverConnector`](IEngineEnvironmentVariables.md#identityresolverconnector)
|
|
1083
1202
|
|
|
1084
1203
|
***
|
|
1085
1204
|
|
|
1086
|
-
### iotaFaucetEndpoint?
|
|
1205
|
+
### iotaFaucetEndpoint? {#iotafaucetendpoint}
|
|
1087
1206
|
|
|
1088
|
-
> `optional` **iotaFaucetEndpoint
|
|
1207
|
+
> `optional` **iotaFaucetEndpoint?**: `string`
|
|
1089
1208
|
|
|
1090
1209
|
IOTA Faucet Endpoint.
|
|
1091
1210
|
|
|
@@ -1095,9 +1214,9 @@ IOTA Faucet Endpoint.
|
|
|
1095
1214
|
|
|
1096
1215
|
***
|
|
1097
1216
|
|
|
1098
|
-
### iotaNodeEndpoint?
|
|
1217
|
+
### iotaNodeEndpoint? {#iotanodeendpoint}
|
|
1099
1218
|
|
|
1100
|
-
> `optional` **iotaNodeEndpoint
|
|
1219
|
+
> `optional` **iotaNodeEndpoint?**: `string`
|
|
1101
1220
|
|
|
1102
1221
|
IOTA Node Endpoint.
|
|
1103
1222
|
|
|
@@ -1107,9 +1226,9 @@ IOTA Node Endpoint.
|
|
|
1107
1226
|
|
|
1108
1227
|
***
|
|
1109
1228
|
|
|
1110
|
-
### iotaNetwork?
|
|
1229
|
+
### iotaNetwork? {#iotanetwork}
|
|
1111
1230
|
|
|
1112
|
-
> `optional` **iotaNetwork
|
|
1231
|
+
> `optional` **iotaNetwork?**: `string`
|
|
1113
1232
|
|
|
1114
1233
|
IOTA network.
|
|
1115
1234
|
|
|
@@ -1119,9 +1238,9 @@ IOTA network.
|
|
|
1119
1238
|
|
|
1120
1239
|
***
|
|
1121
1240
|
|
|
1122
|
-
### iotaCoinType?
|
|
1241
|
+
### iotaCoinType? {#iotacointype}
|
|
1123
1242
|
|
|
1124
|
-
> `optional` **iotaCoinType
|
|
1243
|
+
> `optional` **iotaCoinType?**: `string`
|
|
1125
1244
|
|
|
1126
1245
|
IOTA coin type.
|
|
1127
1246
|
|
|
@@ -1131,9 +1250,9 @@ IOTA coin type.
|
|
|
1131
1250
|
|
|
1132
1251
|
***
|
|
1133
1252
|
|
|
1134
|
-
### iotaExplorerEndpoint?
|
|
1253
|
+
### iotaExplorerEndpoint? {#iotaexplorerendpoint}
|
|
1135
1254
|
|
|
1136
|
-
> `optional` **iotaExplorerEndpoint
|
|
1255
|
+
> `optional` **iotaExplorerEndpoint?**: `string`
|
|
1137
1256
|
|
|
1138
1257
|
IOTA Explorer Endpoint.
|
|
1139
1258
|
|
|
@@ -1143,9 +1262,9 @@ IOTA Explorer Endpoint.
|
|
|
1143
1262
|
|
|
1144
1263
|
***
|
|
1145
1264
|
|
|
1146
|
-
### iotaGasStationEndpoint?
|
|
1265
|
+
### iotaGasStationEndpoint? {#iotagasstationendpoint}
|
|
1147
1266
|
|
|
1148
|
-
> `optional` **iotaGasStationEndpoint
|
|
1267
|
+
> `optional` **iotaGasStationEndpoint?**: `string`
|
|
1149
1268
|
|
|
1150
1269
|
IOTA Gas Station Endpoint.
|
|
1151
1270
|
|
|
@@ -1155,9 +1274,9 @@ IOTA Gas Station Endpoint.
|
|
|
1155
1274
|
|
|
1156
1275
|
***
|
|
1157
1276
|
|
|
1158
|
-
### iotaGasStationAuthToken?
|
|
1277
|
+
### iotaGasStationAuthToken? {#iotagasstationauthtoken}
|
|
1159
1278
|
|
|
1160
|
-
> `optional` **iotaGasStationAuthToken
|
|
1279
|
+
> `optional` **iotaGasStationAuthToken?**: `string`
|
|
1161
1280
|
|
|
1162
1281
|
IOTA Gas Station Authentication Token.
|
|
1163
1282
|
|
|
@@ -1167,9 +1286,21 @@ IOTA Gas Station Authentication Token.
|
|
|
1167
1286
|
|
|
1168
1287
|
***
|
|
1169
1288
|
|
|
1170
|
-
###
|
|
1289
|
+
### iotaIdentityPackageId? {#iotaidentitypackageid}
|
|
1290
|
+
|
|
1291
|
+
> `optional` **iotaIdentityPackageId?**: `string`
|
|
1171
1292
|
|
|
1172
|
-
|
|
1293
|
+
The IOTA Identity deployed package id, for custom deployments.
|
|
1294
|
+
|
|
1295
|
+
#### Inherited from
|
|
1296
|
+
|
|
1297
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaIdentityPackageId`](IEngineEnvironmentVariables.md#iotaidentitypackageid)
|
|
1298
|
+
|
|
1299
|
+
***
|
|
1300
|
+
|
|
1301
|
+
### universalResolverEndpoint? {#universalresolverendpoint}
|
|
1302
|
+
|
|
1303
|
+
> `optional` **universalResolverEndpoint?**: `string`
|
|
1173
1304
|
|
|
1174
1305
|
Universal Resolver Endpoint.
|
|
1175
1306
|
|
|
@@ -1179,9 +1310,9 @@ Universal Resolver Endpoint.
|
|
|
1179
1310
|
|
|
1180
1311
|
***
|
|
1181
1312
|
|
|
1182
|
-
### identityProfileConnector?
|
|
1313
|
+
### identityProfileConnector? {#identityprofileconnector}
|
|
1183
1314
|
|
|
1184
|
-
> `optional` **identityProfileConnector
|
|
1315
|
+
> `optional` **identityProfileConnector?**: `string`
|
|
1185
1316
|
|
|
1186
1317
|
The type of identity profile connector: entity-storage.
|
|
1187
1318
|
|
|
@@ -1191,9 +1322,9 @@ The type of identity profile connector: entity-storage.
|
|
|
1191
1322
|
|
|
1192
1323
|
***
|
|
1193
1324
|
|
|
1194
|
-
### immutableProofVerificationMethodId?
|
|
1325
|
+
### immutableProofVerificationMethodId? {#immutableproofverificationmethodid}
|
|
1195
1326
|
|
|
1196
|
-
> `optional` **immutableProofVerificationMethodId
|
|
1327
|
+
> `optional` **immutableProofVerificationMethodId?**: `string`
|
|
1197
1328
|
|
|
1198
1329
|
The identity verification method id to use with immutable proofs.
|
|
1199
1330
|
|
|
@@ -1203,9 +1334,9 @@ The identity verification method id to use with immutable proofs.
|
|
|
1203
1334
|
|
|
1204
1335
|
***
|
|
1205
1336
|
|
|
1206
|
-
### attestationConnector?
|
|
1337
|
+
### attestationConnector? {#attestationconnector}
|
|
1207
1338
|
|
|
1208
|
-
> `optional` **attestationConnector
|
|
1339
|
+
> `optional` **attestationConnector?**: `string`
|
|
1209
1340
|
|
|
1210
1341
|
The type of attestation connector: entity-storage, iota.
|
|
1211
1342
|
|
|
@@ -1215,9 +1346,9 @@ The type of attestation connector: entity-storage, iota.
|
|
|
1215
1346
|
|
|
1216
1347
|
***
|
|
1217
1348
|
|
|
1218
|
-
### attestationVerificationMethodId?
|
|
1349
|
+
### attestationVerificationMethodId? {#attestationverificationmethodid}
|
|
1219
1350
|
|
|
1220
|
-
> `optional` **attestationVerificationMethodId
|
|
1351
|
+
> `optional` **attestationVerificationMethodId?**: `string`
|
|
1221
1352
|
|
|
1222
1353
|
The identity verification method id to use with attestation.
|
|
1223
1354
|
|
|
@@ -1227,9 +1358,9 @@ The identity verification method id to use with attestation.
|
|
|
1227
1358
|
|
|
1228
1359
|
***
|
|
1229
1360
|
|
|
1230
|
-
### dataProcessingEnabled?
|
|
1361
|
+
### dataProcessingEnabled? {#dataprocessingenabled}
|
|
1231
1362
|
|
|
1232
|
-
> `optional` **dataProcessingEnabled
|
|
1363
|
+
> `optional` **dataProcessingEnabled?**: `string`
|
|
1233
1364
|
|
|
1234
1365
|
Is the data processing enabled, defaults to false.
|
|
1235
1366
|
|
|
@@ -1239,9 +1370,9 @@ Is the data processing enabled, defaults to false.
|
|
|
1239
1370
|
|
|
1240
1371
|
***
|
|
1241
1372
|
|
|
1242
|
-
### dataConverterConnectors?
|
|
1373
|
+
### dataConverterConnectors? {#dataconverterconnectors}
|
|
1243
1374
|
|
|
1244
|
-
> `optional` **dataConverterConnectors
|
|
1375
|
+
> `optional` **dataConverterConnectors?**: `string`
|
|
1245
1376
|
|
|
1246
1377
|
The type of the default data converters, can be a comma separated list: json, xml.
|
|
1247
1378
|
|
|
@@ -1251,9 +1382,9 @@ The type of the default data converters, can be a comma separated list: json, xm
|
|
|
1251
1382
|
|
|
1252
1383
|
***
|
|
1253
1384
|
|
|
1254
|
-
### dataExtractorConnectors?
|
|
1385
|
+
### dataExtractorConnectors? {#dataextractorconnectors}
|
|
1255
1386
|
|
|
1256
|
-
> `optional` **dataExtractorConnectors
|
|
1387
|
+
> `optional` **dataExtractorConnectors?**: `string`
|
|
1257
1388
|
|
|
1258
1389
|
The type of the default data extractor, can be a comma separated list: json-path.
|
|
1259
1390
|
|
|
@@ -1263,9 +1394,21 @@ The type of the default data extractor, can be a comma separated list: json-path
|
|
|
1263
1394
|
|
|
1264
1395
|
***
|
|
1265
1396
|
|
|
1266
|
-
###
|
|
1397
|
+
### taskSchedulerEnabled? {#taskschedulerenabled}
|
|
1398
|
+
|
|
1399
|
+
> `optional` **taskSchedulerEnabled?**: `string`
|
|
1400
|
+
|
|
1401
|
+
Enable the task scheduler regardless of which other components are active, defaults to false.
|
|
1402
|
+
|
|
1403
|
+
#### Inherited from
|
|
1404
|
+
|
|
1405
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineEnvironmentVariables.md#taskschedulerenabled)
|
|
1406
|
+
|
|
1407
|
+
***
|
|
1408
|
+
|
|
1409
|
+
### auditableItemGraphEnabled? {#auditableitemgraphenabled}
|
|
1267
1410
|
|
|
1268
|
-
> `optional` **auditableItemGraphEnabled
|
|
1411
|
+
> `optional` **auditableItemGraphEnabled?**: `string`
|
|
1269
1412
|
|
|
1270
1413
|
Is the auditable item graph enabled, defaults to false.
|
|
1271
1414
|
|
|
@@ -1275,9 +1418,9 @@ Is the auditable item graph enabled, defaults to false.
|
|
|
1275
1418
|
|
|
1276
1419
|
***
|
|
1277
1420
|
|
|
1278
|
-
### auditableItemStreamEnabled?
|
|
1421
|
+
### auditableItemStreamEnabled? {#auditableitemstreamenabled}
|
|
1279
1422
|
|
|
1280
|
-
> `optional` **auditableItemStreamEnabled
|
|
1423
|
+
> `optional` **auditableItemStreamEnabled?**: `string`
|
|
1281
1424
|
|
|
1282
1425
|
Is the auditable item stream enabled, defaults to false.
|
|
1283
1426
|
|
|
@@ -1287,9 +1430,9 @@ Is the auditable item stream enabled, defaults to false.
|
|
|
1287
1430
|
|
|
1288
1431
|
***
|
|
1289
1432
|
|
|
1290
|
-
### documentManagementEnabled?
|
|
1433
|
+
### documentManagementEnabled? {#documentmanagementenabled}
|
|
1291
1434
|
|
|
1292
|
-
> `optional` **documentManagementEnabled
|
|
1435
|
+
> `optional` **documentManagementEnabled?**: `string`
|
|
1293
1436
|
|
|
1294
1437
|
Is the document management enabled, defaults to false.
|
|
1295
1438
|
|
|
@@ -1299,381 +1442,443 @@ Is the document management enabled, defaults to false.
|
|
|
1299
1442
|
|
|
1300
1443
|
***
|
|
1301
1444
|
|
|
1302
|
-
###
|
|
1445
|
+
### federatedCatalogueEnabled? {#federatedcatalogueenabled}
|
|
1303
1446
|
|
|
1304
|
-
> `optional` **
|
|
1447
|
+
> `optional` **federatedCatalogueEnabled?**: `string`
|
|
1305
1448
|
|
|
1306
|
-
|
|
1449
|
+
Enable the federated catalogue, defaults to false, automatically enabled if remote endpoint, filters or dataspace is enabled.
|
|
1307
1450
|
|
|
1308
1451
|
#### Inherited from
|
|
1309
1452
|
|
|
1310
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1453
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
|
|
1311
1454
|
|
|
1312
1455
|
***
|
|
1313
1456
|
|
|
1314
|
-
###
|
|
1457
|
+
### federatedCatalogueFilters? {#federatedcataloguefilters}
|
|
1315
1458
|
|
|
1316
|
-
> `optional` **
|
|
1459
|
+
> `optional` **federatedCatalogueFilters?**: `string`
|
|
1317
1460
|
|
|
1318
|
-
|
|
1461
|
+
Federated catalog filters, command separated list of filters to add.
|
|
1319
1462
|
|
|
1320
1463
|
#### Inherited from
|
|
1321
1464
|
|
|
1322
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1465
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineEnvironmentVariables.md#federatedcataloguefilters)
|
|
1323
1466
|
|
|
1324
1467
|
***
|
|
1325
1468
|
|
|
1326
|
-
###
|
|
1469
|
+
### federatedCatalogueRemoteEndpoint? {#federatedcatalogueremoteendpoint}
|
|
1327
1470
|
|
|
1328
|
-
> `optional` **
|
|
1471
|
+
> `optional` **federatedCatalogueRemoteEndpoint?**: `string`
|
|
1329
1472
|
|
|
1330
|
-
|
|
1331
|
-
This only required if using a custom verifiable storage item, otherwise it will default to the network name.
|
|
1473
|
+
Federated catalog remote endpoint, if set will use a REST client instead of local service.
|
|
1332
1474
|
|
|
1333
1475
|
#### Inherited from
|
|
1334
1476
|
|
|
1335
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1477
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueRemoteEndpoint`](IEngineEnvironmentVariables.md#federatedcatalogueremoteendpoint)
|
|
1336
1478
|
|
|
1337
1479
|
***
|
|
1338
1480
|
|
|
1339
|
-
###
|
|
1481
|
+
### trustGenerators? {#trustgenerators}
|
|
1340
1482
|
|
|
1341
|
-
> `optional` **
|
|
1483
|
+
> `optional` **trustGenerators?**: `string`
|
|
1342
1484
|
|
|
1343
|
-
The
|
|
1344
|
-
Only required for trusted nodes, as regular nodes will request from the trusted nodes.
|
|
1345
|
-
Defaults to synchronised-storage-blob-encryption
|
|
1485
|
+
The trust generators to add to the factory, comma separated list.
|
|
1346
1486
|
|
|
1347
1487
|
#### Inherited from
|
|
1348
1488
|
|
|
1349
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1489
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustGenerators`](IEngineEnvironmentVariables.md#trustgenerators)
|
|
1350
1490
|
|
|
1351
1491
|
***
|
|
1352
1492
|
|
|
1353
|
-
###
|
|
1493
|
+
### trustVerifiers? {#trustverifiers}
|
|
1354
1494
|
|
|
1355
|
-
> `optional` **
|
|
1495
|
+
> `optional` **trustVerifiers?**: `string`
|
|
1356
1496
|
|
|
1357
|
-
The
|
|
1358
|
-
Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
1497
|
+
The trust verifiers to add to the factory, comma separated list.
|
|
1359
1498
|
|
|
1360
1499
|
#### Inherited from
|
|
1361
1500
|
|
|
1362
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1501
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerifiers`](IEngineEnvironmentVariables.md#trustverifiers)
|
|
1363
1502
|
|
|
1364
1503
|
***
|
|
1365
1504
|
|
|
1366
|
-
###
|
|
1505
|
+
### trustVerificationMethodId? {#trustverificationmethodid}
|
|
1367
1506
|
|
|
1368
|
-
> `optional` **
|
|
1507
|
+
> `optional` **trustVerificationMethodId?**: `string`
|
|
1369
1508
|
|
|
1370
|
-
|
|
1509
|
+
The verification method to use for trust identities.
|
|
1510
|
+
Defaults to trust-assertion.
|
|
1371
1511
|
|
|
1372
|
-
####
|
|
1512
|
+
#### Inherited from
|
|
1373
1513
|
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1514
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineEnvironmentVariables.md#trustverificationmethodid)
|
|
1515
|
+
|
|
1516
|
+
***
|
|
1517
|
+
|
|
1518
|
+
### trustJwtTtlSeconds? {#trustjwtttlseconds}
|
|
1519
|
+
|
|
1520
|
+
> `optional` **trustJwtTtlSeconds?**: `string`
|
|
1521
|
+
|
|
1522
|
+
The trust time to live for generating JWTs.
|
|
1523
|
+
Defaults to undefined for never expiring.
|
|
1377
1524
|
|
|
1378
1525
|
#### Inherited from
|
|
1379
1526
|
|
|
1380
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1527
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustJwtTtlSeconds`](IEngineEnvironmentVariables.md#trustjwtttlseconds)
|
|
1381
1528
|
|
|
1382
1529
|
***
|
|
1383
1530
|
|
|
1384
|
-
###
|
|
1531
|
+
### trustIdentitiesAllow? {#trustidentitiesallow}
|
|
1385
1532
|
|
|
1386
|
-
> `optional` **
|
|
1533
|
+
> `optional` **trustIdentitiesAllow?**: `string`
|
|
1387
1534
|
|
|
1388
|
-
|
|
1535
|
+
The allow lists for the trust identity verifier, comma separated list of identities.
|
|
1389
1536
|
|
|
1390
|
-
####
|
|
1537
|
+
#### Inherited from
|
|
1391
1538
|
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1539
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustIdentitiesAllow`](IEngineEnvironmentVariables.md#trustidentitiesallow)
|
|
1540
|
+
|
|
1541
|
+
***
|
|
1542
|
+
|
|
1543
|
+
### trustIdentitiesDeny? {#trustidentitiesdeny}
|
|
1544
|
+
|
|
1545
|
+
> `optional` **trustIdentitiesDeny?**: `string`
|
|
1546
|
+
|
|
1547
|
+
The deny lists for the trust identity verifier, comma separated list of identities.
|
|
1395
1548
|
|
|
1396
1549
|
#### Inherited from
|
|
1397
1550
|
|
|
1398
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1551
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustIdentitiesDeny`](IEngineEnvironmentVariables.md#trustidentitiesdeny)
|
|
1399
1552
|
|
|
1400
1553
|
***
|
|
1401
1554
|
|
|
1402
|
-
###
|
|
1555
|
+
### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
|
|
1403
1556
|
|
|
1404
|
-
> `optional` **
|
|
1557
|
+
> `optional` **rightsManagementCallbackPath?**: `string`
|
|
1405
1558
|
|
|
1406
|
-
|
|
1559
|
+
Path under which the rights management service is mounted (single source
|
|
1560
|
+
of truth). The same value drives:
|
|
1561
|
+
- the server route mount (via engine config)
|
|
1562
|
+
- the PNP service's callback URL builder (`buildCallbackUrl`)
|
|
1563
|
+
- the PNP rest-client's pathPrefix (consumer side)
|
|
1564
|
+
Defaults to `rights-management`. Set when deploying behind a reverse proxy
|
|
1565
|
+
with path rewriting, K8s ingress with path-based routing, or any custom
|
|
1566
|
+
mount point.
|
|
1407
1567
|
|
|
1408
|
-
####
|
|
1568
|
+
#### Inherited from
|
|
1409
1569
|
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1570
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementCallbackPath`](IEngineEnvironmentVariables.md#rightsmanagementcallbackpath)
|
|
1571
|
+
|
|
1572
|
+
***
|
|
1573
|
+
|
|
1574
|
+
### rightsManagementPolicyInformationSources? {#rightsmanagementpolicyinformationsources}
|
|
1575
|
+
|
|
1576
|
+
> `optional` **rightsManagementPolicyInformationSources?**: `string`
|
|
1577
|
+
|
|
1578
|
+
The rights management policy information sources to add to the factory.
|
|
1413
1579
|
|
|
1414
1580
|
#### Inherited from
|
|
1415
1581
|
|
|
1416
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1582
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
|
|
1417
1583
|
|
|
1418
1584
|
***
|
|
1419
1585
|
|
|
1420
|
-
###
|
|
1586
|
+
### rightsManagementPolicyNegotiators? {#rightsmanagementpolicynegotiators}
|
|
1421
1587
|
|
|
1422
|
-
> `optional` **
|
|
1588
|
+
> `optional` **rightsManagementPolicyNegotiators?**: `string`
|
|
1423
1589
|
|
|
1424
|
-
The
|
|
1590
|
+
The rights management policy negotiators sources to add to the factory.
|
|
1425
1591
|
|
|
1426
|
-
####
|
|
1592
|
+
#### Inherited from
|
|
1427
1593
|
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1594
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineEnvironmentVariables.md#rightsmanagementpolicynegotiators)
|
|
1595
|
+
|
|
1596
|
+
***
|
|
1597
|
+
|
|
1598
|
+
### rightsManagementPolicyRequesters? {#rightsmanagementpolicyrequesters}
|
|
1599
|
+
|
|
1600
|
+
> `optional` **rightsManagementPolicyRequesters?**: `string`
|
|
1601
|
+
|
|
1602
|
+
The rights management policy requesters to add to the factory.
|
|
1431
1603
|
|
|
1432
1604
|
#### Inherited from
|
|
1433
1605
|
|
|
1434
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1606
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyrequesters)
|
|
1435
1607
|
|
|
1436
1608
|
***
|
|
1437
1609
|
|
|
1438
|
-
###
|
|
1610
|
+
### rightsManagementPolicyExecutionActions? {#rightsmanagementpolicyexecutionactions}
|
|
1439
1611
|
|
|
1440
|
-
> `optional` **
|
|
1612
|
+
> `optional` **rightsManagementPolicyExecutionActions?**: `string`
|
|
1441
1613
|
|
|
1442
|
-
|
|
1614
|
+
The rights management policy execution actions to add to the factory.
|
|
1443
1615
|
|
|
1444
1616
|
#### Inherited from
|
|
1445
1617
|
|
|
1446
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1618
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
|
|
1447
1619
|
|
|
1448
1620
|
***
|
|
1449
1621
|
|
|
1450
|
-
###
|
|
1622
|
+
### rightsManagementPolicyEnforcementProcessors? {#rightsmanagementpolicyenforcementprocessors}
|
|
1451
1623
|
|
|
1452
|
-
> `optional` **
|
|
1624
|
+
> `optional` **rightsManagementPolicyEnforcementProcessors?**: `string`
|
|
1453
1625
|
|
|
1454
|
-
|
|
1626
|
+
The rights management policy enforcement processors to add to the factory.
|
|
1455
1627
|
|
|
1456
1628
|
#### Inherited from
|
|
1457
1629
|
|
|
1458
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1630
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
|
|
1459
1631
|
|
|
1460
1632
|
***
|
|
1461
1633
|
|
|
1462
|
-
###
|
|
1634
|
+
### rightsManagementPolicyArbiters? {#rightsmanagementpolicyarbiters}
|
|
1463
1635
|
|
|
1464
|
-
> `optional` **
|
|
1636
|
+
> `optional` **rightsManagementPolicyArbiters?**: `string`
|
|
1465
1637
|
|
|
1466
|
-
|
|
1638
|
+
The rights management policy arbiters to add to the factory.
|
|
1467
1639
|
|
|
1468
1640
|
#### Inherited from
|
|
1469
1641
|
|
|
1470
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1642
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineEnvironmentVariables.md#rightsmanagementpolicyarbiters)
|
|
1471
1643
|
|
|
1472
1644
|
***
|
|
1473
1645
|
|
|
1474
|
-
###
|
|
1646
|
+
### rightsManagementPolicyObligationEnforcers? {#rightsmanagementpolicyobligationenforcers}
|
|
1475
1647
|
|
|
1476
|
-
> `optional` **
|
|
1648
|
+
> `optional` **rightsManagementPolicyObligationEnforcers?**: `string`
|
|
1477
1649
|
|
|
1478
|
-
|
|
1650
|
+
The rights management policy obligation enforcers to add to the factory.
|
|
1479
1651
|
|
|
1480
1652
|
#### Inherited from
|
|
1481
1653
|
|
|
1482
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1654
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementPolicyObligationEnforcers`](IEngineEnvironmentVariables.md#rightsmanagementpolicyobligationenforcers)
|
|
1483
1655
|
|
|
1484
1656
|
***
|
|
1485
1657
|
|
|
1486
|
-
###
|
|
1658
|
+
### dataspaceEnabled? {#dataspaceenabled}
|
|
1487
1659
|
|
|
1488
|
-
> `optional` **
|
|
1660
|
+
> `optional` **dataspaceEnabled?**: `string`
|
|
1489
1661
|
|
|
1490
|
-
|
|
1491
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1662
|
+
Is the dataspace enabled, defaults to false.
|
|
1492
1663
|
|
|
1493
1664
|
#### Inherited from
|
|
1494
1665
|
|
|
1495
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1666
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceEnabled`](IEngineEnvironmentVariables.md#dataspaceenabled)
|
|
1496
1667
|
|
|
1497
1668
|
***
|
|
1498
1669
|
|
|
1499
|
-
###
|
|
1670
|
+
### dataspaceRetainActivityLogsFor? {#dataspaceretainactivitylogsfor}
|
|
1671
|
+
|
|
1672
|
+
> `optional` **dataspaceRetainActivityLogsFor?**: `string`
|
|
1673
|
+
|
|
1674
|
+
The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
|
|
1500
1675
|
|
|
1501
|
-
|
|
1676
|
+
#### Default
|
|
1502
1677
|
|
|
1503
|
-
|
|
1504
|
-
|
|
1678
|
+
```ts
|
|
1679
|
+
10
|
|
1680
|
+
```
|
|
1505
1681
|
|
|
1506
1682
|
#### Inherited from
|
|
1507
1683
|
|
|
1508
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1684
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceretainactivitylogsfor)
|
|
1509
1685
|
|
|
1510
1686
|
***
|
|
1511
1687
|
|
|
1512
|
-
###
|
|
1688
|
+
### dataspaceActivityLogsCleanupInterval? {#dataspaceactivitylogscleanupinterval}
|
|
1513
1689
|
|
|
1514
|
-
> `optional` **
|
|
1690
|
+
> `optional` **dataspaceActivityLogsCleanupInterval?**: `string`
|
|
1515
1691
|
|
|
1516
|
-
The
|
|
1517
|
-
|
|
1692
|
+
The interval for cleaning up the activity logs.
|
|
1693
|
+
|
|
1694
|
+
#### Default
|
|
1695
|
+
|
|
1696
|
+
```ts
|
|
1697
|
+
60
|
|
1698
|
+
```
|
|
1518
1699
|
|
|
1519
1700
|
#### Inherited from
|
|
1520
1701
|
|
|
1521
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1702
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceActivityLogsCleanupInterval`](IEngineEnvironmentVariables.md#dataspaceactivitylogscleanupinterval)
|
|
1522
1703
|
|
|
1523
1704
|
***
|
|
1524
1705
|
|
|
1525
|
-
###
|
|
1706
|
+
### dataspaceDataPlanePath? {#dataspacedataplanepath}
|
|
1526
1707
|
|
|
1527
|
-
> `optional` **
|
|
1708
|
+
> `optional` **dataspaceDataPlanePath?**: `string`
|
|
1528
1709
|
|
|
1529
|
-
The
|
|
1530
|
-
|
|
1710
|
+
The data plane path for PULL transfers (path only, not full URL).
|
|
1711
|
+
Will be combined with public origin.
|
|
1712
|
+
Required if PULL transfers should be supported.
|
|
1713
|
+
Example: "dataspace/entities"
|
|
1531
1714
|
|
|
1532
1715
|
#### Inherited from
|
|
1533
1716
|
|
|
1534
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1717
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataspaceDataPlanePath`](IEngineEnvironmentVariables.md#dataspacedataplanepath)
|
|
1535
1718
|
|
|
1536
1719
|
***
|
|
1537
1720
|
|
|
1538
|
-
###
|
|
1721
|
+
### healthEnabled? {#healthenabled}
|
|
1539
1722
|
|
|
1540
|
-
> `optional` **
|
|
1723
|
+
> `optional` **healthEnabled?**: `string`
|
|
1541
1724
|
|
|
1542
|
-
|
|
1543
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1725
|
+
Are the health components enabled, defaults to false.
|
|
1544
1726
|
|
|
1545
1727
|
#### Inherited from
|
|
1546
1728
|
|
|
1547
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1729
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthEnabled`](IEngineEnvironmentVariables.md#healthenabled)
|
|
1548
1730
|
|
|
1549
1731
|
***
|
|
1550
1732
|
|
|
1551
|
-
###
|
|
1733
|
+
### healthIntervalSeconds? {#healthintervalseconds}
|
|
1552
1734
|
|
|
1553
|
-
> `optional` **
|
|
1735
|
+
> `optional` **healthIntervalSeconds?**: `string`
|
|
1554
1736
|
|
|
1555
|
-
The
|
|
1556
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1737
|
+
The interval in seconds for performing health checks, defaults to 60.
|
|
1557
1738
|
|
|
1558
1739
|
#### Inherited from
|
|
1559
1740
|
|
|
1560
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1741
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthIntervalSeconds`](IEngineEnvironmentVariables.md#healthintervalseconds)
|
|
1561
1742
|
|
|
1562
1743
|
***
|
|
1563
1744
|
|
|
1564
|
-
###
|
|
1745
|
+
### healthStartupIntervalSeconds? {#healthstartupintervalseconds}
|
|
1565
1746
|
|
|
1566
|
-
> `optional` **
|
|
1747
|
+
> `optional` **healthStartupIntervalSeconds?**: `string`
|
|
1567
1748
|
|
|
1568
|
-
The
|
|
1569
|
-
|
|
1749
|
+
The interval in seconds for performing health checks at startup, defaults to 2.
|
|
1750
|
+
This allows components that take a long time to initialize to be healthy before the first health check is performed.
|
|
1570
1751
|
|
|
1571
1752
|
#### Inherited from
|
|
1572
1753
|
|
|
1573
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1754
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthStartupIntervalSeconds`](IEngineEnvironmentVariables.md#healthstartupintervalseconds)
|
|
1574
1755
|
|
|
1575
1756
|
***
|
|
1576
1757
|
|
|
1577
|
-
###
|
|
1758
|
+
### automationActionTypes? {#automationactiontypes}
|
|
1578
1759
|
|
|
1579
|
-
> `optional` **
|
|
1760
|
+
> `optional` **automationActionTypes?**: `string`
|
|
1580
1761
|
|
|
1581
|
-
|
|
1762
|
+
The type of the automation action to create, comma separate for more than one connector.
|
|
1763
|
+
values: fetch
|
|
1582
1764
|
|
|
1583
1765
|
#### Inherited from
|
|
1584
1766
|
|
|
1585
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1767
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`automationActionTypes`](IEngineEnvironmentVariables.md#automationactiontypes)
|
|
1586
1768
|
|
|
1587
1769
|
***
|
|
1588
1770
|
|
|
1589
|
-
###
|
|
1771
|
+
### mutexTimeoutMsDefault? {#mutextimeoutmsdefault}
|
|
1590
1772
|
|
|
1591
|
-
> `optional` **
|
|
1773
|
+
> `optional` **mutexTimeoutMsDefault?**: `string`
|
|
1592
1774
|
|
|
1593
|
-
|
|
1775
|
+
The default mutex timeout in milliseconds, used when no component-specific timeout is set, defaults to 5000.
|
|
1594
1776
|
|
|
1595
1777
|
#### Inherited from
|
|
1596
1778
|
|
|
1597
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1779
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mutexTimeoutMsDefault`](IEngineEnvironmentVariables.md#mutextimeoutmsdefault)
|
|
1598
1780
|
|
|
1599
1781
|
***
|
|
1600
1782
|
|
|
1601
|
-
###
|
|
1783
|
+
### auditableItemGraphMutexTimeoutMs? {#auditableitemgraphmutextimeoutms}
|
|
1602
1784
|
|
|
1603
|
-
> `optional` **
|
|
1785
|
+
> `optional` **auditableItemGraphMutexTimeoutMs?**: `string`
|
|
1604
1786
|
|
|
1605
|
-
|
|
1787
|
+
The mutex timeout in milliseconds for the auditable item graph component.
|
|
1606
1788
|
|
|
1607
1789
|
#### Inherited from
|
|
1608
1790
|
|
|
1609
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1791
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`auditableItemGraphMutexTimeoutMs`](IEngineEnvironmentVariables.md#auditableitemgraphmutextimeoutms)
|
|
1610
1792
|
|
|
1611
1793
|
***
|
|
1612
1794
|
|
|
1613
|
-
###
|
|
1795
|
+
### auditableItemStreamMutexTimeoutMs? {#auditableitemstreammutextimeoutms}
|
|
1614
1796
|
|
|
1615
|
-
> `optional` **
|
|
1797
|
+
> `optional` **auditableItemStreamMutexTimeoutMs?**: `string`
|
|
1616
1798
|
|
|
1617
|
-
The
|
|
1799
|
+
The mutex timeout in milliseconds for the auditable item stream component.
|
|
1618
1800
|
|
|
1619
|
-
####
|
|
1801
|
+
#### Inherited from
|
|
1620
1802
|
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1803
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`auditableItemStreamMutexTimeoutMs`](IEngineEnvironmentVariables.md#auditableitemstreammutextimeoutms)
|
|
1804
|
+
|
|
1805
|
+
***
|
|
1806
|
+
|
|
1807
|
+
### federatedCatalogueMutexTimeoutMs? {#federatedcataloguemutextimeoutms}
|
|
1808
|
+
|
|
1809
|
+
> `optional` **federatedCatalogueMutexTimeoutMs?**: `string`
|
|
1810
|
+
|
|
1811
|
+
The mutex timeout in milliseconds for the federated catalogue component.
|
|
1624
1812
|
|
|
1625
1813
|
#### Inherited from
|
|
1626
1814
|
|
|
1627
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1815
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueMutexTimeoutMs`](IEngineEnvironmentVariables.md#federatedcataloguemutextimeoutms)
|
|
1628
1816
|
|
|
1629
1817
|
***
|
|
1630
1818
|
|
|
1631
|
-
###
|
|
1819
|
+
### documentManagementMutexTimeoutMs? {#documentmanagementmutextimeoutms}
|
|
1632
1820
|
|
|
1633
|
-
> `optional` **
|
|
1821
|
+
> `optional` **documentManagementMutexTimeoutMs?**: `string`
|
|
1634
1822
|
|
|
1635
|
-
The
|
|
1823
|
+
The mutex timeout in milliseconds for the document management component.
|
|
1636
1824
|
|
|
1637
|
-
####
|
|
1825
|
+
#### Inherited from
|
|
1638
1826
|
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1827
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`documentManagementMutexTimeoutMs`](IEngineEnvironmentVariables.md#documentmanagementmutextimeoutms)
|
|
1828
|
+
|
|
1829
|
+
***
|
|
1830
|
+
|
|
1831
|
+
### loggingMutexTimeoutMs? {#loggingmutextimeoutms}
|
|
1832
|
+
|
|
1833
|
+
> `optional` **loggingMutexTimeoutMs?**: `string`
|
|
1834
|
+
|
|
1835
|
+
The mutex timeout in milliseconds for the logging component.
|
|
1836
|
+
|
|
1837
|
+
#### Inherited from
|
|
1838
|
+
|
|
1839
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingMutexTimeoutMs`](IEngineEnvironmentVariables.md#loggingmutextimeoutms)
|
|
1840
|
+
|
|
1841
|
+
***
|
|
1842
|
+
|
|
1843
|
+
### entityStorageMemoryMutexTimeoutMs? {#entitystoragememorymutextimeoutms}
|
|
1844
|
+
|
|
1845
|
+
> `optional` **entityStorageMemoryMutexTimeoutMs?**: `string`
|
|
1846
|
+
|
|
1847
|
+
The mutex timeout in milliseconds for the memory entity storage connector.
|
|
1642
1848
|
|
|
1643
1849
|
#### Inherited from
|
|
1644
1850
|
|
|
1645
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1851
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageMemoryMutexTimeoutMs`](IEngineEnvironmentVariables.md#entitystoragememorymutextimeoutms)
|
|
1646
1852
|
|
|
1647
1853
|
***
|
|
1648
1854
|
|
|
1649
|
-
###
|
|
1855
|
+
### entityStorageFileMutexTimeoutMs? {#entitystoragefilemutextimeoutms}
|
|
1650
1856
|
|
|
1651
|
-
> `optional` **
|
|
1857
|
+
> `optional` **entityStorageFileMutexTimeoutMs?**: `string`
|
|
1652
1858
|
|
|
1653
|
-
|
|
1859
|
+
The mutex timeout in milliseconds for the file entity storage connector.
|
|
1654
1860
|
|
|
1655
1861
|
#### Inherited from
|
|
1656
1862
|
|
|
1657
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1863
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageFileMutexTimeoutMs`](IEngineEnvironmentVariables.md#entitystoragefilemutextimeoutms)
|
|
1658
1864
|
|
|
1659
1865
|
***
|
|
1660
1866
|
|
|
1661
|
-
###
|
|
1867
|
+
### rightsManagementMutexTimeoutMs? {#rightsmanagementmutextimeoutms}
|
|
1662
1868
|
|
|
1663
|
-
> `optional` **
|
|
1869
|
+
> `optional` **rightsManagementMutexTimeoutMs?**: `string`
|
|
1664
1870
|
|
|
1665
|
-
|
|
1666
|
-
Defaults to node-authentication-assertion.
|
|
1871
|
+
The mutex timeout in milliseconds for the rights management component.
|
|
1667
1872
|
|
|
1668
1873
|
#### Inherited from
|
|
1669
1874
|
|
|
1670
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1875
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementMutexTimeoutMs`](IEngineEnvironmentVariables.md#rightsmanagementmutextimeoutms)
|
|
1671
1876
|
|
|
1672
1877
|
***
|
|
1673
1878
|
|
|
1674
|
-
### extensions?
|
|
1879
|
+
### extensions? {#extensions}
|
|
1675
1880
|
|
|
1676
|
-
> `optional` **extensions
|
|
1881
|
+
> `optional` **extensions?**: `string`
|
|
1677
1882
|
|
|
1678
1883
|
A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
|
|
1679
1884
|
|
|
@@ -1683,104 +1888,120 @@ A comma separated list of additional node extensions to load, the initialiseExte
|
|
|
1683
1888
|
|
|
1684
1889
|
***
|
|
1685
1890
|
|
|
1686
|
-
### port?
|
|
1891
|
+
### port? {#port}
|
|
1687
1892
|
|
|
1688
|
-
> `optional` **port
|
|
1893
|
+
> `optional` **port?**: `string`
|
|
1689
1894
|
|
|
1690
1895
|
The port to serve the API from.
|
|
1691
1896
|
|
|
1692
1897
|
***
|
|
1693
1898
|
|
|
1694
|
-
### host?
|
|
1899
|
+
### host? {#host}
|
|
1695
1900
|
|
|
1696
|
-
> `optional` **host
|
|
1901
|
+
> `optional` **host?**: `string`
|
|
1697
1902
|
|
|
1698
1903
|
The host to serve the API from.
|
|
1699
1904
|
|
|
1700
1905
|
***
|
|
1701
1906
|
|
|
1702
|
-
### corsOrigins?
|
|
1907
|
+
### corsOrigins? {#corsorigins}
|
|
1703
1908
|
|
|
1704
|
-
> `optional` **corsOrigins
|
|
1909
|
+
> `optional` **corsOrigins?**: `string`
|
|
1705
1910
|
|
|
1706
1911
|
The CORS origins to allow, defaults to *.
|
|
1707
1912
|
|
|
1708
1913
|
***
|
|
1709
1914
|
|
|
1710
|
-
### httpMethods?
|
|
1915
|
+
### httpMethods? {#httpmethods}
|
|
1711
1916
|
|
|
1712
|
-
> `optional` **httpMethods
|
|
1917
|
+
> `optional` **httpMethods?**: `string`
|
|
1713
1918
|
|
|
1714
1919
|
The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.
|
|
1715
1920
|
|
|
1716
1921
|
***
|
|
1717
1922
|
|
|
1718
|
-
### httpAllowedHeaders?
|
|
1923
|
+
### httpAllowedHeaders? {#httpallowedheaders}
|
|
1719
1924
|
|
|
1720
|
-
> `optional` **httpAllowedHeaders
|
|
1925
|
+
> `optional` **httpAllowedHeaders?**: `string`
|
|
1721
1926
|
|
|
1722
1927
|
The CORS headers to allow.
|
|
1723
1928
|
|
|
1724
1929
|
***
|
|
1725
1930
|
|
|
1726
|
-
### httpExposedHeaders?
|
|
1931
|
+
### httpExposedHeaders? {#httpexposedheaders}
|
|
1727
1932
|
|
|
1728
|
-
> `optional` **httpExposedHeaders
|
|
1933
|
+
> `optional` **httpExposedHeaders?**: `string`
|
|
1729
1934
|
|
|
1730
1935
|
The CORS headers to expose.
|
|
1731
1936
|
|
|
1732
1937
|
***
|
|
1733
1938
|
|
|
1734
|
-
###
|
|
1939
|
+
### publicOrigin? {#publicorigin}
|
|
1940
|
+
|
|
1941
|
+
> `optional` **publicOrigin?**: `string`
|
|
1942
|
+
|
|
1943
|
+
The public origin URL for the API e.g. https://api.example.com:1234
|
|
1944
|
+
|
|
1945
|
+
***
|
|
1946
|
+
|
|
1947
|
+
### authAdminProcessorType? {#authadminprocessortype}
|
|
1735
1948
|
|
|
1736
|
-
> `optional` **authAdminProcessorType
|
|
1949
|
+
> `optional` **authAdminProcessorType?**: `string`
|
|
1737
1950
|
|
|
1738
1951
|
The type of auth admin processor to use on the API: entity-storage.
|
|
1739
1952
|
|
|
1740
1953
|
***
|
|
1741
1954
|
|
|
1742
|
-
### authProcessorType?
|
|
1955
|
+
### authProcessorType? {#authprocessortype}
|
|
1743
1956
|
|
|
1744
|
-
> `optional` **authProcessorType
|
|
1957
|
+
> `optional` **authProcessorType?**: `string`
|
|
1745
1958
|
|
|
1746
1959
|
The type of auth processor to use on the API: entity-storage.
|
|
1747
1960
|
|
|
1748
1961
|
***
|
|
1749
1962
|
|
|
1750
|
-
### authSigningKeyId?
|
|
1963
|
+
### authSigningKeyId? {#authsigningkeyid}
|
|
1751
1964
|
|
|
1752
|
-
> `optional` **authSigningKeyId
|
|
1965
|
+
> `optional` **authSigningKeyId?**: `string`
|
|
1753
1966
|
|
|
1754
1967
|
The id of the key in the vault to use for signing in auth operations.
|
|
1755
1968
|
|
|
1756
1969
|
***
|
|
1757
1970
|
|
|
1758
|
-
###
|
|
1971
|
+
### authApiKeyHeader? {#authapikeyheader}
|
|
1972
|
+
|
|
1973
|
+
> `optional` **authApiKeyHeader?**: `string`
|
|
1974
|
+
|
|
1975
|
+
The HTTP header name used to pass the API key on requests, defaults to x-api-key.
|
|
1976
|
+
|
|
1977
|
+
***
|
|
1978
|
+
|
|
1979
|
+
### mimeTypeProcessors? {#mimetypeprocessors}
|
|
1759
1980
|
|
|
1760
|
-
> `optional` **mimeTypeProcessors
|
|
1981
|
+
> `optional` **mimeTypeProcessors?**: `string`
|
|
1761
1982
|
|
|
1762
1983
|
Additional MIME type processors to include, comma separated.
|
|
1763
1984
|
|
|
1764
1985
|
***
|
|
1765
1986
|
|
|
1766
|
-
### routeLoggingIncludeBody?
|
|
1987
|
+
### routeLoggingIncludeBody? {#routeloggingincludebody}
|
|
1767
1988
|
|
|
1768
|
-
> `optional` **routeLoggingIncludeBody
|
|
1989
|
+
> `optional` **routeLoggingIncludeBody?**: `string`
|
|
1769
1990
|
|
|
1770
1991
|
Include the body in the REST logging output, useful for debugging.
|
|
1771
1992
|
|
|
1772
1993
|
***
|
|
1773
1994
|
|
|
1774
|
-
### routeLoggingFullBase64?
|
|
1995
|
+
### routeLoggingFullBase64? {#routeloggingfullbase64}
|
|
1775
1996
|
|
|
1776
|
-
> `optional` **routeLoggingFullBase64
|
|
1997
|
+
> `optional` **routeLoggingFullBase64?**: `string`
|
|
1777
1998
|
|
|
1778
1999
|
Include the full base 64 output in the REST logging output, useful for debugging.
|
|
1779
2000
|
|
|
1780
2001
|
***
|
|
1781
2002
|
|
|
1782
|
-
### routeLoggingObfuscateProperties?
|
|
2003
|
+
### routeLoggingObfuscateProperties? {#routeloggingobfuscateproperties}
|
|
1783
2004
|
|
|
1784
|
-
> `optional` **routeLoggingObfuscateProperties
|
|
2005
|
+
> `optional` **routeLoggingObfuscateProperties?**: `string`
|
|
1785
2006
|
|
|
1786
2007
|
List of properties to obfuscate in the REST logging output, comma separated.
|