@twin.org/node-core 0.0.2-next.14 → 0.0.2-next.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +56 -74
- package/dist/esm/index.mjs +58 -76
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +20 -0
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +2 -5
- package/dist/types/models/INodeEnvironmentVariables.d.ts +1 -2
- package/docs/changelog.md +7 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +41 -1
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +1522 -10
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +179 -131
- package/package.json +1 -1
|
@@ -4,7 +4,7 @@ The environment variables for the node.
|
|
|
4
4
|
|
|
5
5
|
## Extends
|
|
6
6
|
|
|
7
|
-
- [`
|
|
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
|
-
[`
|
|
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
|
-
[`
|
|
31
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`storageFileRoot`](IEngineServerEnvironmentVariables.md#storagefileroot)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -40,7 +40,7 @@ The name of the state file.
|
|
|
40
40
|
|
|
41
41
|
#### Inherited from
|
|
42
42
|
|
|
43
|
-
[`
|
|
43
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`stateFilename`](IEngineServerEnvironmentVariables.md#statefilename)
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
@@ -53,7 +53,7 @@ values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, m
|
|
|
53
53
|
|
|
54
54
|
#### Inherited from
|
|
55
55
|
|
|
56
|
-
[`
|
|
56
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageConnectorType`](IEngineServerEnvironmentVariables.md#entitystorageconnectortype)
|
|
57
57
|
|
|
58
58
|
***
|
|
59
59
|
|
|
@@ -65,7 +65,7 @@ The default entity storage connector to use, defaults to the first one in the li
|
|
|
65
65
|
|
|
66
66
|
#### Inherited from
|
|
67
67
|
|
|
68
|
-
[`
|
|
68
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageConnectorDefault`](IEngineServerEnvironmentVariables.md#entitystorageconnectordefault)
|
|
69
69
|
|
|
70
70
|
***
|
|
71
71
|
|
|
@@ -77,7 +77,7 @@ A prefix for all the table in entity-storage, can be empty.
|
|
|
77
77
|
|
|
78
78
|
#### Inherited from
|
|
79
79
|
|
|
80
|
-
[`
|
|
80
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`entityStorageTablePrefix`](IEngineServerEnvironmentVariables.md#entitystoragetableprefix)
|
|
81
81
|
|
|
82
82
|
***
|
|
83
83
|
|
|
@@ -89,7 +89,7 @@ AWS Dynamo DB access key id.
|
|
|
89
89
|
|
|
90
90
|
#### Inherited from
|
|
91
91
|
|
|
92
|
-
[`
|
|
92
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbAccessKeyId`](IEngineServerEnvironmentVariables.md#awsdynamodbaccesskeyid)
|
|
93
93
|
|
|
94
94
|
***
|
|
95
95
|
|
|
@@ -101,7 +101,7 @@ AWS Dynamo DB Endpoint if running local instance.
|
|
|
101
101
|
|
|
102
102
|
#### Inherited from
|
|
103
103
|
|
|
104
|
-
[`
|
|
104
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbEndpoint`](IEngineServerEnvironmentVariables.md#awsdynamodbendpoint)
|
|
105
105
|
|
|
106
106
|
***
|
|
107
107
|
|
|
@@ -113,7 +113,7 @@ AWS Dynamo DB region.
|
|
|
113
113
|
|
|
114
114
|
#### Inherited from
|
|
115
115
|
|
|
116
|
-
[`
|
|
116
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineServerEnvironmentVariables.md#awsdynamodbregion)
|
|
117
117
|
|
|
118
118
|
***
|
|
119
119
|
|
|
@@ -125,7 +125,7 @@ AWS Dynamo DB secret access key.
|
|
|
125
125
|
|
|
126
126
|
#### Inherited from
|
|
127
127
|
|
|
128
|
-
[`
|
|
128
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineServerEnvironmentVariables.md#awsdynamodbsecretaccesskey)
|
|
129
129
|
|
|
130
130
|
***
|
|
131
131
|
|
|
@@ -137,7 +137,7 @@ Azure Cosmos DB key.
|
|
|
137
137
|
|
|
138
138
|
#### Inherited from
|
|
139
139
|
|
|
140
|
-
[`
|
|
140
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineServerEnvironmentVariables.md#azurecosmosdbkey)
|
|
141
141
|
|
|
142
142
|
***
|
|
143
143
|
|
|
@@ -149,7 +149,7 @@ Azure Cosmos DB container id.
|
|
|
149
149
|
|
|
150
150
|
#### Inherited from
|
|
151
151
|
|
|
152
|
-
[`
|
|
152
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineServerEnvironmentVariables.md#azurecosmosdbcontainerid)
|
|
153
153
|
|
|
154
154
|
***
|
|
155
155
|
|
|
@@ -161,7 +161,7 @@ Azure Cosmos DB database id.
|
|
|
161
161
|
|
|
162
162
|
#### Inherited from
|
|
163
163
|
|
|
164
|
-
[`
|
|
164
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineServerEnvironmentVariables.md#azurecosmosdbdatabaseid)
|
|
165
165
|
|
|
166
166
|
***
|
|
167
167
|
|
|
@@ -173,7 +173,7 @@ Azure Cosmos DB endpoint.
|
|
|
173
173
|
|
|
174
174
|
#### Inherited from
|
|
175
175
|
|
|
176
|
-
[`
|
|
176
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineServerEnvironmentVariables.md#azurecosmosdbendpoint)
|
|
177
177
|
|
|
178
178
|
***
|
|
179
179
|
|
|
@@ -185,7 +185,7 @@ GCP Firestore collection name.
|
|
|
185
185
|
|
|
186
186
|
#### Inherited from
|
|
187
187
|
|
|
188
|
-
[`
|
|
188
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineServerEnvironmentVariables.md#gcpfirestorecollectionname)
|
|
189
189
|
|
|
190
190
|
***
|
|
191
191
|
|
|
@@ -197,7 +197,7 @@ GCP Firestore credentials.
|
|
|
197
197
|
|
|
198
198
|
#### Inherited from
|
|
199
199
|
|
|
200
|
-
[`
|
|
200
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineServerEnvironmentVariables.md#gcpfirestorecredentials)
|
|
201
201
|
|
|
202
202
|
***
|
|
203
203
|
|
|
@@ -209,7 +209,7 @@ GCP Firestore database id.
|
|
|
209
209
|
|
|
210
210
|
#### Inherited from
|
|
211
211
|
|
|
212
|
-
[`
|
|
212
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineServerEnvironmentVariables.md#gcpfirestoredatabaseid)
|
|
213
213
|
|
|
214
214
|
***
|
|
215
215
|
|
|
@@ -221,7 +221,7 @@ GCP Firestore endpoint.
|
|
|
221
221
|
|
|
222
222
|
#### Inherited from
|
|
223
223
|
|
|
224
|
-
[`
|
|
224
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineServerEnvironmentVariables.md#gcpfirestoreapiendpoint)
|
|
225
225
|
|
|
226
226
|
***
|
|
227
227
|
|
|
@@ -233,7 +233,7 @@ GCP Firestore project id.
|
|
|
233
233
|
|
|
234
234
|
#### Inherited from
|
|
235
235
|
|
|
236
|
-
[`
|
|
236
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineServerEnvironmentVariables.md#gcpfirestoreprojectid)
|
|
237
237
|
|
|
238
238
|
***
|
|
239
239
|
|
|
@@ -245,7 +245,7 @@ ScyllaDB hosts as comma separated string.
|
|
|
245
245
|
|
|
246
246
|
#### Inherited from
|
|
247
247
|
|
|
248
|
-
[`
|
|
248
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbHosts`](IEngineServerEnvironmentVariables.md#scylladbhosts)
|
|
249
249
|
|
|
250
250
|
***
|
|
251
251
|
|
|
@@ -257,7 +257,7 @@ ScyllaDB keyspace.
|
|
|
257
257
|
|
|
258
258
|
#### Inherited from
|
|
259
259
|
|
|
260
|
-
[`
|
|
260
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbKeyspace`](IEngineServerEnvironmentVariables.md#scylladbkeyspace)
|
|
261
261
|
|
|
262
262
|
***
|
|
263
263
|
|
|
@@ -269,7 +269,7 @@ ScyllaDB local data center.
|
|
|
269
269
|
|
|
270
270
|
#### Inherited from
|
|
271
271
|
|
|
272
|
-
[`
|
|
272
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineServerEnvironmentVariables.md#scylladblocaldatacenter)
|
|
273
273
|
|
|
274
274
|
***
|
|
275
275
|
|
|
@@ -281,7 +281,7 @@ ScyllaDB port.
|
|
|
281
281
|
|
|
282
282
|
#### Inherited from
|
|
283
283
|
|
|
284
|
-
[`
|
|
284
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbPort`](IEngineServerEnvironmentVariables.md#scylladbport)
|
|
285
285
|
|
|
286
286
|
***
|
|
287
287
|
|
|
@@ -293,7 +293,7 @@ MySQL host.
|
|
|
293
293
|
|
|
294
294
|
#### Inherited from
|
|
295
295
|
|
|
296
|
-
[`
|
|
296
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlHost`](IEngineServerEnvironmentVariables.md#mysqlhost)
|
|
297
297
|
|
|
298
298
|
***
|
|
299
299
|
|
|
@@ -305,7 +305,7 @@ MySQL port.
|
|
|
305
305
|
|
|
306
306
|
#### Inherited from
|
|
307
307
|
|
|
308
|
-
[`
|
|
308
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPort`](IEngineServerEnvironmentVariables.md#mysqlport)
|
|
309
309
|
|
|
310
310
|
***
|
|
311
311
|
|
|
@@ -317,7 +317,7 @@ MySQL username.
|
|
|
317
317
|
|
|
318
318
|
#### Inherited from
|
|
319
319
|
|
|
320
|
-
[`
|
|
320
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlUser`](IEngineServerEnvironmentVariables.md#mysqluser)
|
|
321
321
|
|
|
322
322
|
***
|
|
323
323
|
|
|
@@ -329,7 +329,7 @@ MySQL password.
|
|
|
329
329
|
|
|
330
330
|
#### Inherited from
|
|
331
331
|
|
|
332
|
-
[`
|
|
332
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPassword`](IEngineServerEnvironmentVariables.md#mysqlpassword)
|
|
333
333
|
|
|
334
334
|
***
|
|
335
335
|
|
|
@@ -341,7 +341,7 @@ MySQL Database.
|
|
|
341
341
|
|
|
342
342
|
#### Inherited from
|
|
343
343
|
|
|
344
|
-
[`
|
|
344
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlDatabase`](IEngineServerEnvironmentVariables.md#mysqldatabase)
|
|
345
345
|
|
|
346
346
|
***
|
|
347
347
|
|
|
@@ -353,7 +353,7 @@ MongoDB host.
|
|
|
353
353
|
|
|
354
354
|
#### Inherited from
|
|
355
355
|
|
|
356
|
-
[`
|
|
356
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbHost`](IEngineServerEnvironmentVariables.md#mongodbhost)
|
|
357
357
|
|
|
358
358
|
***
|
|
359
359
|
|
|
@@ -365,7 +365,7 @@ MongoDB port.
|
|
|
365
365
|
|
|
366
366
|
#### Inherited from
|
|
367
367
|
|
|
368
|
-
[`
|
|
368
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPort`](IEngineServerEnvironmentVariables.md#mongodbport)
|
|
369
369
|
|
|
370
370
|
***
|
|
371
371
|
|
|
@@ -377,7 +377,7 @@ MongoDB username.
|
|
|
377
377
|
|
|
378
378
|
#### Inherited from
|
|
379
379
|
|
|
380
|
-
[`
|
|
380
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbUser`](IEngineServerEnvironmentVariables.md#mongodbuser)
|
|
381
381
|
|
|
382
382
|
***
|
|
383
383
|
|
|
@@ -389,7 +389,7 @@ MongoDB password.
|
|
|
389
389
|
|
|
390
390
|
#### Inherited from
|
|
391
391
|
|
|
392
|
-
[`
|
|
392
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPassword`](IEngineServerEnvironmentVariables.md#mongodbpassword)
|
|
393
393
|
|
|
394
394
|
***
|
|
395
395
|
|
|
@@ -401,7 +401,7 @@ MongoDB Database.
|
|
|
401
401
|
|
|
402
402
|
#### Inherited from
|
|
403
403
|
|
|
404
|
-
[`
|
|
404
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbDatabase`](IEngineServerEnvironmentVariables.md#mongodbdatabase)
|
|
405
405
|
|
|
406
406
|
***
|
|
407
407
|
|
|
@@ -413,7 +413,7 @@ PostgreSQl host.
|
|
|
413
413
|
|
|
414
414
|
#### Inherited from
|
|
415
415
|
|
|
416
|
-
[`
|
|
416
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlHost`](IEngineServerEnvironmentVariables.md#postgresqlhost)
|
|
417
417
|
|
|
418
418
|
***
|
|
419
419
|
|
|
@@ -425,7 +425,7 @@ PostgreSQl port.
|
|
|
425
425
|
|
|
426
426
|
#### Inherited from
|
|
427
427
|
|
|
428
|
-
[`
|
|
428
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPort`](IEngineServerEnvironmentVariables.md#postgresqlport)
|
|
429
429
|
|
|
430
430
|
***
|
|
431
431
|
|
|
@@ -437,7 +437,7 @@ PostgreSQl username.
|
|
|
437
437
|
|
|
438
438
|
#### Inherited from
|
|
439
439
|
|
|
440
|
-
[`
|
|
440
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlUser`](IEngineServerEnvironmentVariables.md#postgresqluser)
|
|
441
441
|
|
|
442
442
|
***
|
|
443
443
|
|
|
@@ -449,7 +449,7 @@ PostgreSQl password.
|
|
|
449
449
|
|
|
450
450
|
#### Inherited from
|
|
451
451
|
|
|
452
|
-
[`
|
|
452
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPassword`](IEngineServerEnvironmentVariables.md#postgresqlpassword)
|
|
453
453
|
|
|
454
454
|
***
|
|
455
455
|
|
|
@@ -461,7 +461,7 @@ PostgreSQl Database.
|
|
|
461
461
|
|
|
462
462
|
#### Inherited from
|
|
463
463
|
|
|
464
|
-
[`
|
|
464
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineServerEnvironmentVariables.md#postgresqldatabase)
|
|
465
465
|
|
|
466
466
|
***
|
|
467
467
|
|
|
@@ -473,7 +473,7 @@ The security token for accessing IPFS API.
|
|
|
473
473
|
|
|
474
474
|
#### Inherited from
|
|
475
475
|
|
|
476
|
-
[`
|
|
476
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsBearerToken`](IEngineServerEnvironmentVariables.md#ipfsbearertoken)
|
|
477
477
|
|
|
478
478
|
***
|
|
479
479
|
|
|
@@ -485,7 +485,7 @@ The url for accessing IPFS API.
|
|
|
485
485
|
|
|
486
486
|
#### Inherited from
|
|
487
487
|
|
|
488
|
-
[`
|
|
488
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsApiUrl`](IEngineServerEnvironmentVariables.md#ipfsapiurl)
|
|
489
489
|
|
|
490
490
|
***
|
|
491
491
|
|
|
@@ -498,7 +498,7 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
|
|
|
498
498
|
|
|
499
499
|
#### Inherited from
|
|
500
500
|
|
|
501
|
-
[`
|
|
501
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineServerEnvironmentVariables.md#blobstorageconnectortype)
|
|
502
502
|
|
|
503
503
|
***
|
|
504
504
|
|
|
@@ -510,7 +510,7 @@ The default blob storage connector to use, defaults to the first one in the list
|
|
|
510
510
|
|
|
511
511
|
#### Inherited from
|
|
512
512
|
|
|
513
|
-
[`
|
|
513
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineServerEnvironmentVariables.md#blobstorageconnectordefault)
|
|
514
514
|
|
|
515
515
|
***
|
|
516
516
|
|
|
@@ -522,7 +522,7 @@ Blog storage connector which has public access.
|
|
|
522
522
|
|
|
523
523
|
#### Inherited from
|
|
524
524
|
|
|
525
|
-
[`
|
|
525
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineServerEnvironmentVariables.md#blobstorageconnectorpublic)
|
|
526
526
|
|
|
527
527
|
***
|
|
528
528
|
|
|
@@ -534,7 +534,7 @@ Enable encryption for the blob storage.
|
|
|
534
534
|
|
|
535
535
|
#### Inherited from
|
|
536
536
|
|
|
537
|
-
[`
|
|
537
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineServerEnvironmentVariables.md#blobstorageenableencryption)
|
|
538
538
|
|
|
539
539
|
***
|
|
540
540
|
|
|
@@ -546,7 +546,7 @@ The id of the encryption key for the blob storage.
|
|
|
546
546
|
|
|
547
547
|
#### Inherited from
|
|
548
548
|
|
|
549
|
-
[`
|
|
549
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#blobstorageencryptionkeyid)
|
|
550
550
|
|
|
551
551
|
***
|
|
552
552
|
|
|
@@ -559,7 +559,7 @@ If encryption is enabled but a key is not provided one will be generated.
|
|
|
559
559
|
|
|
560
560
|
#### Inherited from
|
|
561
561
|
|
|
562
|
-
[`
|
|
562
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineServerEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
|
|
563
563
|
|
|
564
564
|
***
|
|
565
565
|
|
|
@@ -571,7 +571,7 @@ A prefix for all the blobs in blob-storage, can be empty.
|
|
|
571
571
|
|
|
572
572
|
#### Inherited from
|
|
573
573
|
|
|
574
|
-
[`
|
|
574
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStoragePrefix`](IEngineServerEnvironmentVariables.md#blobstorageprefix)
|
|
575
575
|
|
|
576
576
|
***
|
|
577
577
|
|
|
@@ -583,7 +583,7 @@ AWS S3 access key id.
|
|
|
583
583
|
|
|
584
584
|
#### Inherited from
|
|
585
585
|
|
|
586
|
-
[`
|
|
586
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineServerEnvironmentVariables.md#awss3accesskeyid)
|
|
587
587
|
|
|
588
588
|
***
|
|
589
589
|
|
|
@@ -595,7 +595,7 @@ AWS S3 bucket name.
|
|
|
595
595
|
|
|
596
596
|
#### Inherited from
|
|
597
597
|
|
|
598
|
-
[`
|
|
598
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3BucketName`](IEngineServerEnvironmentVariables.md#awss3bucketname)
|
|
599
599
|
|
|
600
600
|
***
|
|
601
601
|
|
|
@@ -607,7 +607,7 @@ AWS S3 endpoint.
|
|
|
607
607
|
|
|
608
608
|
#### Inherited from
|
|
609
609
|
|
|
610
|
-
[`
|
|
610
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Endpoint`](IEngineServerEnvironmentVariables.md#awss3endpoint)
|
|
611
611
|
|
|
612
612
|
***
|
|
613
613
|
|
|
@@ -619,7 +619,7 @@ AWS S3 region.
|
|
|
619
619
|
|
|
620
620
|
#### Inherited from
|
|
621
621
|
|
|
622
|
-
[`
|
|
622
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Region`](IEngineServerEnvironmentVariables.md#awss3region)
|
|
623
623
|
|
|
624
624
|
***
|
|
625
625
|
|
|
@@ -631,7 +631,7 @@ AWS S3 secret access key.
|
|
|
631
631
|
|
|
632
632
|
#### Inherited from
|
|
633
633
|
|
|
634
|
-
[`
|
|
634
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineServerEnvironmentVariables.md#awss3secretaccesskey)
|
|
635
635
|
|
|
636
636
|
***
|
|
637
637
|
|
|
@@ -643,7 +643,7 @@ Azure Storage account key.
|
|
|
643
643
|
|
|
644
644
|
#### Inherited from
|
|
645
645
|
|
|
646
|
-
[`
|
|
646
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineServerEnvironmentVariables.md#azurestorageaccountkey)
|
|
647
647
|
|
|
648
648
|
***
|
|
649
649
|
|
|
@@ -655,7 +655,7 @@ Azure Storage account name.
|
|
|
655
655
|
|
|
656
656
|
#### Inherited from
|
|
657
657
|
|
|
658
|
-
[`
|
|
658
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountName`](IEngineServerEnvironmentVariables.md#azurestorageaccountname)
|
|
659
659
|
|
|
660
660
|
***
|
|
661
661
|
|
|
@@ -667,7 +667,7 @@ Azure Storage container.
|
|
|
667
667
|
|
|
668
668
|
#### Inherited from
|
|
669
669
|
|
|
670
|
-
[`
|
|
670
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageContainerName`](IEngineServerEnvironmentVariables.md#azurestoragecontainername)
|
|
671
671
|
|
|
672
672
|
***
|
|
673
673
|
|
|
@@ -679,7 +679,7 @@ Azure Storage endpoint.
|
|
|
679
679
|
|
|
680
680
|
#### Inherited from
|
|
681
681
|
|
|
682
|
-
[`
|
|
682
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineServerEnvironmentVariables.md#azurestorageendpoint)
|
|
683
683
|
|
|
684
684
|
***
|
|
685
685
|
|
|
@@ -691,7 +691,7 @@ GCP Storage bucket.
|
|
|
691
691
|
|
|
692
692
|
#### Inherited from
|
|
693
693
|
|
|
694
|
-
[`
|
|
694
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineServerEnvironmentVariables.md#gcpstoragebucketname)
|
|
695
695
|
|
|
696
696
|
***
|
|
697
697
|
|
|
@@ -703,7 +703,7 @@ GCP Storage credentials.
|
|
|
703
703
|
|
|
704
704
|
#### Inherited from
|
|
705
705
|
|
|
706
|
-
[`
|
|
706
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineServerEnvironmentVariables.md#gcpstoragecredentials)
|
|
707
707
|
|
|
708
708
|
***
|
|
709
709
|
|
|
@@ -715,7 +715,7 @@ GCP Storage endpoint.
|
|
|
715
715
|
|
|
716
716
|
#### Inherited from
|
|
717
717
|
|
|
718
|
-
[`
|
|
718
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineServerEnvironmentVariables.md#gcpstorageendpoint)
|
|
719
719
|
|
|
720
720
|
***
|
|
721
721
|
|
|
@@ -727,7 +727,7 @@ GCP Storage project id.
|
|
|
727
727
|
|
|
728
728
|
#### Inherited from
|
|
729
729
|
|
|
730
|
-
[`
|
|
730
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineServerEnvironmentVariables.md#gcpstorageprojectid)
|
|
731
731
|
|
|
732
732
|
***
|
|
733
733
|
|
|
@@ -739,7 +739,7 @@ The type of the default vault connector: entity-storage, hashicorp.
|
|
|
739
739
|
|
|
740
740
|
#### Inherited from
|
|
741
741
|
|
|
742
|
-
[`
|
|
742
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vaultConnector`](IEngineServerEnvironmentVariables.md#vaultconnector)
|
|
743
743
|
|
|
744
744
|
***
|
|
745
745
|
|
|
@@ -751,7 +751,7 @@ Hashicorp Vault token.
|
|
|
751
751
|
|
|
752
752
|
#### Inherited from
|
|
753
753
|
|
|
754
|
-
[`
|
|
754
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineServerEnvironmentVariables.md#hashicorpvaulttoken)
|
|
755
755
|
|
|
756
756
|
***
|
|
757
757
|
|
|
@@ -763,7 +763,7 @@ Hashicorp Vault endpoint.
|
|
|
763
763
|
|
|
764
764
|
#### Inherited from
|
|
765
765
|
|
|
766
|
-
[`
|
|
766
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineServerEnvironmentVariables.md#hashicorpvaultendpoint)
|
|
767
767
|
|
|
768
768
|
***
|
|
769
769
|
|
|
@@ -775,7 +775,7 @@ The type of logging task connector, can be a comma separated list: console, enti
|
|
|
775
775
|
|
|
776
776
|
#### Inherited from
|
|
777
777
|
|
|
778
|
-
[`
|
|
778
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`loggingConnector`](IEngineServerEnvironmentVariables.md#loggingconnector)
|
|
779
779
|
|
|
780
780
|
***
|
|
781
781
|
|
|
@@ -787,7 +787,7 @@ The type of background task connector: entity-storage.
|
|
|
787
787
|
|
|
788
788
|
#### Inherited from
|
|
789
789
|
|
|
790
|
-
[`
|
|
790
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`backgroundTaskConnector`](IEngineServerEnvironmentVariables.md#backgroundtaskconnector)
|
|
791
791
|
|
|
792
792
|
***
|
|
793
793
|
|
|
@@ -799,7 +799,7 @@ The type of event bus connector: local.
|
|
|
799
799
|
|
|
800
800
|
#### Inherited from
|
|
801
801
|
|
|
802
|
-
[`
|
|
802
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusConnector`](IEngineServerEnvironmentVariables.md#eventbusconnector)
|
|
803
803
|
|
|
804
804
|
***
|
|
805
805
|
|
|
@@ -811,7 +811,7 @@ The type of event bus component: service.
|
|
|
811
811
|
|
|
812
812
|
#### Inherited from
|
|
813
813
|
|
|
814
|
-
[`
|
|
814
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusComponent`](IEngineServerEnvironmentVariables.md#eventbuscomponent)
|
|
815
815
|
|
|
816
816
|
***
|
|
817
817
|
|
|
@@ -823,7 +823,7 @@ The type of messaging email connector: entity-storage, aws.
|
|
|
823
823
|
|
|
824
824
|
#### Inherited from
|
|
825
825
|
|
|
826
|
-
[`
|
|
826
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingEmailConnector`](IEngineServerEnvironmentVariables.md#messagingemailconnector)
|
|
827
827
|
|
|
828
828
|
***
|
|
829
829
|
|
|
@@ -835,7 +835,7 @@ The type of messaging sms connector: entity-storage, aws.
|
|
|
835
835
|
|
|
836
836
|
#### Inherited from
|
|
837
837
|
|
|
838
|
-
[`
|
|
838
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingSmsConnector`](IEngineServerEnvironmentVariables.md#messagingsmsconnector)
|
|
839
839
|
|
|
840
840
|
***
|
|
841
841
|
|
|
@@ -847,7 +847,7 @@ The type of messaging push notification connector: entity-storage, aws.
|
|
|
847
847
|
|
|
848
848
|
#### Inherited from
|
|
849
849
|
|
|
850
|
-
[`
|
|
850
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineServerEnvironmentVariables.md#messagingpushnotificationconnector)
|
|
851
851
|
|
|
852
852
|
***
|
|
853
853
|
|
|
@@ -859,7 +859,7 @@ The applications for the push notifications JSON stringified array of IAwsApplic
|
|
|
859
859
|
|
|
860
860
|
#### Inherited from
|
|
861
861
|
|
|
862
|
-
[`
|
|
862
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineServerEnvironmentVariables.md#awsmessagingpushnotificationapplications)
|
|
863
863
|
|
|
864
864
|
***
|
|
865
865
|
|
|
@@ -871,7 +871,7 @@ The type of messaging component: service.
|
|
|
871
871
|
|
|
872
872
|
#### Inherited from
|
|
873
873
|
|
|
874
|
-
[`
|
|
874
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingComponent`](IEngineServerEnvironmentVariables.md#messagingcomponent)
|
|
875
875
|
|
|
876
876
|
***
|
|
877
877
|
|
|
@@ -883,7 +883,7 @@ The type of telemetry connector: entity-storage.
|
|
|
883
883
|
|
|
884
884
|
#### Inherited from
|
|
885
885
|
|
|
886
|
-
[`
|
|
886
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`telemetryConnector`](IEngineServerEnvironmentVariables.md#telemetryconnector)
|
|
887
887
|
|
|
888
888
|
***
|
|
889
889
|
|
|
@@ -895,7 +895,7 @@ The type of faucet connector: entity-storage, iota.
|
|
|
895
895
|
|
|
896
896
|
#### Inherited from
|
|
897
897
|
|
|
898
|
-
[`
|
|
898
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`faucetConnector`](IEngineServerEnvironmentVariables.md#faucetconnector)
|
|
899
899
|
|
|
900
900
|
***
|
|
901
901
|
|
|
@@ -907,7 +907,7 @@ The type of wallet connector: entity-storage, iota.
|
|
|
907
907
|
|
|
908
908
|
#### Inherited from
|
|
909
909
|
|
|
910
|
-
[`
|
|
910
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`walletConnector`](IEngineServerEnvironmentVariables.md#walletconnector)
|
|
911
911
|
|
|
912
912
|
***
|
|
913
913
|
|
|
@@ -919,7 +919,7 @@ The type of NFT connector: entity-storage, iota.
|
|
|
919
919
|
|
|
920
920
|
#### Inherited from
|
|
921
921
|
|
|
922
|
-
[`
|
|
922
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`nftConnector`](IEngineServerEnvironmentVariables.md#nftconnector)
|
|
923
923
|
|
|
924
924
|
***
|
|
925
925
|
|
|
@@ -931,7 +931,7 @@ The type of identity connector: entity-storage, iota.
|
|
|
931
931
|
|
|
932
932
|
#### Inherited from
|
|
933
933
|
|
|
934
|
-
[`
|
|
934
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityConnector`](IEngineServerEnvironmentVariables.md#identityconnector)
|
|
935
935
|
|
|
936
936
|
***
|
|
937
937
|
|
|
@@ -943,7 +943,7 @@ The type of identity resolver connector: entity-storage, iota.
|
|
|
943
943
|
|
|
944
944
|
#### Inherited from
|
|
945
945
|
|
|
946
|
-
[`
|
|
946
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityResolverConnector`](IEngineServerEnvironmentVariables.md#identityresolverconnector)
|
|
947
947
|
|
|
948
948
|
***
|
|
949
949
|
|
|
@@ -955,7 +955,7 @@ The type of verifiable storage connector: entity-storage, iota.
|
|
|
955
955
|
|
|
956
956
|
#### Inherited from
|
|
957
957
|
|
|
958
|
-
[`
|
|
958
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineServerEnvironmentVariables.md#verifiablestorageconnector)
|
|
959
959
|
|
|
960
960
|
***
|
|
961
961
|
|
|
@@ -967,7 +967,7 @@ IOTA Faucet Endpoint.
|
|
|
967
967
|
|
|
968
968
|
#### Inherited from
|
|
969
969
|
|
|
970
|
-
[`
|
|
970
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineServerEnvironmentVariables.md#iotafaucetendpoint)
|
|
971
971
|
|
|
972
972
|
***
|
|
973
973
|
|
|
@@ -979,7 +979,7 @@ IOTA Node Endpoint.
|
|
|
979
979
|
|
|
980
980
|
#### Inherited from
|
|
981
981
|
|
|
982
|
-
[`
|
|
982
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineServerEnvironmentVariables.md#iotanodeendpoint)
|
|
983
983
|
|
|
984
984
|
***
|
|
985
985
|
|
|
@@ -991,7 +991,7 @@ IOTA network.
|
|
|
991
991
|
|
|
992
992
|
#### Inherited from
|
|
993
993
|
|
|
994
|
-
[`
|
|
994
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNetwork`](IEngineServerEnvironmentVariables.md#iotanetwork)
|
|
995
995
|
|
|
996
996
|
***
|
|
997
997
|
|
|
@@ -1003,7 +1003,7 @@ IOTA coin type.
|
|
|
1003
1003
|
|
|
1004
1004
|
#### Inherited from
|
|
1005
1005
|
|
|
1006
|
-
[`
|
|
1006
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaCoinType`](IEngineServerEnvironmentVariables.md#iotacointype)
|
|
1007
1007
|
|
|
1008
1008
|
***
|
|
1009
1009
|
|
|
@@ -1015,7 +1015,7 @@ IOTA Explorer Endpoint.
|
|
|
1015
1015
|
|
|
1016
1016
|
#### Inherited from
|
|
1017
1017
|
|
|
1018
|
-
[`
|
|
1018
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineServerEnvironmentVariables.md#iotaexplorerendpoint)
|
|
1019
1019
|
|
|
1020
1020
|
***
|
|
1021
1021
|
|
|
@@ -1027,7 +1027,7 @@ IOTA Gas Station Endpoint.
|
|
|
1027
1027
|
|
|
1028
1028
|
#### Inherited from
|
|
1029
1029
|
|
|
1030
|
-
[`
|
|
1030
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineServerEnvironmentVariables.md#iotagasstationendpoint)
|
|
1031
1031
|
|
|
1032
1032
|
***
|
|
1033
1033
|
|
|
@@ -1039,7 +1039,7 @@ IOTA Gas Station Authentication Token.
|
|
|
1039
1039
|
|
|
1040
1040
|
#### Inherited from
|
|
1041
1041
|
|
|
1042
|
-
[`
|
|
1042
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineServerEnvironmentVariables.md#iotagasstationauthtoken)
|
|
1043
1043
|
|
|
1044
1044
|
***
|
|
1045
1045
|
|
|
@@ -1051,7 +1051,7 @@ Universal Resolver Endpoint.
|
|
|
1051
1051
|
|
|
1052
1052
|
#### Inherited from
|
|
1053
1053
|
|
|
1054
|
-
[`
|
|
1054
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineServerEnvironmentVariables.md#universalresolverendpoint)
|
|
1055
1055
|
|
|
1056
1056
|
***
|
|
1057
1057
|
|
|
@@ -1063,7 +1063,7 @@ The type of identity profile connector: entity-storage.
|
|
|
1063
1063
|
|
|
1064
1064
|
#### Inherited from
|
|
1065
1065
|
|
|
1066
|
-
[`
|
|
1066
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityProfileConnector`](IEngineServerEnvironmentVariables.md#identityprofileconnector)
|
|
1067
1067
|
|
|
1068
1068
|
***
|
|
1069
1069
|
|
|
@@ -1075,7 +1075,7 @@ The identity verification method id to use with immutable proofs.
|
|
|
1075
1075
|
|
|
1076
1076
|
#### Inherited from
|
|
1077
1077
|
|
|
1078
|
-
[`
|
|
1078
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineServerEnvironmentVariables.md#immutableproofverificationmethodid)
|
|
1079
1079
|
|
|
1080
1080
|
***
|
|
1081
1081
|
|
|
@@ -1087,7 +1087,7 @@ The type of attestation connector: entity-storage, iota.
|
|
|
1087
1087
|
|
|
1088
1088
|
#### Inherited from
|
|
1089
1089
|
|
|
1090
|
-
[`
|
|
1090
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationConnector`](IEngineServerEnvironmentVariables.md#attestationconnector)
|
|
1091
1091
|
|
|
1092
1092
|
***
|
|
1093
1093
|
|
|
@@ -1099,7 +1099,19 @@ The identity verification method id to use with attestation.
|
|
|
1099
1099
|
|
|
1100
1100
|
#### Inherited from
|
|
1101
1101
|
|
|
1102
|
-
[`
|
|
1102
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineServerEnvironmentVariables.md#attestationverificationmethodid)
|
|
1103
|
+
|
|
1104
|
+
***
|
|
1105
|
+
|
|
1106
|
+
### dataProcessingEnabled?
|
|
1107
|
+
|
|
1108
|
+
> `optional` **dataProcessingEnabled**: `string`
|
|
1109
|
+
|
|
1110
|
+
Is the data processing enabled, defaults to false.
|
|
1111
|
+
|
|
1112
|
+
#### Inherited from
|
|
1113
|
+
|
|
1114
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataProcessingEnabled`](IEngineServerEnvironmentVariables.md#dataprocessingenabled)
|
|
1103
1115
|
|
|
1104
1116
|
***
|
|
1105
1117
|
|
|
@@ -1111,7 +1123,7 @@ The type of the default data converters, can be a comma separated list: json, xm
|
|
|
1111
1123
|
|
|
1112
1124
|
#### Inherited from
|
|
1113
1125
|
|
|
1114
|
-
[`
|
|
1126
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataConverterConnectors`](IEngineServerEnvironmentVariables.md#dataconverterconnectors)
|
|
1115
1127
|
|
|
1116
1128
|
***
|
|
1117
1129
|
|
|
@@ -1123,7 +1135,43 @@ The type of the default data extractor, can be a comma separated list: json-path
|
|
|
1123
1135
|
|
|
1124
1136
|
#### Inherited from
|
|
1125
1137
|
|
|
1126
|
-
[`
|
|
1138
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineServerEnvironmentVariables.md#dataextractorconnectors)
|
|
1139
|
+
|
|
1140
|
+
***
|
|
1141
|
+
|
|
1142
|
+
### auditableItemGraphEnabled?
|
|
1143
|
+
|
|
1144
|
+
> `optional` **auditableItemGraphEnabled**: `string`
|
|
1145
|
+
|
|
1146
|
+
Is the auditable item graph enabled, defaults to false.
|
|
1147
|
+
|
|
1148
|
+
#### Inherited from
|
|
1149
|
+
|
|
1150
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemGraphEnabled`](IEngineServerEnvironmentVariables.md#auditableitemgraphenabled)
|
|
1151
|
+
|
|
1152
|
+
***
|
|
1153
|
+
|
|
1154
|
+
### auditableItemStreamEnabled?
|
|
1155
|
+
|
|
1156
|
+
> `optional` **auditableItemStreamEnabled**: `string`
|
|
1157
|
+
|
|
1158
|
+
Is the auditable item stream enabled, defaults to false.
|
|
1159
|
+
|
|
1160
|
+
#### Inherited from
|
|
1161
|
+
|
|
1162
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemStreamEnabled`](IEngineServerEnvironmentVariables.md#auditableitemstreamenabled)
|
|
1163
|
+
|
|
1164
|
+
***
|
|
1165
|
+
|
|
1166
|
+
### documentManagementEnabled?
|
|
1167
|
+
|
|
1168
|
+
> `optional` **documentManagementEnabled**: `string`
|
|
1169
|
+
|
|
1170
|
+
Is the document management enabled, defaults to false.
|
|
1171
|
+
|
|
1172
|
+
#### Inherited from
|
|
1173
|
+
|
|
1174
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`documentManagementEnabled`](IEngineServerEnvironmentVariables.md#documentmanagementenabled)
|
|
1127
1175
|
|
|
1128
1176
|
***
|
|
1129
1177
|
|
|
@@ -1135,7 +1183,7 @@ Is the synchronised storage enabled, defaults to false.
|
|
|
1135
1183
|
|
|
1136
1184
|
#### Inherited from
|
|
1137
1185
|
|
|
1138
|
-
[`
|
|
1186
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineServerEnvironmentVariables.md#synchronisedstorageenabled)
|
|
1139
1187
|
|
|
1140
1188
|
***
|
|
1141
1189
|
|
|
@@ -1147,7 +1195,7 @@ Url which points to the api for a trusted synchronised storage node, not require
|
|
|
1147
1195
|
|
|
1148
1196
|
#### Inherited from
|
|
1149
1197
|
|
|
1150
|
-
[`
|
|
1198
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineServerEnvironmentVariables.md#synchronisedstoragetrustedurl)
|
|
1151
1199
|
|
|
1152
1200
|
***
|
|
1153
1201
|
|
|
@@ -1160,7 +1208,7 @@ This only required if using a custom verifiable storage item, otherwise it will
|
|
|
1160
1208
|
|
|
1161
1209
|
#### Inherited from
|
|
1162
1210
|
|
|
1163
|
-
[`
|
|
1211
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
|
|
1164
1212
|
|
|
1165
1213
|
***
|
|
1166
1214
|
|
|
@@ -1174,7 +1222,7 @@ Defaults to synchronised-storage-blob-encryption
|
|
|
1174
1222
|
|
|
1175
1223
|
#### Inherited from
|
|
1176
1224
|
|
|
1177
|
-
[`
|
|
1225
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
|
|
1178
1226
|
|
|
1179
1227
|
***
|
|
1180
1228
|
|
|
@@ -1187,7 +1235,7 @@ Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
|
1187
1235
|
|
|
1188
1236
|
#### Inherited from
|
|
1189
1237
|
|
|
1190
|
-
[`
|
|
1238
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstoragekey)
|
|
1191
1239
|
|
|
1192
1240
|
***
|
|
1193
1241
|
|
|
@@ -1205,7 +1253,7 @@ How often to check for entity updates in minutes.
|
|
|
1205
1253
|
|
|
1206
1254
|
#### Inherited from
|
|
1207
1255
|
|
|
1208
|
-
[`
|
|
1256
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
|
|
1209
1257
|
|
|
1210
1258
|
***
|
|
1211
1259
|
|
|
@@ -1223,7 +1271,7 @@ Interval to perform consolidation of changesets, only used if this is a trusted
|
|
|
1223
1271
|
|
|
1224
1272
|
#### Inherited from
|
|
1225
1273
|
|
|
1226
|
-
[`
|
|
1274
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
|
|
1227
1275
|
|
|
1228
1276
|
***
|
|
1229
1277
|
|
|
@@ -1241,7 +1289,7 @@ The number of entities to process in a single consolidation batch, only used if
|
|
|
1241
1289
|
|
|
1242
1290
|
#### Inherited from
|
|
1243
1291
|
|
|
1244
|
-
[`
|
|
1292
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
|
|
1245
1293
|
|
|
1246
1294
|
***
|
|
1247
1295
|
|
|
@@ -1259,7 +1307,7 @@ The maximum number of consolidations to keep in storage, only used if this is a
|
|
|
1259
1307
|
|
|
1260
1308
|
#### Inherited from
|
|
1261
1309
|
|
|
1262
|
-
[`
|
|
1310
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineServerEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
|
|
1263
1311
|
|
|
1264
1312
|
***
|
|
1265
1313
|
|
|
@@ -1271,7 +1319,7 @@ Is the federated catalogue enabled, defaults to false.
|
|
|
1271
1319
|
|
|
1272
1320
|
#### Inherited from
|
|
1273
1321
|
|
|
1274
|
-
[`
|
|
1322
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineServerEnvironmentVariables.md#federatedcatalogueenabled)
|
|
1275
1323
|
|
|
1276
1324
|
***
|
|
1277
1325
|
|
|
@@ -1283,7 +1331,7 @@ Federated catalog TTL for the cache.
|
|
|
1283
1331
|
|
|
1284
1332
|
#### Inherited from
|
|
1285
1333
|
|
|
1286
|
-
[`
|
|
1334
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueCacheTtlMs`](IEngineServerEnvironmentVariables.md#federatedcataloguecachettlms)
|
|
1287
1335
|
|
|
1288
1336
|
***
|
|
1289
1337
|
|
|
@@ -1295,7 +1343,7 @@ Federated catalog clearing house approver list, stringified array of DIDs.
|
|
|
1295
1343
|
|
|
1296
1344
|
#### Inherited from
|
|
1297
1345
|
|
|
1298
|
-
[`
|
|
1346
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueClearingHouseApproverList`](IEngineServerEnvironmentVariables.md#federatedcatalogueclearinghouseapproverlist)
|
|
1299
1347
|
|
|
1300
1348
|
***
|
|
1301
1349
|
|
|
@@ -1307,7 +1355,7 @@ Is the rights management enabled, defaults to false.
|
|
|
1307
1355
|
|
|
1308
1356
|
#### Inherited from
|
|
1309
1357
|
|
|
1310
|
-
[`
|
|
1358
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineServerEnvironmentVariables.md#rightsmanagementenabled)
|
|
1311
1359
|
|
|
1312
1360
|
***
|
|
1313
1361
|
|
|
@@ -1319,7 +1367,7 @@ What is the base callback url for rights management negotiations e.g. https://my
|
|
|
1319
1367
|
|
|
1320
1368
|
#### Inherited from
|
|
1321
1369
|
|
|
1322
|
-
[`
|
|
1370
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineServerEnvironmentVariables.md#rightsmanagementbasecallbackurl)
|
|
1323
1371
|
|
|
1324
1372
|
***
|
|
1325
1373
|
|
|
@@ -1332,7 +1380,7 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1332
1380
|
|
|
1333
1381
|
#### Inherited from
|
|
1334
1382
|
|
|
1335
|
-
[`
|
|
1383
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementInformationSources`](IEngineServerEnvironmentVariables.md#rightsmanagementinformationsources)
|
|
1336
1384
|
|
|
1337
1385
|
***
|
|
1338
1386
|
|
|
@@ -1345,7 +1393,7 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1345
1393
|
|
|
1346
1394
|
#### Inherited from
|
|
1347
1395
|
|
|
1348
|
-
[`
|
|
1396
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementNegotiators`](IEngineServerEnvironmentVariables.md#rightsmanagementnegotiators)
|
|
1349
1397
|
|
|
1350
1398
|
***
|
|
1351
1399
|
|
|
@@ -1358,7 +1406,7 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1358
1406
|
|
|
1359
1407
|
#### Inherited from
|
|
1360
1408
|
|
|
1361
|
-
[`
|
|
1409
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementRequesters`](IEngineServerEnvironmentVariables.md#rightsmanagementrequesters)
|
|
1362
1410
|
|
|
1363
1411
|
***
|
|
1364
1412
|
|
|
@@ -1371,7 +1419,7 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1371
1419
|
|
|
1372
1420
|
#### Inherited from
|
|
1373
1421
|
|
|
1374
|
-
[`
|
|
1422
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementExecutionActions`](IEngineServerEnvironmentVariables.md#rightsmanagementexecutionactions)
|
|
1375
1423
|
|
|
1376
1424
|
***
|
|
1377
1425
|
|
|
@@ -1384,7 +1432,7 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1384
1432
|
|
|
1385
1433
|
#### Inherited from
|
|
1386
1434
|
|
|
1387
|
-
[`
|
|
1435
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnforcementProcessors`](IEngineServerEnvironmentVariables.md#rightsmanagementenforcementprocessors)
|
|
1388
1436
|
|
|
1389
1437
|
***
|
|
1390
1438
|
|
|
@@ -1397,7 +1445,7 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1397
1445
|
|
|
1398
1446
|
#### Inherited from
|
|
1399
1447
|
|
|
1400
|
-
[`
|
|
1448
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementArbiters`](IEngineServerEnvironmentVariables.md#rightsmanagementarbiters)
|
|
1401
1449
|
|
|
1402
1450
|
***
|
|
1403
1451
|
|
|
@@ -1410,7 +1458,7 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1410
1458
|
|
|
1411
1459
|
#### Inherited from
|
|
1412
1460
|
|
|
1413
|
-
[`
|
|
1461
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementOffers`](IEngineServerEnvironmentVariables.md#rightsmanagementoffers)
|
|
1414
1462
|
|
|
1415
1463
|
***
|
|
1416
1464
|
|
|
@@ -1422,7 +1470,7 @@ Is the task scheduler enabled, defaults to false.
|
|
|
1422
1470
|
|
|
1423
1471
|
#### Inherited from
|
|
1424
1472
|
|
|
1425
|
-
[`
|
|
1473
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineServerEnvironmentVariables.md#taskschedulerenabled)
|
|
1426
1474
|
|
|
1427
1475
|
***
|
|
1428
1476
|
|
|
@@ -1434,7 +1482,7 @@ Is the data space connector enabled, defaults to false.
|
|
|
1434
1482
|
|
|
1435
1483
|
#### Inherited from
|
|
1436
1484
|
|
|
1437
|
-
[`
|
|
1485
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineServerEnvironmentVariables.md#dataspaceconnectorenabled)
|
|
1438
1486
|
|
|
1439
1487
|
***
|
|
1440
1488
|
|
|
@@ -1447,7 +1495,19 @@ Use the @json: prefix to specify the path to the JSON configuration file.
|
|
|
1447
1495
|
|
|
1448
1496
|
#### Inherited from
|
|
1449
1497
|
|
|
1450
|
-
[`
|
|
1498
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorApps`](IEngineServerEnvironmentVariables.md#dataspaceconnectorapps)
|
|
1499
|
+
|
|
1500
|
+
***
|
|
1501
|
+
|
|
1502
|
+
### vcAuthenticationEnabled?
|
|
1503
|
+
|
|
1504
|
+
> `optional` **vcAuthenticationEnabled**: `string`
|
|
1505
|
+
|
|
1506
|
+
Enable verifiable credential authentication for the API.
|
|
1507
|
+
|
|
1508
|
+
#### Inherited from
|
|
1509
|
+
|
|
1510
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineServerEnvironmentVariables.md#vcauthenticationenabled)
|
|
1451
1511
|
|
|
1452
1512
|
***
|
|
1453
1513
|
|
|
@@ -1460,7 +1520,7 @@ Defaults to node-authentication-assertion.
|
|
|
1460
1520
|
|
|
1461
1521
|
#### Inherited from
|
|
1462
1522
|
|
|
1463
|
-
[`
|
|
1523
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineServerEnvironmentVariables.md#vcauthenticationverificationmethodid)
|
|
1464
1524
|
|
|
1465
1525
|
***
|
|
1466
1526
|
|
|
@@ -1584,18 +1644,6 @@ Additional MIME type processors to include, comma separated.
|
|
|
1584
1644
|
|
|
1585
1645
|
***
|
|
1586
1646
|
|
|
1587
|
-
### enableVerifiableCredentialRouteProcessors?
|
|
1588
|
-
|
|
1589
|
-
> `optional` **enableVerifiableCredentialRouteProcessors**: `string`
|
|
1590
|
-
|
|
1591
|
-
Enable to the route processor for verifiable credentials.
|
|
1592
|
-
|
|
1593
|
-
#### Inherited from
|
|
1594
|
-
|
|
1595
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`enableVerifiableCredentialRouteProcessors`](IEngineServerEnvironmentVariables.md#enableverifiablecredentialrouteprocessors)
|
|
1596
|
-
|
|
1597
|
-
***
|
|
1598
|
-
|
|
1599
1647
|
### disableNodeIdentity?
|
|
1600
1648
|
|
|
1601
1649
|
> `optional` **disableNodeIdentity**: `string`
|