@twin.org/node-core 0.0.3-next.65 → 0.0.3-next.67

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