@twin.org/node-core 0.0.2-next.8 → 0.0.3-next.1

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 (126) hide show
  1. package/README.md +1 -1
  2. package/dist/es/bootstrap.js +374 -0
  3. package/dist/es/bootstrap.js.map +1 -0
  4. package/dist/es/builders/engineEnvBuilder.js +1051 -0
  5. package/dist/es/builders/engineEnvBuilder.js.map +1 -0
  6. package/dist/es/builders/engineServerEnvBuilder.js +197 -0
  7. package/dist/es/builders/engineServerEnvBuilder.js.map +1 -0
  8. package/dist/es/builders/extensionsBuilder.js +100 -0
  9. package/dist/es/builders/extensionsBuilder.js.map +1 -0
  10. package/dist/es/defaults.js +9 -0
  11. package/dist/es/defaults.js.map +1 -0
  12. package/dist/es/identity.js +169 -0
  13. package/dist/es/identity.js.map +1 -0
  14. package/dist/es/index.js +23 -0
  15. package/dist/es/index.js.map +1 -0
  16. package/dist/es/models/ICacheMetadata.js +4 -0
  17. package/dist/es/models/ICacheMetadata.js.map +1 -0
  18. package/dist/es/models/IEngineEnvironmentVariables.js +4 -0
  19. package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -0
  20. package/dist/es/models/IEngineServerEnvironmentVariables.js +2 -0
  21. package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -0
  22. package/dist/es/models/IModuleProtocol.js +2 -0
  23. package/dist/es/models/IModuleProtocol.js.map +1 -0
  24. package/dist/es/models/INodeEngineConfig.js +2 -0
  25. package/dist/es/models/INodeEngineConfig.js.map +1 -0
  26. package/dist/es/models/INodeEngineState.js +2 -0
  27. package/dist/es/models/INodeEngineState.js.map +1 -0
  28. package/dist/es/models/INodeEnvironmentVariables.js +2 -0
  29. package/dist/es/models/INodeEnvironmentVariables.js.map +1 -0
  30. package/dist/es/models/INodeOptions.js +2 -0
  31. package/dist/es/models/INodeOptions.js.map +1 -0
  32. package/dist/es/models/IProtocolHandlerResult.js +4 -0
  33. package/dist/es/models/IProtocolHandlerResult.js.map +1 -0
  34. package/dist/es/models/moduleProtocol.js +29 -0
  35. package/dist/es/models/moduleProtocol.js.map +1 -0
  36. package/dist/es/models/nodeExtensionMethods.js +2 -0
  37. package/dist/es/models/nodeExtensionMethods.js.map +1 -0
  38. package/dist/es/models/nodeFeatures.js +21 -0
  39. package/dist/es/models/nodeFeatures.js.map +1 -0
  40. package/dist/es/node.js +265 -0
  41. package/dist/es/node.js.map +1 -0
  42. package/dist/es/server.js +74 -0
  43. package/dist/es/server.js.map +1 -0
  44. package/dist/es/utils.js +418 -0
  45. package/dist/es/utils.js.map +1 -0
  46. package/dist/types/bootstrap.d.ts +27 -10
  47. package/dist/types/builders/engineEnvBuilder.d.ts +3 -2
  48. package/dist/types/builders/engineServerEnvBuilder.d.ts +4 -3
  49. package/dist/types/builders/extensionsBuilder.d.ts +32 -0
  50. package/dist/types/defaults.d.ts +6 -0
  51. package/dist/types/identity.d.ts +14 -0
  52. package/dist/types/index.d.ts +20 -11
  53. package/dist/types/models/ICacheMetadata.d.ts +17 -0
  54. package/dist/types/models/IEngineEnvironmentVariables.d.ts +132 -24
  55. package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +12 -3
  56. package/dist/types/models/IModuleProtocol.d.ts +18 -0
  57. package/dist/types/models/INodeEngineConfig.d.ts +6 -0
  58. package/dist/types/models/INodeEngineState.d.ts +22 -0
  59. package/dist/types/models/INodeEnvironmentVariables.d.ts +50 -10
  60. package/dist/types/models/INodeOptions.d.ts +14 -3
  61. package/dist/types/models/IProtocolHandlerResult.d.ts +13 -0
  62. package/dist/types/models/moduleProtocol.d.ts +29 -0
  63. package/dist/types/models/nodeExtensionMethods.d.ts +27 -0
  64. package/dist/types/models/nodeFeatures.d.ts +5 -5
  65. package/dist/types/node.d.ts +17 -7
  66. package/dist/types/server.d.ts +9 -6
  67. package/dist/types/utils.d.ts +87 -2
  68. package/docs/changelog.md +185 -0
  69. package/docs/detailed-guide.md +129 -0
  70. package/docs/reference/functions/bootstrap.md +1 -1
  71. package/docs/reference/functions/bootstrapAuth.md +1 -1
  72. package/docs/reference/functions/bootstrapBlobEncryption.md +1 -1
  73. package/docs/reference/functions/bootstrapContextIdHandlers.md +35 -0
  74. package/docs/reference/functions/bootstrapImmutableProofMethod.md +1 -1
  75. package/docs/reference/functions/{bootstrapNodeUser.md → bootstrapNodeAdminUser.md} +3 -3
  76. package/docs/reference/functions/{bootstrapNodeIdentity.md → bootstrapNodeId.md} +3 -3
  77. package/docs/reference/functions/bootstrapSynchronisedStorage.md +1 -1
  78. package/docs/reference/functions/bootstrapTenantId.md +35 -0
  79. package/docs/reference/functions/buildConfiguration.md +2 -2
  80. package/docs/reference/functions/buildEngineConfiguration.md +8 -2
  81. package/docs/reference/functions/buildEngineServerConfiguration.md +9 -3
  82. package/docs/reference/functions/createModuleImportUrl.md +21 -0
  83. package/docs/reference/functions/directoryExists.md +19 -0
  84. package/docs/reference/functions/extensionsConfiguration.md +25 -0
  85. package/docs/reference/functions/extensionsInitialiseEngine.md +25 -0
  86. package/docs/reference/functions/extensionsInitialiseEngineServer.md +31 -0
  87. package/docs/reference/functions/getExtensionsCacheDir.md +31 -0
  88. package/docs/reference/functions/getFiles.md +19 -0
  89. package/docs/reference/functions/getSubFolders.md +19 -0
  90. package/docs/reference/functions/handleHttpsProtocol.md +49 -0
  91. package/docs/reference/functions/handleNpmProtocol.md +31 -0
  92. package/docs/reference/functions/hashUrl.md +19 -0
  93. package/docs/reference/functions/isCacheExpired.md +31 -0
  94. package/docs/reference/functions/overrideModuleImport.md +8 -2
  95. package/docs/reference/functions/parseModuleProtocol.md +19 -0
  96. package/docs/reference/functions/resolvePackageEntryPoint.md +32 -0
  97. package/docs/reference/functions/run.md +3 -3
  98. package/docs/reference/functions/shutdownExtensions.md +25 -0
  99. package/docs/reference/functions/start.md +11 -5
  100. package/docs/reference/index.md +36 -2
  101. package/docs/reference/interfaces/ICacheMetadata.md +27 -0
  102. package/docs/reference/interfaces/IEngineEnvironmentVariables.md +255 -37
  103. package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +1696 -5
  104. package/docs/reference/interfaces/IModuleProtocol.md +27 -0
  105. package/docs/reference/interfaces/INodeEngineConfig.md +7 -0
  106. package/docs/reference/interfaces/INodeEngineState.md +39 -0
  107. package/docs/reference/interfaces/INodeEnvironmentVariables.md +609 -165
  108. package/docs/reference/interfaces/INodeOptions.md +27 -3
  109. package/docs/reference/interfaces/IProtocolHandlerResult.md +19 -0
  110. package/docs/reference/type-aliases/ModuleProtocol.md +5 -0
  111. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +18 -0
  112. package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +24 -0
  113. package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +23 -0
  114. package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +10 -0
  115. package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +3 -0
  116. package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +3 -0
  117. package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  118. package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +3 -0
  119. package/docs/reference/variables/ModuleProtocol.md +37 -0
  120. package/docs/reference/variables/NodeFeatures.md +8 -8
  121. package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
  122. package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +3 -0
  123. package/locales/en.json +27 -9
  124. package/package.json +27 -9
  125. package/dist/cjs/index.cjs +0 -1910
  126. package/dist/esm/index.mjs +0 -1870
package/docs/reference/interfaces/INodeEnvironmentVariables.md CHANGED
@@ -4,7 +4,7 @@ The environment variables for the node.
4
4
 
5
5
  ## Extends
6
6
 
7
- - [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md)
7
+ - [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md)
8
8
 
9
9
  ## Properties
10
10
 
@@ -16,7 +16,7 @@ Start the engine in debug mode.
16
16
 
17
17
  #### Inherited from
18
18
 
19
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`debug`](IEngineEnvironmentVariables.md#debug)
19
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`debug`](IEngineServerEnvironmentVariables.md#debug)
20
20
 
21
21
  ***
22
22
 
@@ -28,7 +28,7 @@ The root directory for storing items like state file.
28
28
 
29
29
  #### Inherited from
30
30
 
31
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`storageFileRoot`](IEngineEnvironmentVariables.md#storagefileroot)
31
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`storageFileRoot`](IEngineServerEnvironmentVariables.md#storagefileroot)
32
32
 
33
33
  ***
34
34
 
@@ -40,7 +40,43 @@ The name of the state file.
40
40
 
41
41
  #### Inherited from
42
42
 
43
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`stateFilename`](IEngineEnvironmentVariables.md#statefilename)
43
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`stateFilename`](IEngineServerEnvironmentVariables.md#statefilename)
44
+
45
+ ***
46
+
47
+ ### tenantEnabled?
48
+
49
+ > `optional` **tenantEnabled**: `string`
50
+
51
+ Is multi-tenant support enabled, defaults to false.
52
+
53
+ #### Inherited from
54
+
55
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantEnabled`](IEngineServerEnvironmentVariables.md#tenantenabled)
56
+
57
+ ***
58
+
59
+ ### tenantId?
60
+
61
+ > `optional` **tenantId**: `string`
62
+
63
+ A tenant id to use as a default for the node.
64
+
65
+ #### Inherited from
66
+
67
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantId`](IEngineServerEnvironmentVariables.md#tenantid)
68
+
69
+ ***
70
+
71
+ ### tenantApiKey?
72
+
73
+ > `optional` **tenantApiKey**: `string`
74
+
75
+ A tenant api key to use as a default for the node.
76
+
77
+ #### Inherited from
78
+
79
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantApiKey`](IEngineServerEnvironmentVariables.md#tenantapikey)
44
80
 
45
81
  ***
46
82
 
@@ -53,7 +89,7 @@ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, m
53
89
 
54
90
  #### Inherited from
55
91
 
56
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorType`](IEngineEnvironmentVariables.md#entitystorageconnectortype)
92
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageConnectorType`](IEngineServerEnvironmentVariables.md#entitystorageconnectortype)
57
93
 
58
94
  ***
59
95
 
@@ -65,7 +101,7 @@ The default entity storage connector to use, defaults to the first one in the li
65
101
 
66
102
  #### Inherited from
67
103
 
68
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineEnvironmentVariables.md#entitystorageconnectordefault)
104
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineServerEnvironmentVariables.md#entitystorageconnectordefault)
69
105
 
70
106
  ***
71
107
 
@@ -77,7 +113,19 @@ A prefix for all the table in entity-storage, can be empty.
77
113
 
78
114
  #### Inherited from
79
115
 
80
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineEnvironmentVariables.md#entitystoragetableprefix)
116
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineServerEnvironmentVariables.md#entitystoragetableprefix)
117
+
118
+ ***
119
+
120
+ ### awsDynamodbAuthMode?
121
+
122
+ > `optional` **awsDynamodbAuthMode**: `string`
123
+
124
+ AWS DynamoDB auth mode, either credentials or pod.
125
+
126
+ #### Inherited from
127
+
128
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineServerEnvironmentVariables.md#awsdynamodbauthmode)
81
129
 
82
130
  ***
83
131
 
@@ -89,7 +137,7 @@ AWS Dynamo DB access key id.
89
137
 
90
138
  #### Inherited from
91
139
 
92
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAccessKeyId`](IEngineEnvironmentVariables.md#awsdynamodbaccesskeyid)
140
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbAccessKeyId`](IEngineServerEnvironmentVariables.md#awsdynamodbaccesskeyid)
93
141
 
94
142
  ***
95
143
 
@@ -101,7 +149,7 @@ AWS Dynamo DB Endpoint if running local instance.
101
149
 
102
150
  #### Inherited from
103
151
 
104
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbEndpoint`](IEngineEnvironmentVariables.md#awsdynamodbendpoint)
152
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbEndpoint`](IEngineServerEnvironmentVariables.md#awsdynamodbendpoint)
105
153
 
106
154
  ***
107
155
 
@@ -113,7 +161,7 @@ AWS Dynamo DB region.
113
161
 
114
162
  #### Inherited from
115
163
 
116
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineEnvironmentVariables.md#awsdynamodbregion)
164
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineServerEnvironmentVariables.md#awsdynamodbregion)
117
165
 
118
166
  ***
119
167
 
@@ -125,7 +173,7 @@ AWS Dynamo DB secret access key.
125
173
 
126
174
  #### Inherited from
127
175
 
128
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineEnvironmentVariables.md#awsdynamodbsecretaccesskey)
176
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineServerEnvironmentVariables.md#awsdynamodbsecretaccesskey)
129
177
 
130
178
  ***
131
179
 
@@ -137,7 +185,7 @@ Azure Cosmos DB key.
137
185
 
138
186
  #### Inherited from
139
187
 
140
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineEnvironmentVariables.md#azurecosmosdbkey)
188
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineServerEnvironmentVariables.md#azurecosmosdbkey)
141
189
 
142
190
  ***
143
191
 
@@ -149,7 +197,7 @@ Azure Cosmos DB container id.
149
197
 
150
198
  #### Inherited from
151
199
 
152
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineEnvironmentVariables.md#azurecosmosdbcontainerid)
200
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineServerEnvironmentVariables.md#azurecosmosdbcontainerid)
153
201
 
154
202
  ***
155
203
 
@@ -161,7 +209,7 @@ Azure Cosmos DB database id.
161
209
 
162
210
  #### Inherited from
163
211
 
164
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineEnvironmentVariables.md#azurecosmosdbdatabaseid)
212
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineServerEnvironmentVariables.md#azurecosmosdbdatabaseid)
165
213
 
166
214
  ***
167
215
 
@@ -173,7 +221,7 @@ Azure Cosmos DB endpoint.
173
221
 
174
222
  #### Inherited from
175
223
 
176
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineEnvironmentVariables.md#azurecosmosdbendpoint)
224
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineServerEnvironmentVariables.md#azurecosmosdbendpoint)
177
225
 
178
226
  ***
179
227
 
@@ -185,7 +233,7 @@ GCP Firestore collection name.
185
233
 
186
234
  #### Inherited from
187
235
 
188
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineEnvironmentVariables.md#gcpfirestorecollectionname)
236
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineServerEnvironmentVariables.md#gcpfirestorecollectionname)
189
237
 
190
238
  ***
191
239
 
@@ -197,7 +245,7 @@ GCP Firestore credentials.
197
245
 
198
246
  #### Inherited from
199
247
 
200
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineEnvironmentVariables.md#gcpfirestorecredentials)
248
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineServerEnvironmentVariables.md#gcpfirestorecredentials)
201
249
 
202
250
  ***
203
251
 
@@ -209,7 +257,7 @@ GCP Firestore database id.
209
257
 
210
258
  #### Inherited from
211
259
 
212
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineEnvironmentVariables.md#gcpfirestoredatabaseid)
260
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineServerEnvironmentVariables.md#gcpfirestoredatabaseid)
213
261
 
214
262
  ***
215
263
 
@@ -221,7 +269,7 @@ GCP Firestore endpoint.
221
269
 
222
270
  #### Inherited from
223
271
 
224
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineEnvironmentVariables.md#gcpfirestoreapiendpoint)
272
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineServerEnvironmentVariables.md#gcpfirestoreapiendpoint)
225
273
 
226
274
  ***
227
275
 
@@ -233,7 +281,7 @@ GCP Firestore project id.
233
281
 
234
282
  #### Inherited from
235
283
 
236
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineEnvironmentVariables.md#gcpfirestoreprojectid)
284
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineServerEnvironmentVariables.md#gcpfirestoreprojectid)
237
285
 
238
286
  ***
239
287
 
@@ -245,7 +293,7 @@ ScyllaDB hosts as comma separated string.
245
293
 
246
294
  #### Inherited from
247
295
 
248
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbHosts`](IEngineEnvironmentVariables.md#scylladbhosts)
296
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbHosts`](IEngineServerEnvironmentVariables.md#scylladbhosts)
249
297
 
250
298
  ***
251
299
 
@@ -257,7 +305,7 @@ ScyllaDB keyspace.
257
305
 
258
306
  #### Inherited from
259
307
 
260
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbKeyspace`](IEngineEnvironmentVariables.md#scylladbkeyspace)
308
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbKeyspace`](IEngineServerEnvironmentVariables.md#scylladbkeyspace)
261
309
 
262
310
  ***
263
311
 
@@ -269,7 +317,7 @@ ScyllaDB local data center.
269
317
 
270
318
  #### Inherited from
271
319
 
272
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineEnvironmentVariables.md#scylladblocaldatacenter)
320
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineServerEnvironmentVariables.md#scylladblocaldatacenter)
273
321
 
274
322
  ***
275
323
 
@@ -281,7 +329,7 @@ ScyllaDB port.
281
329
 
282
330
  #### Inherited from
283
331
 
284
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`scylladbPort`](IEngineEnvironmentVariables.md#scylladbport)
332
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbPort`](IEngineServerEnvironmentVariables.md#scylladbport)
285
333
 
286
334
  ***
287
335
 
@@ -293,7 +341,7 @@ MySQL host.
293
341
 
294
342
  #### Inherited from
295
343
 
296
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlHost`](IEngineEnvironmentVariables.md#mysqlhost)
344
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlHost`](IEngineServerEnvironmentVariables.md#mysqlhost)
297
345
 
298
346
  ***
299
347
 
@@ -305,7 +353,7 @@ MySQL port.
305
353
 
306
354
  #### Inherited from
307
355
 
308
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPort`](IEngineEnvironmentVariables.md#mysqlport)
356
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPort`](IEngineServerEnvironmentVariables.md#mysqlport)
309
357
 
310
358
  ***
311
359
 
@@ -317,7 +365,7 @@ MySQL username.
317
365
 
318
366
  #### Inherited from
319
367
 
320
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlUser`](IEngineEnvironmentVariables.md#mysqluser)
368
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlUser`](IEngineServerEnvironmentVariables.md#mysqluser)
321
369
 
322
370
  ***
323
371
 
@@ -329,7 +377,7 @@ MySQL password.
329
377
 
330
378
  #### Inherited from
331
379
 
332
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlPassword`](IEngineEnvironmentVariables.md#mysqlpassword)
380
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPassword`](IEngineServerEnvironmentVariables.md#mysqlpassword)
333
381
 
334
382
  ***
335
383
 
@@ -341,7 +389,7 @@ MySQL Database.
341
389
 
342
390
  #### Inherited from
343
391
 
344
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mySqlDatabase`](IEngineEnvironmentVariables.md#mysqldatabase)
392
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlDatabase`](IEngineServerEnvironmentVariables.md#mysqldatabase)
345
393
 
346
394
  ***
347
395
 
@@ -353,7 +401,7 @@ MongoDB host.
353
401
 
354
402
  #### Inherited from
355
403
 
356
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbHost`](IEngineEnvironmentVariables.md#mongodbhost)
404
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbHost`](IEngineServerEnvironmentVariables.md#mongodbhost)
357
405
 
358
406
  ***
359
407
 
@@ -365,7 +413,7 @@ MongoDB port.
365
413
 
366
414
  #### Inherited from
367
415
 
368
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPort`](IEngineEnvironmentVariables.md#mongodbport)
416
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPort`](IEngineServerEnvironmentVariables.md#mongodbport)
369
417
 
370
418
  ***
371
419
 
@@ -377,7 +425,7 @@ MongoDB username.
377
425
 
378
426
  #### Inherited from
379
427
 
380
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbUser`](IEngineEnvironmentVariables.md#mongodbuser)
428
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbUser`](IEngineServerEnvironmentVariables.md#mongodbuser)
381
429
 
382
430
  ***
383
431
 
@@ -389,7 +437,7 @@ MongoDB password.
389
437
 
390
438
  #### Inherited from
391
439
 
392
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbPassword`](IEngineEnvironmentVariables.md#mongodbpassword)
440
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPassword`](IEngineServerEnvironmentVariables.md#mongodbpassword)
393
441
 
394
442
  ***
395
443
 
@@ -401,7 +449,7 @@ MongoDB Database.
401
449
 
402
450
  #### Inherited from
403
451
 
404
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`mongoDbDatabase`](IEngineEnvironmentVariables.md#mongodbdatabase)
452
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbDatabase`](IEngineServerEnvironmentVariables.md#mongodbdatabase)
405
453
 
406
454
  ***
407
455
 
@@ -413,7 +461,7 @@ PostgreSQl host.
413
461
 
414
462
  #### Inherited from
415
463
 
416
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlHost`](IEngineEnvironmentVariables.md#postgresqlhost)
464
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlHost`](IEngineServerEnvironmentVariables.md#postgresqlhost)
417
465
 
418
466
  ***
419
467
 
@@ -425,7 +473,7 @@ PostgreSQl port.
425
473
 
426
474
  #### Inherited from
427
475
 
428
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPort`](IEngineEnvironmentVariables.md#postgresqlport)
476
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPort`](IEngineServerEnvironmentVariables.md#postgresqlport)
429
477
 
430
478
  ***
431
479
 
@@ -437,7 +485,7 @@ PostgreSQl username.
437
485
 
438
486
  #### Inherited from
439
487
 
440
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlUser`](IEngineEnvironmentVariables.md#postgresqluser)
488
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlUser`](IEngineServerEnvironmentVariables.md#postgresqluser)
441
489
 
442
490
  ***
443
491
 
@@ -449,7 +497,7 @@ PostgreSQl password.
449
497
 
450
498
  #### Inherited from
451
499
 
452
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlPassword`](IEngineEnvironmentVariables.md#postgresqlpassword)
500
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPassword`](IEngineServerEnvironmentVariables.md#postgresqlpassword)
453
501
 
454
502
  ***
455
503
 
@@ -461,7 +509,7 @@ PostgreSQl Database.
461
509
 
462
510
  #### Inherited from
463
511
 
464
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineEnvironmentVariables.md#postgresqldatabase)
512
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineServerEnvironmentVariables.md#postgresqldatabase)
465
513
 
466
514
  ***
467
515
 
@@ -473,7 +521,7 @@ The security token for accessing IPFS API.
473
521
 
474
522
  #### Inherited from
475
523
 
476
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsBearerToken`](IEngineEnvironmentVariables.md#ipfsbearertoken)
524
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsBearerToken`](IEngineServerEnvironmentVariables.md#ipfsbearertoken)
477
525
 
478
526
  ***
479
527
 
@@ -485,7 +533,7 @@ The url for accessing IPFS API.
485
533
 
486
534
  #### Inherited from
487
535
 
488
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`ipfsApiUrl`](IEngineEnvironmentVariables.md#ipfsapiurl)
536
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsApiUrl`](IEngineServerEnvironmentVariables.md#ipfsapiurl)
489
537
 
490
538
  ***
491
539
 
@@ -498,7 +546,7 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
498
546
 
499
547
  #### Inherited from
500
548
 
501
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineEnvironmentVariables.md#blobstorageconnectortype)
549
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineServerEnvironmentVariables.md#blobstorageconnectortype)
502
550
 
503
551
  ***
504
552
 
@@ -510,7 +558,7 @@ The default blob storage connector to use, defaults to the first one in the list
510
558
 
511
559
  #### Inherited from
512
560
 
513
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineEnvironmentVariables.md#blobstorageconnectordefault)
561
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineServerEnvironmentVariables.md#blobstorageconnectordefault)
514
562
 
515
563
  ***
516
564
 
@@ -522,7 +570,7 @@ Blog storage connector which has public access.
522
570
 
523
571
  #### Inherited from
524
572
 
525
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineEnvironmentVariables.md#blobstorageconnectorpublic)
573
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineServerEnvironmentVariables.md#blobstorageconnectorpublic)
526
574
 
527
575
  ***
528
576
 
@@ -534,7 +582,7 @@ Enable encryption for the blob storage.
534
582
 
535
583
  #### Inherited from
536
584
 
537
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineEnvironmentVariables.md#blobstorageenableencryption)
585
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineServerEnvironmentVariables.md#blobstorageenableencryption)
538
586
 
539
587
  ***
540
588
 
@@ -546,7 +594,7 @@ The id of the encryption key for the blob storage.
546
594
 
547
595
  #### Inherited from
548
596
 
549
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#blobstorageencryptionkeyid)
597
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#blobstorageencryptionkeyid)
550
598
 
551
599
  ***
552
600
 
@@ -559,7 +607,7 @@ If encryption is enabled but a key is not provided one will be generated.
559
607
 
560
608
  #### Inherited from
561
609
 
562
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
610
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineServerEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
563
611
 
564
612
  ***
565
613
 
@@ -571,19 +619,19 @@ A prefix for all the blobs in blob-storage, can be empty.
571
619
 
572
620
  #### Inherited from
573
621
 
574
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStoragePrefix`](IEngineEnvironmentVariables.md#blobstorageprefix)
622
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStoragePrefix`](IEngineServerEnvironmentVariables.md#blobstorageprefix)
575
623
 
576
624
  ***
577
625
 
578
- ### awsS3AccessKeyId?
626
+ ### awsS3Region?
579
627
 
580
- > `optional` **awsS3AccessKeyId**: `string`
628
+ > `optional` **awsS3Region**: `string`
581
629
 
582
- AWS S3 access key id.
630
+ AWS S3 region.
583
631
 
584
632
  #### Inherited from
585
633
 
586
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
634
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Region`](IEngineServerEnvironmentVariables.md#awss3region)
587
635
 
588
636
  ***
589
637
 
@@ -595,31 +643,31 @@ AWS S3 bucket name.
595
643
 
596
644
  #### Inherited from
597
645
 
598
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3BucketName`](IEngineEnvironmentVariables.md#awss3bucketname)
646
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3BucketName`](IEngineServerEnvironmentVariables.md#awss3bucketname)
599
647
 
600
648
  ***
601
649
 
602
- ### awsS3Endpoint?
650
+ ### awsS3AuthMode?
603
651
 
604
- > `optional` **awsS3Endpoint**: `string`
652
+ > `optional` **awsS3AuthMode**: `string`
605
653
 
606
- AWS S3 endpoint.
654
+ AWS S3 auth mode, either credentials or pod, defaults to credentials.
607
655
 
608
656
  #### Inherited from
609
657
 
610
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
658
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AuthMode`](IEngineServerEnvironmentVariables.md#awss3authmode)
611
659
 
612
660
  ***
613
661
 
614
- ### awsS3Region?
662
+ ### awsS3AccessKeyId?
615
663
 
616
- > `optional` **awsS3Region**: `string`
664
+ > `optional` **awsS3AccessKeyId**: `string`
617
665
 
618
- AWS S3 region.
666
+ AWS S3 access key id.
619
667
 
620
668
  #### Inherited from
621
669
 
622
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
670
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineServerEnvironmentVariables.md#awss3accesskeyid)
623
671
 
624
672
  ***
625
673
 
@@ -631,7 +679,19 @@ AWS S3 secret access key.
631
679
 
632
680
  #### Inherited from
633
681
 
634
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineEnvironmentVariables.md#awss3secretaccesskey)
682
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineServerEnvironmentVariables.md#awss3secretaccesskey)
683
+
684
+ ***
685
+
686
+ ### awsS3Endpoint?
687
+
688
+ > `optional` **awsS3Endpoint**: `string`
689
+
690
+ AWS S3 endpoint.
691
+
692
+ #### Inherited from
693
+
694
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Endpoint`](IEngineServerEnvironmentVariables.md#awss3endpoint)
635
695
 
636
696
  ***
637
697
 
@@ -643,7 +703,7 @@ Azure Storage account key.
643
703
 
644
704
  #### Inherited from
645
705
 
646
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineEnvironmentVariables.md#azurestorageaccountkey)
706
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineServerEnvironmentVariables.md#azurestorageaccountkey)
647
707
 
648
708
  ***
649
709
 
@@ -655,7 +715,7 @@ Azure Storage account name.
655
715
 
656
716
  #### Inherited from
657
717
 
658
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageAccountName`](IEngineEnvironmentVariables.md#azurestorageaccountname)
718
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountName`](IEngineServerEnvironmentVariables.md#azurestorageaccountname)
659
719
 
660
720
  ***
661
721
 
@@ -667,7 +727,7 @@ Azure Storage container.
667
727
 
668
728
  #### Inherited from
669
729
 
670
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageContainerName`](IEngineEnvironmentVariables.md#azurestoragecontainername)
730
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageContainerName`](IEngineServerEnvironmentVariables.md#azurestoragecontainername)
671
731
 
672
732
  ***
673
733
 
@@ -679,7 +739,7 @@ Azure Storage endpoint.
679
739
 
680
740
  #### Inherited from
681
741
 
682
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineEnvironmentVariables.md#azurestorageendpoint)
742
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineServerEnvironmentVariables.md#azurestorageendpoint)
683
743
 
684
744
  ***
685
745
 
@@ -691,7 +751,7 @@ GCP Storage bucket.
691
751
 
692
752
  #### Inherited from
693
753
 
694
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineEnvironmentVariables.md#gcpstoragebucketname)
754
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineServerEnvironmentVariables.md#gcpstoragebucketname)
695
755
 
696
756
  ***
697
757
 
@@ -703,7 +763,7 @@ GCP Storage credentials.
703
763
 
704
764
  #### Inherited from
705
765
 
706
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineEnvironmentVariables.md#gcpstoragecredentials)
766
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineServerEnvironmentVariables.md#gcpstoragecredentials)
707
767
 
708
768
  ***
709
769
 
@@ -715,7 +775,7 @@ GCP Storage endpoint.
715
775
 
716
776
  #### Inherited from
717
777
 
718
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineEnvironmentVariables.md#gcpstorageendpoint)
778
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineServerEnvironmentVariables.md#gcpstorageendpoint)
719
779
 
720
780
  ***
721
781
 
@@ -727,7 +787,7 @@ GCP Storage project id.
727
787
 
728
788
  #### Inherited from
729
789
 
730
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineEnvironmentVariables.md#gcpstorageprojectid)
790
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineServerEnvironmentVariables.md#gcpstorageprojectid)
731
791
 
732
792
  ***
733
793
 
@@ -739,7 +799,7 @@ The type of the default vault connector: entity-storage, hashicorp.
739
799
 
740
800
  #### Inherited from
741
801
 
742
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`vaultConnector`](IEngineEnvironmentVariables.md#vaultconnector)
802
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vaultConnector`](IEngineServerEnvironmentVariables.md#vaultconnector)
743
803
 
744
804
  ***
745
805
 
@@ -751,7 +811,7 @@ Hashicorp Vault token.
751
811
 
752
812
  #### Inherited from
753
813
 
754
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineEnvironmentVariables.md#hashicorpvaulttoken)
814
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineServerEnvironmentVariables.md#hashicorpvaulttoken)
755
815
 
756
816
  ***
757
817
 
@@ -763,7 +823,7 @@ Hashicorp Vault endpoint.
763
823
 
764
824
  #### Inherited from
765
825
 
766
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineEnvironmentVariables.md#hashicorpvaultendpoint)
826
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineServerEnvironmentVariables.md#hashicorpvaultendpoint)
767
827
 
768
828
  ***
769
829
 
@@ -771,11 +831,11 @@ Hashicorp Vault endpoint.
771
831
 
772
832
  > `optional` **loggingConnector**: `string`
773
833
 
774
- The type of background task connector, can be a comma separated list: console, entity-storage.
834
+ The type of logging task connector, can be a comma separated list: console, entity-storage.
775
835
 
776
836
  #### Inherited from
777
837
 
778
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`loggingConnector`](IEngineEnvironmentVariables.md#loggingconnector)
838
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`loggingConnector`](IEngineServerEnvironmentVariables.md#loggingconnector)
779
839
 
780
840
  ***
781
841
 
@@ -787,7 +847,7 @@ The type of background task connector: entity-storage.
787
847
 
788
848
  #### Inherited from
789
849
 
790
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineEnvironmentVariables.md#backgroundtaskconnector)
850
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineServerEnvironmentVariables.md#backgroundtaskconnector)
791
851
 
792
852
  ***
793
853
 
@@ -799,7 +859,7 @@ The type of event bus connector: local.
799
859
 
800
860
  #### Inherited from
801
861
 
802
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusConnector`](IEngineEnvironmentVariables.md#eventbusconnector)
862
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusConnector`](IEngineServerEnvironmentVariables.md#eventbusconnector)
803
863
 
804
864
  ***
805
865
 
@@ -811,43 +871,79 @@ The type of event bus component: service.
811
871
 
812
872
  #### Inherited from
813
873
 
814
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`eventBusComponent`](IEngineEnvironmentVariables.md#eventbuscomponent)
874
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusComponent`](IEngineServerEnvironmentVariables.md#eventbuscomponent)
815
875
 
816
876
  ***
817
877
 
818
- ### messagingEmailConnector?
878
+ ### messagingEnabled?
819
879
 
820
- > `optional` **messagingEmailConnector**: `string`
880
+ > `optional` **messagingEnabled**: `string`
821
881
 
822
- The type of messaging email connector: entity-storage, aws.
882
+ Are the messaging components enabled, defaults to false.
823
883
 
824
884
  #### Inherited from
825
885
 
826
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingEmailConnector`](IEngineEnvironmentVariables.md#messagingemailconnector)
886
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingEnabled`](IEngineServerEnvironmentVariables.md#messagingenabled)
827
887
 
828
888
  ***
829
889
 
830
- ### messagingSmsConnector?
890
+ ### awsSesRegion?
831
891
 
832
- > `optional` **messagingSmsConnector**: `string`
892
+ > `optional` **awsSesRegion**: `string`
833
893
 
834
- The type of messaging sms connector: entity-storage, aws.
894
+ AWS SES region.
835
895
 
836
896
  #### Inherited from
837
897
 
838
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingSmsConnector`](IEngineEnvironmentVariables.md#messagingsmsconnector)
898
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesRegion`](IEngineServerEnvironmentVariables.md#awssesregion)
839
899
 
840
900
  ***
841
901
 
842
- ### messagingPushNotificationConnector?
902
+ ### awsSesAuthMode?
843
903
 
844
- > `optional` **messagingPushNotificationConnector**: `string`
904
+ > `optional` **awsSesAuthMode**: `string`
845
905
 
846
- The type of messaging push notification connector: entity-storage, aws.
906
+ AWS SES auth mode, either credentials or pod, defaults to credentials.
847
907
 
848
908
  #### Inherited from
849
909
 
850
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineEnvironmentVariables.md#messagingpushnotificationconnector)
910
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAuthMode`](IEngineServerEnvironmentVariables.md#awssesauthmode)
911
+
912
+ ***
913
+
914
+ ### awsSesSecretAccessKey?
915
+
916
+ > `optional` **awsSesSecretAccessKey**: `string`
917
+
918
+ AWS SES secret access key.
919
+
920
+ #### Inherited from
921
+
922
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineServerEnvironmentVariables.md#awssessecretaccesskey)
923
+
924
+ ***
925
+
926
+ ### awsSesAccessKeyId?
927
+
928
+ > `optional` **awsSesAccessKeyId**: `string`
929
+
930
+ AWS SES access key id.
931
+
932
+ #### Inherited from
933
+
934
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineServerEnvironmentVariables.md#awssesaccesskeyid)
935
+
936
+ ***
937
+
938
+ ### awsSesEndpoint?
939
+
940
+ > `optional` **awsSesEndpoint**: `string`
941
+
942
+ AWS SES endpoint.
943
+
944
+ #### Inherited from
945
+
946
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesEndpoint`](IEngineServerEnvironmentVariables.md#awssesendpoint)
851
947
 
852
948
  ***
853
949
 
@@ -859,19 +955,43 @@ The applications for the push notifications JSON stringified array of IAwsApplic
859
955
 
860
956
  #### Inherited from
861
957
 
862
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineEnvironmentVariables.md#awsmessagingpushnotificationapplications)
958
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineServerEnvironmentVariables.md#awsmessagingpushnotificationapplications)
863
959
 
864
960
  ***
865
961
 
866
- ### messagingComponent?
962
+ ### messagingEmailConnector?
867
963
 
868
- > `optional` **messagingComponent**: `string`
964
+ > `optional` **messagingEmailConnector**: `string`
869
965
 
870
- The type of messaging component: service.
966
+ The type of messaging email connector: entity-storage, aws.
871
967
 
872
968
  #### Inherited from
873
969
 
874
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`messagingComponent`](IEngineEnvironmentVariables.md#messagingcomponent)
970
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingEmailConnector`](IEngineServerEnvironmentVariables.md#messagingemailconnector)
971
+
972
+ ***
973
+
974
+ ### messagingSmsConnector?
975
+
976
+ > `optional` **messagingSmsConnector**: `string`
977
+
978
+ The type of messaging sms connector: entity-storage, aws.
979
+
980
+ #### Inherited from
981
+
982
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingSmsConnector`](IEngineServerEnvironmentVariables.md#messagingsmsconnector)
983
+
984
+ ***
985
+
986
+ ### messagingPushNotificationConnector?
987
+
988
+ > `optional` **messagingPushNotificationConnector**: `string`
989
+
990
+ The type of messaging push notification connector: entity-storage, aws.
991
+
992
+ #### Inherited from
993
+
994
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineServerEnvironmentVariables.md#messagingpushnotificationconnector)
875
995
 
876
996
  ***
877
997
 
@@ -883,7 +1003,7 @@ The type of telemetry connector: entity-storage.
883
1003
 
884
1004
  #### Inherited from
885
1005
 
886
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`telemetryConnector`](IEngineEnvironmentVariables.md#telemetryconnector)
1006
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`telemetryConnector`](IEngineServerEnvironmentVariables.md#telemetryconnector)
887
1007
 
888
1008
  ***
889
1009
 
@@ -895,7 +1015,7 @@ The type of faucet connector: entity-storage, iota.
895
1015
 
896
1016
  #### Inherited from
897
1017
 
898
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`faucetConnector`](IEngineEnvironmentVariables.md#faucetconnector)
1018
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`faucetConnector`](IEngineServerEnvironmentVariables.md#faucetconnector)
899
1019
 
900
1020
  ***
901
1021
 
@@ -907,7 +1027,7 @@ The type of wallet connector: entity-storage, iota.
907
1027
 
908
1028
  #### Inherited from
909
1029
 
910
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`walletConnector`](IEngineEnvironmentVariables.md#walletconnector)
1030
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`walletConnector`](IEngineServerEnvironmentVariables.md#walletconnector)
911
1031
 
912
1032
  ***
913
1033
 
@@ -919,7 +1039,7 @@ The type of NFT connector: entity-storage, iota.
919
1039
 
920
1040
  #### Inherited from
921
1041
 
922
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`nftConnector`](IEngineEnvironmentVariables.md#nftconnector)
1042
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`nftConnector`](IEngineServerEnvironmentVariables.md#nftconnector)
923
1043
 
924
1044
  ***
925
1045
 
@@ -931,7 +1051,7 @@ The type of identity connector: entity-storage, iota.
931
1051
 
932
1052
  #### Inherited from
933
1053
 
934
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityConnector`](IEngineEnvironmentVariables.md#identityconnector)
1054
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityConnector`](IEngineServerEnvironmentVariables.md#identityconnector)
935
1055
 
936
1056
  ***
937
1057
 
@@ -943,7 +1063,7 @@ The type of identity resolver connector: entity-storage, iota.
943
1063
 
944
1064
  #### Inherited from
945
1065
 
946
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityResolverConnector`](IEngineEnvironmentVariables.md#identityresolverconnector)
1066
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityResolverConnector`](IEngineServerEnvironmentVariables.md#identityresolverconnector)
947
1067
 
948
1068
  ***
949
1069
 
@@ -955,7 +1075,7 @@ The type of verifiable storage connector: entity-storage, iota.
955
1075
 
956
1076
  #### Inherited from
957
1077
 
958
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineEnvironmentVariables.md#verifiablestorageconnector)
1078
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineServerEnvironmentVariables.md#verifiablestorageconnector)
959
1079
 
960
1080
  ***
961
1081
 
@@ -967,7 +1087,7 @@ IOTA Faucet Endpoint.
967
1087
 
968
1088
  #### Inherited from
969
1089
 
970
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineEnvironmentVariables.md#iotafaucetendpoint)
1090
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineServerEnvironmentVariables.md#iotafaucetendpoint)
971
1091
 
972
1092
  ***
973
1093
 
@@ -979,7 +1099,7 @@ IOTA Node Endpoint.
979
1099
 
980
1100
  #### Inherited from
981
1101
 
982
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineEnvironmentVariables.md#iotanodeendpoint)
1102
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineServerEnvironmentVariables.md#iotanodeendpoint)
983
1103
 
984
1104
  ***
985
1105
 
@@ -991,7 +1111,7 @@ IOTA network.
991
1111
 
992
1112
  #### Inherited from
993
1113
 
994
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaNetwork`](IEngineEnvironmentVariables.md#iotanetwork)
1114
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNetwork`](IEngineServerEnvironmentVariables.md#iotanetwork)
995
1115
 
996
1116
  ***
997
1117
 
@@ -1003,7 +1123,7 @@ IOTA coin type.
1003
1123
 
1004
1124
  #### Inherited from
1005
1125
 
1006
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaCoinType`](IEngineEnvironmentVariables.md#iotacointype)
1126
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaCoinType`](IEngineServerEnvironmentVariables.md#iotacointype)
1007
1127
 
1008
1128
  ***
1009
1129
 
@@ -1015,7 +1135,7 @@ IOTA Explorer Endpoint.
1015
1135
 
1016
1136
  #### Inherited from
1017
1137
 
1018
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineEnvironmentVariables.md#iotaexplorerendpoint)
1138
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineServerEnvironmentVariables.md#iotaexplorerendpoint)
1019
1139
 
1020
1140
  ***
1021
1141
 
@@ -1027,7 +1147,7 @@ IOTA Gas Station Endpoint.
1027
1147
 
1028
1148
  #### Inherited from
1029
1149
 
1030
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineEnvironmentVariables.md#iotagasstationendpoint)
1150
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineServerEnvironmentVariables.md#iotagasstationendpoint)
1031
1151
 
1032
1152
  ***
1033
1153
 
@@ -1039,7 +1159,7 @@ IOTA Gas Station Authentication Token.
1039
1159
 
1040
1160
  #### Inherited from
1041
1161
 
1042
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineEnvironmentVariables.md#iotagasstationauthtoken)
1162
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineServerEnvironmentVariables.md#iotagasstationauthtoken)
1043
1163
 
1044
1164
  ***
1045
1165
 
@@ -1051,7 +1171,7 @@ Universal Resolver Endpoint.
1051
1171
 
1052
1172
  #### Inherited from
1053
1173
 
1054
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineEnvironmentVariables.md#universalresolverendpoint)
1174
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineServerEnvironmentVariables.md#universalresolverendpoint)
1055
1175
 
1056
1176
  ***
1057
1177
 
@@ -1063,7 +1183,7 @@ The type of identity profile connector: entity-storage.
1063
1183
 
1064
1184
  #### Inherited from
1065
1185
 
1066
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`identityProfileConnector`](IEngineEnvironmentVariables.md#identityprofileconnector)
1186
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityProfileConnector`](IEngineServerEnvironmentVariables.md#identityprofileconnector)
1067
1187
 
1068
1188
  ***
1069
1189
 
@@ -1075,7 +1195,7 @@ The identity verification method id to use with immutable proofs.
1075
1195
 
1076
1196
  #### Inherited from
1077
1197
 
1078
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineEnvironmentVariables.md#immutableproofverificationmethodid)
1198
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineServerEnvironmentVariables.md#immutableproofverificationmethodid)
1079
1199
 
1080
1200
  ***
1081
1201
 
@@ -1087,7 +1207,7 @@ The type of attestation connector: entity-storage, iota.
1087
1207
 
1088
1208
  #### Inherited from
1089
1209
 
1090
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationConnector`](IEngineEnvironmentVariables.md#attestationconnector)
1210
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationConnector`](IEngineServerEnvironmentVariables.md#attestationconnector)
1091
1211
 
1092
1212
  ***
1093
1213
 
@@ -1099,7 +1219,19 @@ The identity verification method id to use with attestation.
1099
1219
 
1100
1220
  #### Inherited from
1101
1221
 
1102
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineEnvironmentVariables.md#attestationverificationmethodid)
1222
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineServerEnvironmentVariables.md#attestationverificationmethodid)
1223
+
1224
+ ***
1225
+
1226
+ ### dataProcessingEnabled?
1227
+
1228
+ > `optional` **dataProcessingEnabled**: `string`
1229
+
1230
+ Is the data processing enabled, defaults to false.
1231
+
1232
+ #### Inherited from
1233
+
1234
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataProcessingEnabled`](IEngineServerEnvironmentVariables.md#dataprocessingenabled)
1103
1235
 
1104
1236
  ***
1105
1237
 
@@ -1111,7 +1243,7 @@ The type of the default data converters, can be a comma separated list: json, xm
1111
1243
 
1112
1244
  #### Inherited from
1113
1245
 
1114
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataConverterConnectors`](IEngineEnvironmentVariables.md#dataconverterconnectors)
1246
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataConverterConnectors`](IEngineServerEnvironmentVariables.md#dataconverterconnectors)
1115
1247
 
1116
1248
  ***
1117
1249
 
@@ -1123,7 +1255,43 @@ The type of the default data extractor, can be a comma separated list: json-path
1123
1255
 
1124
1256
  #### Inherited from
1125
1257
 
1126
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineEnvironmentVariables.md#dataextractorconnectors)
1258
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineServerEnvironmentVariables.md#dataextractorconnectors)
1259
+
1260
+ ***
1261
+
1262
+ ### auditableItemGraphEnabled?
1263
+
1264
+ > `optional` **auditableItemGraphEnabled**: `string`
1265
+
1266
+ Is the auditable item graph enabled, defaults to false.
1267
+
1268
+ #### Inherited from
1269
+
1270
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemGraphEnabled`](IEngineServerEnvironmentVariables.md#auditableitemgraphenabled)
1271
+
1272
+ ***
1273
+
1274
+ ### auditableItemStreamEnabled?
1275
+
1276
+ > `optional` **auditableItemStreamEnabled**: `string`
1277
+
1278
+ Is the auditable item stream enabled, defaults to false.
1279
+
1280
+ #### Inherited from
1281
+
1282
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemStreamEnabled`](IEngineServerEnvironmentVariables.md#auditableitemstreamenabled)
1283
+
1284
+ ***
1285
+
1286
+ ### documentManagementEnabled?
1287
+
1288
+ > `optional` **documentManagementEnabled**: `string`
1289
+
1290
+ Is the document management enabled, defaults to false.
1291
+
1292
+ #### Inherited from
1293
+
1294
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`documentManagementEnabled`](IEngineServerEnvironmentVariables.md#documentmanagementenabled)
1127
1295
 
1128
1296
  ***
1129
1297
 
@@ -1135,7 +1303,7 @@ Is the synchronised storage enabled, defaults to false.
1135
1303
 
1136
1304
  #### Inherited from
1137
1305
 
1138
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineEnvironmentVariables.md#synchronisedstorageenabled)
1306
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineServerEnvironmentVariables.md#synchronisedstorageenabled)
1139
1307
 
1140
1308
  ***
1141
1309
 
@@ -1147,7 +1315,7 @@ Url which points to the api for a trusted synchronised storage node, not require
1147
1315
 
1148
1316
  #### Inherited from
1149
1317
 
1150
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineEnvironmentVariables.md#synchronisedstoragetrustedurl)
1318
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineServerEnvironmentVariables.md#synchronisedstoragetrustedurl)
1151
1319
 
1152
1320
  ***
1153
1321
 
@@ -1156,24 +1324,11 @@ Url which points to the api for a trusted synchronised storage node, not require
1156
1324
  > `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
1157
1325
 
1158
1326
  The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
1159
- This only required if using a custom verifiable storage item, otherwise it will default the the network name.
1327
+ This only required if using a custom verifiable storage item, otherwise it will default to the network name.
1160
1328
 
1161
1329
  #### Inherited from
1162
1330
 
1163
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
1164
-
1165
- ***
1166
-
1167
- ### synchronisedStorageVerificationMethodId?
1168
-
1169
- > `optional` **synchronisedStorageVerificationMethodId**: `string`
1170
-
1171
- The identity verification method id to use with synchronised storage for signing/verifying changesets.
1172
- Defaults to synchronised-storage-assertion.
1173
-
1174
- #### Inherited from
1175
-
1176
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageVerificationMethodId`](IEngineEnvironmentVariables.md#synchronisedstorageverificationmethodid)
1331
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
1177
1332
 
1178
1333
  ***
1179
1334
 
@@ -1187,7 +1342,7 @@ Defaults to synchronised-storage-blob-encryption
1187
1342
 
1188
1343
  #### Inherited from
1189
1344
 
1190
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
1345
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
1191
1346
 
1192
1347
  ***
1193
1348
 
@@ -1200,7 +1355,7 @@ Only required for trusted nodes, as regular nodes will not write encrypted data.
1200
1355
 
1201
1356
  #### Inherited from
1202
1357
 
1203
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstoragekey)
1358
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstoragekey)
1204
1359
 
1205
1360
  ***
1206
1361
 
@@ -1218,7 +1373,7 @@ How often to check for entity updates in minutes.
1218
1373
 
1219
1374
  #### Inherited from
1220
1375
 
1221
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
1376
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
1222
1377
 
1223
1378
  ***
1224
1379
 
@@ -1236,7 +1391,7 @@ Interval to perform consolidation of changesets, only used if this is a trusted
1236
1391
 
1237
1392
  #### Inherited from
1238
1393
 
1239
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
1394
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
1240
1395
 
1241
1396
  ***
1242
1397
 
@@ -1254,7 +1409,7 @@ The number of entities to process in a single consolidation batch, only used if
1254
1409
 
1255
1410
  #### Inherited from
1256
1411
 
1257
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
1412
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
1258
1413
 
1259
1414
  ***
1260
1415
 
@@ -1272,7 +1427,7 @@ The maximum number of consolidations to keep in storage, only used if this is a
1272
1427
 
1273
1428
  #### Inherited from
1274
1429
 
1275
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
1430
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineServerEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
1276
1431
 
1277
1432
  ***
1278
1433
 
@@ -1284,7 +1439,7 @@ Is the federated catalogue enabled, defaults to false.
1284
1439
 
1285
1440
  #### Inherited from
1286
1441
 
1287
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
1442
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineServerEnvironmentVariables.md#federatedcatalogueenabled)
1288
1443
 
1289
1444
  ***
1290
1445
 
@@ -1296,7 +1451,7 @@ Federated catalog TTL for the cache.
1296
1451
 
1297
1452
  #### Inherited from
1298
1453
 
1299
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineEnvironmentVariables.md#federatedcataloguecachettlms)
1454
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineServerEnvironmentVariables.md#federatedcataloguecachettlms)
1300
1455
 
1301
1456
  ***
1302
1457
 
@@ -1308,7 +1463,7 @@ Federated catalog clearing house approver list, stringified array of DIDs.
1308
1463
 
1309
1464
  #### Inherited from
1310
1465
 
1311
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
1466
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineServerEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
1312
1467
 
1313
1468
  ***
1314
1469
 
@@ -1320,7 +1475,110 @@ Is the rights management enabled, defaults to false.
1320
1475
 
1321
1476
  #### Inherited from
1322
1477
 
1323
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineEnvironmentVariables.md#rightsmanagementenabled)
1478
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineServerEnvironmentVariables.md#rightsmanagementenabled)
1479
+
1480
+ ***
1481
+
1482
+ ### rightsManagementBaseCallbackUrl?
1483
+
1484
+ > `optional` **rightsManagementBaseCallbackUrl**: `string`
1485
+
1486
+ What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
1487
+
1488
+ #### Inherited from
1489
+
1490
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineServerEnvironmentVariables.md#rightsmanagementbasecallbackurl)
1491
+
1492
+ ***
1493
+
1494
+ ### rightsManagementInformationSources?
1495
+
1496
+ > `optional` **rightsManagementInformationSources**: `string`
1497
+
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.
1500
+
1501
+ #### Inherited from
1502
+
1503
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineServerEnvironmentVariables.md#rightsmanagementinformationsources)
1504
+
1505
+ ***
1506
+
1507
+ ### rightsManagementNegotiators?
1508
+
1509
+ > `optional` **rightsManagementNegotiators**: `string`
1510
+
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.
1513
+
1514
+ #### Inherited from
1515
+
1516
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineServerEnvironmentVariables.md#rightsmanagementnegotiators)
1517
+
1518
+ ***
1519
+
1520
+ ### rightsManagementRequesters?
1521
+
1522
+ > `optional` **rightsManagementRequesters**: `string`
1523
+
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.
1526
+
1527
+ #### Inherited from
1528
+
1529
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementRequesters`](IEngineServerEnvironmentVariables.md#rightsmanagementrequesters)
1530
+
1531
+ ***
1532
+
1533
+ ### rightsManagementExecutionActions?
1534
+
1535
+ > `optional` **rightsManagementExecutionActions**: `string`
1536
+
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.
1539
+
1540
+ #### Inherited from
1541
+
1542
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineServerEnvironmentVariables.md#rightsmanagementexecutionactions)
1543
+
1544
+ ***
1545
+
1546
+ ### rightsManagementEnforcementProcessors?
1547
+
1548
+ > `optional` **rightsManagementEnforcementProcessors**: `string`
1549
+
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.
1552
+
1553
+ #### Inherited from
1554
+
1555
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineServerEnvironmentVariables.md#rightsmanagementenforcementprocessors)
1556
+
1557
+ ***
1558
+
1559
+ ### rightsManagementArbiters?
1560
+
1561
+ > `optional` **rightsManagementArbiters**: `string`
1562
+
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.
1565
+
1566
+ #### Inherited from
1567
+
1568
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementArbiters`](IEngineServerEnvironmentVariables.md#rightsmanagementarbiters)
1569
+
1570
+ ***
1571
+
1572
+ ### rightsManagementOffers?
1573
+
1574
+ > `optional` **rightsManagementOffers**: `string`
1575
+
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.
1578
+
1579
+ #### Inherited from
1580
+
1581
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementOffers`](IEngineServerEnvironmentVariables.md#rightsmanagementoffers)
1324
1582
 
1325
1583
  ***
1326
1584
 
@@ -1332,7 +1590,7 @@ Is the task scheduler enabled, defaults to false.
1332
1590
 
1333
1591
  #### Inherited from
1334
1592
 
1335
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineEnvironmentVariables.md#taskschedulerenabled)
1593
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineServerEnvironmentVariables.md#taskschedulerenabled)
1336
1594
 
1337
1595
  ***
1338
1596
 
@@ -1344,20 +1602,80 @@ Is the data space connector enabled, defaults to false.
1344
1602
 
1345
1603
  #### Inherited from
1346
1604
 
1347
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineEnvironmentVariables.md#dataspaceconnectorenabled)
1605
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineServerEnvironmentVariables.md#dataspaceconnectorenabled)
1348
1606
 
1349
1607
  ***
1350
1608
 
1351
- ### dataSpaceConnectorApps?
1609
+ ### dataSpaceConnectorRetainActivityLogsFor?
1352
1610
 
1353
- > `optional` **dataSpaceConnectorApps**: `string`
1611
+ > `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
1354
1612
 
1355
- The application configuration for the data space connector.
1356
- Use the @json: prefix to specify the path to the JSON configuration file.
1613
+ The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
1614
+
1615
+ #### Default
1616
+
1617
+ ```ts
1618
+ 10
1619
+ ```
1620
+
1621
+ #### Inherited from
1622
+
1623
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineServerEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
1624
+
1625
+ ***
1626
+
1627
+ ### dataSpaceConnectorActivityLogsCleanUpInterval?
1628
+
1629
+ > `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
1630
+
1631
+ The interval for cleaning up the activity logs.
1632
+
1633
+ #### Default
1634
+
1635
+ ```ts
1636
+ 60
1637
+ ```
1638
+
1639
+ #### Inherited from
1640
+
1641
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineServerEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
1642
+
1643
+ ***
1644
+
1645
+ ### vcAuthenticationEnabled?
1646
+
1647
+ > `optional` **vcAuthenticationEnabled**: `string`
1648
+
1649
+ Enable verifiable credential authentication for the API.
1650
+
1651
+ #### Inherited from
1652
+
1653
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineServerEnvironmentVariables.md#vcauthenticationenabled)
1654
+
1655
+ ***
1656
+
1657
+ ### vcAuthenticationVerificationMethodId?
1658
+
1659
+ > `optional` **vcAuthenticationVerificationMethodId**: `string`
1660
+
1661
+ Verifiable credential assertion for node to node communication.
1662
+ Defaults to node-authentication-assertion.
1663
+
1664
+ #### Inherited from
1665
+
1666
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineServerEnvironmentVariables.md#vcauthenticationverificationmethodid)
1667
+
1668
+ ***
1669
+
1670
+ ### extensions?
1671
+
1672
+ > `optional` **extensions**: `string`
1673
+
1674
+ A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
1357
1675
 
1358
1676
  #### Inherited from
1359
1677
 
1360
- [`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorApps`](IEngineEnvironmentVariables.md#dataspaceconnectorapps)
1678
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`extensions`](IEngineServerEnvironmentVariables.md#extensions)
1361
1679
 
1362
1680
  ***
1363
1681
 
@@ -1481,15 +1799,39 @@ Additional MIME type processors to include, comma separated.
1481
1799
 
1482
1800
  ***
1483
1801
 
1484
- ### disableNodeIdentity?
1802
+ ### routeLoggingIncludeBody?
1803
+
1804
+ > `optional` **routeLoggingIncludeBody**: `string`
1805
+
1806
+ Include the body in the REST logging output, useful for debugging.
1807
+
1808
+ #### Inherited from
1809
+
1810
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingIncludeBody`](IEngineServerEnvironmentVariables.md#routeloggingincludebody)
1811
+
1812
+ ***
1813
+
1814
+ ### routeLoggingFullBase64?
1485
1815
 
1486
- > `optional` **disableNodeIdentity**: `string`
1816
+ > `optional` **routeLoggingFullBase64**: `string`
1487
1817
 
1488
- Disable Node Identity route processors.
1818
+ Include the full base 64 output in the REST logging output, useful for debugging.
1489
1819
 
1490
1820
  #### Inherited from
1491
1821
 
1492
- [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`disableNodeIdentity`](IEngineServerEnvironmentVariables.md#disablenodeidentity)
1822
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingFullBase64`](IEngineServerEnvironmentVariables.md#routeloggingfullbase64)
1823
+
1824
+ ***
1825
+
1826
+ ### routeLoggingObfuscateProperties?
1827
+
1828
+ > `optional` **routeLoggingObfuscateProperties**: `string`
1829
+
1830
+ List of properties to obfuscate in the REST logging output, comma separated.
1831
+
1832
+ #### Inherited from
1833
+
1834
+ [`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingObfuscateProperties`](IEngineServerEnvironmentVariables.md#routeloggingobfuscateproperties)
1493
1835
 
1494
1836
  ***
1495
1837
 
@@ -1502,32 +1844,64 @@ The features that are enabled on the node.
1502
1844
  #### Default
1503
1845
 
1504
1846
  ```ts
1505
- [NodeFeatures.NodeIdentity]
1847
+ []
1506
1848
  ```
1507
1849
 
1508
1850
  ***
1509
1851
 
1510
- ### identity?
1852
+ ### nodeIdentity?
1511
1853
 
1512
- > `optional` **identity**: `string`
1854
+ > `optional` **nodeIdentity**: `string`
1513
1855
 
1514
1856
  The identity of the node which, if empty and node-identity feature is enabled it will be generated.
1515
1857
 
1516
1858
  ***
1517
1859
 
1518
- ### mnemonic?
1860
+ ### nodeMnemonic?
1519
1861
 
1520
- > `optional` **mnemonic**: `string`
1862
+ > `optional` **nodeMnemonic**: `string`
1521
1863
 
1522
1864
  The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.
1523
1865
 
1524
1866
  ***
1525
1867
 
1526
- ### username?
1868
+ ### organizationIdentity?
1869
+
1870
+ > `optional` **organizationIdentity**: `string`
1871
+
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
+ ***
1527
1875
 
1528
- > `optional` **username**: `string`
1876
+ ### organizationMnemonic?
1529
1877
 
1530
- If the node-user feature is enabled, this will be the name of the user.
1878
+ > `optional` **organizationMnemonic**: `string`
1879
+
1880
+ The mnemonic for the organization, if empty and node-admin-user feature is enabled it will be randomly generated.
1881
+
1882
+ ***
1883
+
1884
+ ### adminUserIdentity?
1885
+
1886
+ > `optional` **adminUserIdentity**: `string`
1887
+
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?
1893
+
1894
+ > `optional` **adminUserMnemonic**: `string`
1895
+
1896
+ The mnemonic for the admin user, if empty and node-admin-user feature is enabled it will be randomly generated.
1897
+
1898
+ ***
1899
+
1900
+ ### adminUserName?
1901
+
1902
+ > `optional` **adminUserName**: `string`
1903
+
1904
+ If the node-admin-user feature is enabled, this will be the name of the user.
1531
1905
 
1532
1906
  #### Default
1533
1907
 
@@ -1537,8 +1911,78 @@ admin@node
1537
1911
 
1538
1912
  ***
1539
1913
 
1540
- ### password?
1914
+ ### adminUserPassword?
1915
+
1916
+ > `optional` **adminUserPassword**: `string`
1917
+
1918
+ If the node-admin-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
1919
+
1920
+ ***
1921
+
1922
+ ### extensionsMaxSizeMb?
1923
+
1924
+ > `optional` **extensionsMaxSizeMb**: `number`
1541
1925
 
1542
- > `optional` **password**: `string`
1926
+ Maximum size in MB for HTTPS extensions downloads.
1543
1927
 
1544
- If the node-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
1928
+ #### Default
1929
+
1930
+ ```ts
1931
+ 10
1932
+ ```
1933
+
1934
+ ***
1935
+
1936
+ ### extensionsClearCache?
1937
+
1938
+ > `optional` **extensionsClearCache**: `boolean`
1939
+
1940
+ Whether to clear the extensions cache on startup.
1941
+
1942
+ #### Default
1943
+
1944
+ ```ts
1945
+ false
1946
+ ```
1947
+
1948
+ ***
1949
+
1950
+ ### extensionsCacheDirectory?
1951
+
1952
+ > `optional` **extensionsCacheDirectory**: `string`
1953
+
1954
+ Custom directory for extensions cache storage.
1955
+
1956
+ #### Default
1957
+
1958
+ ```ts
1959
+ ".tmp"
1960
+ ```
1961
+
1962
+ ***
1963
+
1964
+ ### extensionsCacheTtlHours?
1965
+
1966
+ > `optional` **extensionsCacheTtlHours**: `number`
1967
+
1968
+ TTL in hours for HTTPS extensions cache.
1969
+
1970
+ #### Default
1971
+
1972
+ ```ts
1973
+ 24
1974
+ ```
1975
+
1976
+ ***
1977
+
1978
+ ### extensionsForceRefresh?
1979
+
1980
+ > `optional` **extensionsForceRefresh**: `boolean`
1981
+
1982
+ Force refresh of all cached extensions.
1983
+
1984
+ #### Default
1985
+
1986
+ ```ts
1987
+ false
1988
+ ```