@twin.org/node-core 0.0.3-next.5 → 0.0.3-next.51

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