@twin.org/node-core 0.0.3-next.4 → 0.0.3-next.40

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