@twin.org/node-core 0.0.2-next.9 → 0.0.3-next.10
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/README.md +1 -1
- package/dist/es/builders/engineEnvBuilder.js +1132 -0
- package/dist/es/builders/engineEnvBuilder.js.map +1 -0
- package/dist/es/builders/engineServerEnvBuilder.js +206 -0
- package/dist/es/builders/engineServerEnvBuilder.js.map +1 -0
- package/dist/es/builders/extensionsBuilder.js +109 -0
- package/dist/es/builders/extensionsBuilder.js.map +1 -0
- package/dist/es/cli.js +255 -0
- package/dist/es/cli.js.map +1 -0
- package/dist/es/commands/bootstrapLegacy.js +175 -0
- package/dist/es/commands/bootstrapLegacy.js.map +1 -0
- package/dist/es/commands/help.js +85 -0
- package/dist/es/commands/help.js.map +1 -0
- package/dist/es/commands/identityCreate.js +310 -0
- package/dist/es/commands/identityCreate.js.map +1 -0
- package/dist/es/commands/identityImports.js +76 -0
- package/dist/es/commands/identityImports.js.map +1 -0
- package/dist/es/commands/identityVerifiableCredentialCreate.js +140 -0
- package/dist/es/commands/identityVerifiableCredentialCreate.js.map +1 -0
- package/dist/es/commands/identityVerificationMethodCreate.js +208 -0
- package/dist/es/commands/identityVerificationMethodCreate.js.map +1 -0
- package/dist/es/commands/identityVerificationMethodImport.js +120 -0
- package/dist/es/commands/identityVerificationMethodImport.js.map +1 -0
- package/dist/es/commands/nodeSetIdentity.js +51 -0
- package/dist/es/commands/nodeSetIdentity.js.map +1 -0
- package/dist/es/commands/nodeSetTenant.js +49 -0
- package/dist/es/commands/nodeSetTenant.js.map +1 -0
- package/dist/es/commands/tenantCreate.js +120 -0
- package/dist/es/commands/tenantCreate.js.map +1 -0
- package/dist/es/commands/tenantImport.js +78 -0
- package/dist/es/commands/tenantImport.js.map +1 -0
- package/dist/es/commands/userCreate.js +197 -0
- package/dist/es/commands/userCreate.js.map +1 -0
- package/dist/es/commands/vaultKeyCreate.js +185 -0
- package/dist/es/commands/vaultKeyCreate.js.map +1 -0
- package/dist/es/commands/vaultKeyImport.js +98 -0
- package/dist/es/commands/vaultKeyImport.js.map +1 -0
- package/dist/es/defaults.js +28 -0
- package/dist/es/defaults.js.map +1 -0
- package/dist/es/index.js +27 -0
- package/dist/es/index.js.map +1 -0
- package/dist/es/models/ICacheMetadata.js +4 -0
- package/dist/es/models/ICacheMetadata.js.map +1 -0
- package/dist/es/models/ICliArgs.js +4 -0
- package/dist/es/models/ICliArgs.js.map +1 -0
- package/dist/es/models/ICliCommand.js +2 -0
- package/dist/es/models/ICliCommand.js.map +1 -0
- package/dist/es/models/ICliCommandDefinition.js +2 -0
- package/dist/es/models/ICliCommandDefinition.js.map +1 -0
- package/dist/es/models/ICliCommandDefinitionParam.js +2 -0
- package/dist/es/models/ICliCommandDefinitionParam.js.map +1 -0
- package/dist/es/models/IEngineEnvironmentVariables.js +4 -0
- package/dist/es/models/IEngineEnvironmentVariables.js.map +1 -0
- package/dist/es/models/IEngineServerEnvironmentVariables.js +2 -0
- package/dist/es/models/IEngineServerEnvironmentVariables.js.map +1 -0
- package/dist/es/models/IModuleProtocol.js +2 -0
- package/dist/es/models/IModuleProtocol.js.map +1 -0
- package/dist/es/models/INodeEngineConfig.js +2 -0
- package/dist/es/models/INodeEngineConfig.js.map +1 -0
- package/dist/es/models/INodeEngineState.js +2 -0
- package/dist/es/models/INodeEngineState.js.map +1 -0
- package/dist/es/models/INodeEnvironmentVariables.js +2 -0
- package/dist/es/models/INodeEnvironmentVariables.js.map +1 -0
- package/dist/es/models/INodeOptions.js +2 -0
- package/dist/es/models/INodeOptions.js.map +1 -0
- package/dist/es/models/IProtocolHandlerResult.js +4 -0
- package/dist/es/models/IProtocolHandlerResult.js.map +1 -0
- package/dist/es/models/cliCommandParamType.js +4 -0
- package/dist/es/models/cliCommandParamType.js.map +1 -0
- package/dist/es/models/moduleProtocol.js +29 -0
- package/dist/es/models/moduleProtocol.js.map +1 -0
- package/dist/es/models/nodeExtensionMethods.js +2 -0
- package/dist/es/models/nodeExtensionMethods.js.map +1 -0
- package/dist/es/node.js +285 -0
- package/dist/es/node.js.map +1 -0
- package/dist/es/start.js +128 -0
- package/dist/es/start.js.map +1 -0
- package/dist/es/utils.js +397 -0
- package/dist/es/utils.js.map +1 -0
- package/dist/types/builders/engineEnvBuilder.d.ts +6 -2
- package/dist/types/builders/engineServerEnvBuilder.d.ts +7 -3
- package/dist/types/builders/extensionsBuilder.d.ts +32 -0
- package/dist/types/cli.d.ts +66 -0
- package/dist/types/commands/bootstrapLegacy.d.ts +66 -0
- package/dist/types/commands/help.d.ts +23 -0
- package/dist/types/commands/identityCreate.d.ts +39 -0
- package/dist/types/commands/identityImports.d.ts +24 -0
- package/dist/types/commands/identityVerifiableCredentialCreate.d.ts +43 -0
- package/dist/types/commands/identityVerificationMethodCreate.d.ts +47 -0
- package/dist/types/commands/identityVerificationMethodImport.d.ts +31 -0
- package/dist/types/commands/nodeSetIdentity.d.ts +22 -0
- package/dist/types/commands/nodeSetTenant.d.ts +22 -0
- package/dist/types/commands/tenantCreate.d.ts +35 -0
- package/dist/types/commands/tenantImport.d.ts +24 -0
- package/dist/types/commands/userCreate.d.ts +46 -0
- package/dist/types/commands/vaultKeyCreate.d.ts +43 -0
- package/dist/types/commands/vaultKeyImport.d.ts +28 -0
- package/dist/types/defaults.d.ts +16 -0
- package/dist/types/index.d.ts +24 -11
- package/dist/types/models/ICacheMetadata.d.ts +17 -0
- package/dist/types/models/ICliArgs.d.ts +20 -0
- package/dist/types/models/ICliCommand.d.ts +17 -0
- package/dist/types/models/ICliCommandDefinition.d.ts +46 -0
- package/dist/types/models/ICliCommandDefinitionParam.d.ts +35 -0
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +154 -37
- package/dist/types/models/IEngineServerEnvironmentVariables.d.ts +12 -3
- package/dist/types/models/IModuleProtocol.d.ts +18 -0
- package/dist/types/models/INodeEngineConfig.d.ts +6 -0
- package/dist/types/models/INodeEngineState.d.ts +14 -0
- package/dist/types/models/INodeEnvironmentVariables.d.ts +17 -15
- package/dist/types/models/INodeOptions.d.ts +14 -3
- package/dist/types/models/IProtocolHandlerResult.d.ts +13 -0
- package/dist/types/models/cliCommandParamType.d.ts +4 -0
- package/dist/types/models/moduleProtocol.d.ts +29 -0
- package/dist/types/models/nodeExtensionMethods.d.ts +27 -0
- package/dist/types/node.d.ts +21 -7
- package/dist/types/start.d.ts +25 -0
- package/dist/types/utils.d.ts +83 -6
- package/docs/changelog.md +241 -0
- package/docs/detailed-guide.md +129 -0
- package/docs/reference/functions/buildConfiguration.md +2 -2
- package/docs/reference/functions/buildEngineConfiguration.md +8 -2
- package/docs/reference/functions/buildEngineServerConfiguration.md +9 -3
- package/docs/reference/functions/constructCliCommand.md +27 -0
- package/docs/reference/functions/createModuleImportUrl.md +21 -0
- package/docs/reference/functions/directoryExists.md +19 -0
- package/docs/reference/functions/executeCommand.md +29 -0
- package/docs/reference/functions/extensionsConfiguration.md +25 -0
- package/docs/reference/functions/extensionsInitialiseEngine.md +25 -0
- package/docs/reference/functions/extensionsInitialiseEngineServer.md +31 -0
- package/docs/reference/functions/getEnvDefaults.md +19 -0
- package/docs/reference/functions/getExtensionsCacheDir.md +31 -0
- package/docs/reference/functions/getFiles.md +19 -0
- package/docs/reference/functions/getSubFolders.md +19 -0
- package/docs/reference/functions/handleHttpsProtocol.md +49 -0
- package/docs/reference/functions/handleNpmProtocol.md +31 -0
- package/docs/reference/functions/hashUrl.md +19 -0
- package/docs/reference/functions/initCli.md +27 -0
- package/docs/reference/functions/isCacheExpired.md +31 -0
- package/docs/reference/functions/overrideModuleImport.md +8 -2
- package/docs/reference/functions/parseCommandLineArgs.md +19 -0
- package/docs/reference/functions/parseModuleProtocol.md +19 -0
- package/docs/reference/functions/processEnvOptions.md +27 -0
- package/docs/reference/functions/registerCommands.md +9 -0
- package/docs/reference/functions/resolvePackageEntryPoint.md +32 -0
- package/docs/reference/functions/run.md +9 -3
- package/docs/reference/functions/shutdownExtensions.md +25 -0
- package/docs/reference/functions/start.md +17 -5
- package/docs/reference/functions/substituteEnvOptions.md +25 -0
- package/docs/reference/index.md +47 -10
- package/docs/reference/interfaces/ICacheMetadata.md +27 -0
- package/docs/reference/interfaces/ICliArgs.md +35 -0
- package/docs/reference/interfaces/ICliCommand.md +23 -0
- package/docs/reference/interfaces/ICliCommandDefinition.md +101 -0
- package/docs/reference/interfaces/ICliCommandDefinitionParam.md +65 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +303 -60
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +1737 -5
- package/docs/reference/interfaces/IModuleProtocol.md +27 -0
- package/docs/reference/interfaces/INodeEngineConfig.md +7 -0
- package/docs/reference/interfaces/INodeEngineState.md +23 -0
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +599 -198
- package/docs/reference/interfaces/INodeOptions.md +27 -3
- package/docs/reference/interfaces/IProtocolHandlerResult.md +19 -0
- package/docs/reference/type-aliases/CliCommandParamType.md +5 -0
- package/docs/reference/type-aliases/ModuleProtocol.md +5 -0
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +18 -0
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +24 -0
- package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +23 -0
- package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +10 -0
- package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +3 -0
- package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +3 -0
- package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
- package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_DID.md +3 -0
- package/docs/reference/variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md +3 -0
- package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +3 -0
- package/docs/reference/variables/ModuleProtocol.md +37 -0
- package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
- package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +3 -0
- package/locales/en.json +479 -28
- package/package.json +29 -9
- package/dist/cjs/index.cjs +0 -1910
- package/dist/esm/index.mjs +0 -1870
- package/dist/types/bootstrap.d.ts +0 -59
- package/dist/types/models/nodeFeatures.d.ts +0 -21
- package/dist/types/server.d.ts +0 -17
- package/docs/reference/functions/bootstrap.md +0 -29
- package/docs/reference/functions/bootstrapAuth.md +0 -35
- package/docs/reference/functions/bootstrapBlobEncryption.md +0 -35
- package/docs/reference/functions/bootstrapImmutableProofMethod.md +0 -35
- package/docs/reference/functions/bootstrapNodeIdentity.md +0 -35
- package/docs/reference/functions/bootstrapNodeUser.md +0 -35
- package/docs/reference/functions/bootstrapSynchronisedStorage.md +0 -35
- package/docs/reference/functions/getFeatures.md +0 -19
- package/docs/reference/type-aliases/NodeFeatures.md +0 -5
- package/docs/reference/variables/NodeFeatures.md +0 -25
|
@@ -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,19 @@ Start the engine in debug mode.
|
|
|
16
16
|
|
|
17
17
|
#### Inherited from
|
|
18
18
|
|
|
19
|
-
[`
|
|
19
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`debug`](IEngineServerEnvironmentVariables.md#debug)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### silent?
|
|
24
|
+
|
|
25
|
+
> `optional` **silent**: `string`
|
|
26
|
+
|
|
27
|
+
Start the engine in silent mode.
|
|
28
|
+
|
|
29
|
+
#### Inherited from
|
|
30
|
+
|
|
31
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`silent`](IEngineServerEnvironmentVariables.md#silent)
|
|
20
32
|
|
|
21
33
|
***
|
|
22
34
|
|
|
@@ -28,7 +40,7 @@ The root directory for storing items like state file.
|
|
|
28
40
|
|
|
29
41
|
#### Inherited from
|
|
30
42
|
|
|
31
|
-
[`
|
|
43
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`storageFileRoot`](IEngineServerEnvironmentVariables.md#storagefileroot)
|
|
32
44
|
|
|
33
45
|
***
|
|
34
46
|
|
|
@@ -40,7 +52,31 @@ The name of the state file.
|
|
|
40
52
|
|
|
41
53
|
#### Inherited from
|
|
42
54
|
|
|
43
|
-
[`
|
|
55
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`stateFilename`](IEngineServerEnvironmentVariables.md#statefilename)
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### nodeIdentityEnabled?
|
|
60
|
+
|
|
61
|
+
> `optional` **nodeIdentityEnabled**: `string`
|
|
62
|
+
|
|
63
|
+
Does the node have a unique ID, defaults to true.
|
|
64
|
+
|
|
65
|
+
#### Inherited from
|
|
66
|
+
|
|
67
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`nodeIdentityEnabled`](IEngineServerEnvironmentVariables.md#nodeidentityenabled)
|
|
68
|
+
|
|
69
|
+
***
|
|
70
|
+
|
|
71
|
+
### tenantEnabled?
|
|
72
|
+
|
|
73
|
+
> `optional` **tenantEnabled**: `string`
|
|
74
|
+
|
|
75
|
+
Is multi-tenant support enabled, defaults to false.
|
|
76
|
+
|
|
77
|
+
#### Inherited from
|
|
78
|
+
|
|
79
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`tenantEnabled`](IEngineServerEnvironmentVariables.md#tenantenabled)
|
|
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
|
-
[`
|
|
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
|
-
[`
|
|
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
|
-
[`
|
|
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
|
-
[`
|
|
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
|
-
[`
|
|
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
|
-
[`
|
|
164
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbRegion`](IEngineServerEnvironmentVariables.md#awsdynamodbregion)
|
|
117
165
|
|
|
118
166
|
***
|
|
119
167
|
|
|
@@ -125,7 +173,19 @@ AWS Dynamo DB secret access key.
|
|
|
125
173
|
|
|
126
174
|
#### Inherited from
|
|
127
175
|
|
|
128
|
-
[`
|
|
176
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbSecretAccessKey`](IEngineServerEnvironmentVariables.md#awsdynamodbsecretaccesskey)
|
|
177
|
+
|
|
178
|
+
***
|
|
179
|
+
|
|
180
|
+
### awsDynamodbConnectionTimeoutMs?
|
|
181
|
+
|
|
182
|
+
> `optional` **awsDynamodbConnectionTimeoutMs**: `string`
|
|
183
|
+
|
|
184
|
+
AWS Dynamo DB connection timeout.
|
|
185
|
+
|
|
186
|
+
#### Inherited from
|
|
187
|
+
|
|
188
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbConnectionTimeoutMs`](IEngineServerEnvironmentVariables.md#awsdynamodbconnectiontimeoutms)
|
|
129
189
|
|
|
130
190
|
***
|
|
131
191
|
|
|
@@ -137,7 +197,7 @@ Azure Cosmos DB key.
|
|
|
137
197
|
|
|
138
198
|
#### Inherited from
|
|
139
199
|
|
|
140
|
-
[`
|
|
200
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbKey`](IEngineServerEnvironmentVariables.md#azurecosmosdbkey)
|
|
141
201
|
|
|
142
202
|
***
|
|
143
203
|
|
|
@@ -149,7 +209,7 @@ Azure Cosmos DB container id.
|
|
|
149
209
|
|
|
150
210
|
#### Inherited from
|
|
151
211
|
|
|
152
|
-
[`
|
|
212
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbContainerId`](IEngineServerEnvironmentVariables.md#azurecosmosdbcontainerid)
|
|
153
213
|
|
|
154
214
|
***
|
|
155
215
|
|
|
@@ -161,7 +221,7 @@ Azure Cosmos DB database id.
|
|
|
161
221
|
|
|
162
222
|
#### Inherited from
|
|
163
223
|
|
|
164
|
-
[`
|
|
224
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbDatabaseId`](IEngineServerEnvironmentVariables.md#azurecosmosdbdatabaseid)
|
|
165
225
|
|
|
166
226
|
***
|
|
167
227
|
|
|
@@ -173,7 +233,7 @@ Azure Cosmos DB endpoint.
|
|
|
173
233
|
|
|
174
234
|
#### Inherited from
|
|
175
235
|
|
|
176
|
-
[`
|
|
236
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureCosmosdbEndpoint`](IEngineServerEnvironmentVariables.md#azurecosmosdbendpoint)
|
|
177
237
|
|
|
178
238
|
***
|
|
179
239
|
|
|
@@ -185,7 +245,7 @@ GCP Firestore collection name.
|
|
|
185
245
|
|
|
186
246
|
#### Inherited from
|
|
187
247
|
|
|
188
|
-
[`
|
|
248
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCollectionName`](IEngineServerEnvironmentVariables.md#gcpfirestorecollectionname)
|
|
189
249
|
|
|
190
250
|
***
|
|
191
251
|
|
|
@@ -197,7 +257,7 @@ GCP Firestore credentials.
|
|
|
197
257
|
|
|
198
258
|
#### Inherited from
|
|
199
259
|
|
|
200
|
-
[`
|
|
260
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreCredentials`](IEngineServerEnvironmentVariables.md#gcpfirestorecredentials)
|
|
201
261
|
|
|
202
262
|
***
|
|
203
263
|
|
|
@@ -209,7 +269,7 @@ GCP Firestore database id.
|
|
|
209
269
|
|
|
210
270
|
#### Inherited from
|
|
211
271
|
|
|
212
|
-
[`
|
|
272
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreDatabaseId`](IEngineServerEnvironmentVariables.md#gcpfirestoredatabaseid)
|
|
213
273
|
|
|
214
274
|
***
|
|
215
275
|
|
|
@@ -221,7 +281,7 @@ GCP Firestore endpoint.
|
|
|
221
281
|
|
|
222
282
|
#### Inherited from
|
|
223
283
|
|
|
224
|
-
[`
|
|
284
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreApiEndpoint`](IEngineServerEnvironmentVariables.md#gcpfirestoreapiendpoint)
|
|
225
285
|
|
|
226
286
|
***
|
|
227
287
|
|
|
@@ -233,7 +293,7 @@ GCP Firestore project id.
|
|
|
233
293
|
|
|
234
294
|
#### Inherited from
|
|
235
295
|
|
|
236
|
-
[`
|
|
296
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpFirestoreProjectId`](IEngineServerEnvironmentVariables.md#gcpfirestoreprojectid)
|
|
237
297
|
|
|
238
298
|
***
|
|
239
299
|
|
|
@@ -245,7 +305,7 @@ ScyllaDB hosts as comma separated string.
|
|
|
245
305
|
|
|
246
306
|
#### Inherited from
|
|
247
307
|
|
|
248
|
-
[`
|
|
308
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbHosts`](IEngineServerEnvironmentVariables.md#scylladbhosts)
|
|
249
309
|
|
|
250
310
|
***
|
|
251
311
|
|
|
@@ -257,7 +317,7 @@ ScyllaDB keyspace.
|
|
|
257
317
|
|
|
258
318
|
#### Inherited from
|
|
259
319
|
|
|
260
|
-
[`
|
|
320
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbKeyspace`](IEngineServerEnvironmentVariables.md#scylladbkeyspace)
|
|
261
321
|
|
|
262
322
|
***
|
|
263
323
|
|
|
@@ -269,7 +329,7 @@ ScyllaDB local data center.
|
|
|
269
329
|
|
|
270
330
|
#### Inherited from
|
|
271
331
|
|
|
272
|
-
[`
|
|
332
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbLocalDataCenter`](IEngineServerEnvironmentVariables.md#scylladblocaldatacenter)
|
|
273
333
|
|
|
274
334
|
***
|
|
275
335
|
|
|
@@ -281,7 +341,7 @@ ScyllaDB port.
|
|
|
281
341
|
|
|
282
342
|
#### Inherited from
|
|
283
343
|
|
|
284
|
-
[`
|
|
344
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`scylladbPort`](IEngineServerEnvironmentVariables.md#scylladbport)
|
|
285
345
|
|
|
286
346
|
***
|
|
287
347
|
|
|
@@ -293,7 +353,7 @@ MySQL host.
|
|
|
293
353
|
|
|
294
354
|
#### Inherited from
|
|
295
355
|
|
|
296
|
-
[`
|
|
356
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlHost`](IEngineServerEnvironmentVariables.md#mysqlhost)
|
|
297
357
|
|
|
298
358
|
***
|
|
299
359
|
|
|
@@ -305,7 +365,7 @@ MySQL port.
|
|
|
305
365
|
|
|
306
366
|
#### Inherited from
|
|
307
367
|
|
|
308
|
-
[`
|
|
368
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPort`](IEngineServerEnvironmentVariables.md#mysqlport)
|
|
309
369
|
|
|
310
370
|
***
|
|
311
371
|
|
|
@@ -317,7 +377,7 @@ MySQL username.
|
|
|
317
377
|
|
|
318
378
|
#### Inherited from
|
|
319
379
|
|
|
320
|
-
[`
|
|
380
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlUser`](IEngineServerEnvironmentVariables.md#mysqluser)
|
|
321
381
|
|
|
322
382
|
***
|
|
323
383
|
|
|
@@ -329,7 +389,7 @@ MySQL password.
|
|
|
329
389
|
|
|
330
390
|
#### Inherited from
|
|
331
391
|
|
|
332
|
-
[`
|
|
392
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlPassword`](IEngineServerEnvironmentVariables.md#mysqlpassword)
|
|
333
393
|
|
|
334
394
|
***
|
|
335
395
|
|
|
@@ -341,7 +401,7 @@ MySQL Database.
|
|
|
341
401
|
|
|
342
402
|
#### Inherited from
|
|
343
403
|
|
|
344
|
-
[`
|
|
404
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mySqlDatabase`](IEngineServerEnvironmentVariables.md#mysqldatabase)
|
|
345
405
|
|
|
346
406
|
***
|
|
347
407
|
|
|
@@ -353,7 +413,7 @@ MongoDB host.
|
|
|
353
413
|
|
|
354
414
|
#### Inherited from
|
|
355
415
|
|
|
356
|
-
[`
|
|
416
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbHost`](IEngineServerEnvironmentVariables.md#mongodbhost)
|
|
357
417
|
|
|
358
418
|
***
|
|
359
419
|
|
|
@@ -365,7 +425,7 @@ MongoDB port.
|
|
|
365
425
|
|
|
366
426
|
#### Inherited from
|
|
367
427
|
|
|
368
|
-
[`
|
|
428
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPort`](IEngineServerEnvironmentVariables.md#mongodbport)
|
|
369
429
|
|
|
370
430
|
***
|
|
371
431
|
|
|
@@ -377,7 +437,7 @@ MongoDB username.
|
|
|
377
437
|
|
|
378
438
|
#### Inherited from
|
|
379
439
|
|
|
380
|
-
[`
|
|
440
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbUser`](IEngineServerEnvironmentVariables.md#mongodbuser)
|
|
381
441
|
|
|
382
442
|
***
|
|
383
443
|
|
|
@@ -389,7 +449,7 @@ MongoDB password.
|
|
|
389
449
|
|
|
390
450
|
#### Inherited from
|
|
391
451
|
|
|
392
|
-
[`
|
|
452
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbPassword`](IEngineServerEnvironmentVariables.md#mongodbpassword)
|
|
393
453
|
|
|
394
454
|
***
|
|
395
455
|
|
|
@@ -401,7 +461,7 @@ MongoDB Database.
|
|
|
401
461
|
|
|
402
462
|
#### Inherited from
|
|
403
463
|
|
|
404
|
-
[`
|
|
464
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`mongoDbDatabase`](IEngineServerEnvironmentVariables.md#mongodbdatabase)
|
|
405
465
|
|
|
406
466
|
***
|
|
407
467
|
|
|
@@ -413,7 +473,7 @@ PostgreSQl host.
|
|
|
413
473
|
|
|
414
474
|
#### Inherited from
|
|
415
475
|
|
|
416
|
-
[`
|
|
476
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlHost`](IEngineServerEnvironmentVariables.md#postgresqlhost)
|
|
417
477
|
|
|
418
478
|
***
|
|
419
479
|
|
|
@@ -425,7 +485,7 @@ PostgreSQl port.
|
|
|
425
485
|
|
|
426
486
|
#### Inherited from
|
|
427
487
|
|
|
428
|
-
[`
|
|
488
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPort`](IEngineServerEnvironmentVariables.md#postgresqlport)
|
|
429
489
|
|
|
430
490
|
***
|
|
431
491
|
|
|
@@ -437,7 +497,7 @@ PostgreSQl username.
|
|
|
437
497
|
|
|
438
498
|
#### Inherited from
|
|
439
499
|
|
|
440
|
-
[`
|
|
500
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlUser`](IEngineServerEnvironmentVariables.md#postgresqluser)
|
|
441
501
|
|
|
442
502
|
***
|
|
443
503
|
|
|
@@ -449,7 +509,7 @@ PostgreSQl password.
|
|
|
449
509
|
|
|
450
510
|
#### Inherited from
|
|
451
511
|
|
|
452
|
-
[`
|
|
512
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlPassword`](IEngineServerEnvironmentVariables.md#postgresqlpassword)
|
|
453
513
|
|
|
454
514
|
***
|
|
455
515
|
|
|
@@ -461,7 +521,7 @@ PostgreSQl Database.
|
|
|
461
521
|
|
|
462
522
|
#### Inherited from
|
|
463
523
|
|
|
464
|
-
[`
|
|
524
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`postgreSqlDatabase`](IEngineServerEnvironmentVariables.md#postgresqldatabase)
|
|
465
525
|
|
|
466
526
|
***
|
|
467
527
|
|
|
@@ -473,7 +533,7 @@ The security token for accessing IPFS API.
|
|
|
473
533
|
|
|
474
534
|
#### Inherited from
|
|
475
535
|
|
|
476
|
-
[`
|
|
536
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsBearerToken`](IEngineServerEnvironmentVariables.md#ipfsbearertoken)
|
|
477
537
|
|
|
478
538
|
***
|
|
479
539
|
|
|
@@ -485,7 +545,7 @@ The url for accessing IPFS API.
|
|
|
485
545
|
|
|
486
546
|
#### Inherited from
|
|
487
547
|
|
|
488
|
-
[`
|
|
548
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`ipfsApiUrl`](IEngineServerEnvironmentVariables.md#ipfsapiurl)
|
|
489
549
|
|
|
490
550
|
***
|
|
491
551
|
|
|
@@ -498,7 +558,7 @@ values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
|
|
|
498
558
|
|
|
499
559
|
#### Inherited from
|
|
500
560
|
|
|
501
|
-
[`
|
|
561
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorType`](IEngineServerEnvironmentVariables.md#blobstorageconnectortype)
|
|
502
562
|
|
|
503
563
|
***
|
|
504
564
|
|
|
@@ -510,7 +570,7 @@ The default blob storage connector to use, defaults to the first one in the list
|
|
|
510
570
|
|
|
511
571
|
#### Inherited from
|
|
512
572
|
|
|
513
|
-
[`
|
|
573
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorDefault`](IEngineServerEnvironmentVariables.md#blobstorageconnectordefault)
|
|
514
574
|
|
|
515
575
|
***
|
|
516
576
|
|
|
@@ -522,7 +582,7 @@ Blog storage connector which has public access.
|
|
|
522
582
|
|
|
523
583
|
#### Inherited from
|
|
524
584
|
|
|
525
|
-
[`
|
|
585
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageConnectorPublic`](IEngineServerEnvironmentVariables.md#blobstorageconnectorpublic)
|
|
526
586
|
|
|
527
587
|
***
|
|
528
588
|
|
|
@@ -534,7 +594,7 @@ Enable encryption for the blob storage.
|
|
|
534
594
|
|
|
535
595
|
#### Inherited from
|
|
536
596
|
|
|
537
|
-
[`
|
|
597
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEnableEncryption`](IEngineServerEnvironmentVariables.md#blobstorageenableencryption)
|
|
538
598
|
|
|
539
599
|
***
|
|
540
600
|
|
|
@@ -546,20 +606,7 @@ The id of the encryption key for the blob storage.
|
|
|
546
606
|
|
|
547
607
|
#### Inherited from
|
|
548
608
|
|
|
549
|
-
[`
|
|
550
|
-
|
|
551
|
-
***
|
|
552
|
-
|
|
553
|
-
### blobStorageSymmetricEncryptionKey?
|
|
554
|
-
|
|
555
|
-
> `optional` **blobStorageSymmetricEncryptionKey**: `string`
|
|
556
|
-
|
|
557
|
-
A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
|
|
558
|
-
If encryption is enabled but a key is not provided one will be generated.
|
|
559
|
-
|
|
560
|
-
#### Inherited from
|
|
561
|
-
|
|
562
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`blobStorageSymmetricEncryptionKey`](IEngineEnvironmentVariables.md#blobstoragesymmetricencryptionkey)
|
|
609
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#blobstorageencryptionkeyid)
|
|
563
610
|
|
|
564
611
|
***
|
|
565
612
|
|
|
@@ -571,19 +618,19 @@ A prefix for all the blobs in blob-storage, can be empty.
|
|
|
571
618
|
|
|
572
619
|
#### Inherited from
|
|
573
620
|
|
|
574
|
-
[`
|
|
621
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`blobStoragePrefix`](IEngineServerEnvironmentVariables.md#blobstorageprefix)
|
|
575
622
|
|
|
576
623
|
***
|
|
577
624
|
|
|
578
|
-
###
|
|
625
|
+
### awsS3Region?
|
|
579
626
|
|
|
580
|
-
> `optional` **
|
|
627
|
+
> `optional` **awsS3Region**: `string`
|
|
581
628
|
|
|
582
|
-
AWS S3
|
|
629
|
+
AWS S3 region.
|
|
583
630
|
|
|
584
631
|
#### Inherited from
|
|
585
632
|
|
|
586
|
-
[`
|
|
633
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Region`](IEngineServerEnvironmentVariables.md#awss3region)
|
|
587
634
|
|
|
588
635
|
***
|
|
589
636
|
|
|
@@ -595,31 +642,31 @@ AWS S3 bucket name.
|
|
|
595
642
|
|
|
596
643
|
#### Inherited from
|
|
597
644
|
|
|
598
|
-
[`
|
|
645
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3BucketName`](IEngineServerEnvironmentVariables.md#awss3bucketname)
|
|
599
646
|
|
|
600
647
|
***
|
|
601
648
|
|
|
602
|
-
###
|
|
649
|
+
### awsS3AuthMode?
|
|
603
650
|
|
|
604
|
-
> `optional` **
|
|
651
|
+
> `optional` **awsS3AuthMode**: `string`
|
|
605
652
|
|
|
606
|
-
AWS S3
|
|
653
|
+
AWS S3 auth mode, either credentials or pod, defaults to credentials.
|
|
607
654
|
|
|
608
655
|
#### Inherited from
|
|
609
656
|
|
|
610
|
-
[`
|
|
657
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AuthMode`](IEngineServerEnvironmentVariables.md#awss3authmode)
|
|
611
658
|
|
|
612
659
|
***
|
|
613
660
|
|
|
614
|
-
###
|
|
661
|
+
### awsS3AccessKeyId?
|
|
615
662
|
|
|
616
|
-
> `optional` **
|
|
663
|
+
> `optional` **awsS3AccessKeyId**: `string`
|
|
617
664
|
|
|
618
|
-
AWS S3
|
|
665
|
+
AWS S3 access key id.
|
|
619
666
|
|
|
620
667
|
#### Inherited from
|
|
621
668
|
|
|
622
|
-
[`
|
|
669
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineServerEnvironmentVariables.md#awss3accesskeyid)
|
|
623
670
|
|
|
624
671
|
***
|
|
625
672
|
|
|
@@ -631,7 +678,19 @@ AWS S3 secret access key.
|
|
|
631
678
|
|
|
632
679
|
#### Inherited from
|
|
633
680
|
|
|
634
|
-
[`
|
|
681
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3SecretAccessKey`](IEngineServerEnvironmentVariables.md#awss3secretaccesskey)
|
|
682
|
+
|
|
683
|
+
***
|
|
684
|
+
|
|
685
|
+
### awsS3Endpoint?
|
|
686
|
+
|
|
687
|
+
> `optional` **awsS3Endpoint**: `string`
|
|
688
|
+
|
|
689
|
+
AWS S3 endpoint.
|
|
690
|
+
|
|
691
|
+
#### Inherited from
|
|
692
|
+
|
|
693
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Endpoint`](IEngineServerEnvironmentVariables.md#awss3endpoint)
|
|
635
694
|
|
|
636
695
|
***
|
|
637
696
|
|
|
@@ -643,7 +702,7 @@ Azure Storage account key.
|
|
|
643
702
|
|
|
644
703
|
#### Inherited from
|
|
645
704
|
|
|
646
|
-
[`
|
|
705
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountKey`](IEngineServerEnvironmentVariables.md#azurestorageaccountkey)
|
|
647
706
|
|
|
648
707
|
***
|
|
649
708
|
|
|
@@ -655,7 +714,7 @@ Azure Storage account name.
|
|
|
655
714
|
|
|
656
715
|
#### Inherited from
|
|
657
716
|
|
|
658
|
-
[`
|
|
717
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageAccountName`](IEngineServerEnvironmentVariables.md#azurestorageaccountname)
|
|
659
718
|
|
|
660
719
|
***
|
|
661
720
|
|
|
@@ -667,7 +726,7 @@ Azure Storage container.
|
|
|
667
726
|
|
|
668
727
|
#### Inherited from
|
|
669
728
|
|
|
670
|
-
[`
|
|
729
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageContainerName`](IEngineServerEnvironmentVariables.md#azurestoragecontainername)
|
|
671
730
|
|
|
672
731
|
***
|
|
673
732
|
|
|
@@ -679,7 +738,7 @@ Azure Storage endpoint.
|
|
|
679
738
|
|
|
680
739
|
#### Inherited from
|
|
681
740
|
|
|
682
|
-
[`
|
|
741
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`azureStorageEndpoint`](IEngineServerEnvironmentVariables.md#azurestorageendpoint)
|
|
683
742
|
|
|
684
743
|
***
|
|
685
744
|
|
|
@@ -691,7 +750,7 @@ GCP Storage bucket.
|
|
|
691
750
|
|
|
692
751
|
#### Inherited from
|
|
693
752
|
|
|
694
|
-
[`
|
|
753
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageBucketName`](IEngineServerEnvironmentVariables.md#gcpstoragebucketname)
|
|
695
754
|
|
|
696
755
|
***
|
|
697
756
|
|
|
@@ -703,7 +762,7 @@ GCP Storage credentials.
|
|
|
703
762
|
|
|
704
763
|
#### Inherited from
|
|
705
764
|
|
|
706
|
-
[`
|
|
765
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageCredentials`](IEngineServerEnvironmentVariables.md#gcpstoragecredentials)
|
|
707
766
|
|
|
708
767
|
***
|
|
709
768
|
|
|
@@ -715,7 +774,7 @@ GCP Storage endpoint.
|
|
|
715
774
|
|
|
716
775
|
#### Inherited from
|
|
717
776
|
|
|
718
|
-
[`
|
|
777
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageEndpoint`](IEngineServerEnvironmentVariables.md#gcpstorageendpoint)
|
|
719
778
|
|
|
720
779
|
***
|
|
721
780
|
|
|
@@ -727,7 +786,7 @@ GCP Storage project id.
|
|
|
727
786
|
|
|
728
787
|
#### Inherited from
|
|
729
788
|
|
|
730
|
-
[`
|
|
789
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`gcpStorageProjectId`](IEngineServerEnvironmentVariables.md#gcpstorageprojectid)
|
|
731
790
|
|
|
732
791
|
***
|
|
733
792
|
|
|
@@ -739,7 +798,7 @@ The type of the default vault connector: entity-storage, hashicorp.
|
|
|
739
798
|
|
|
740
799
|
#### Inherited from
|
|
741
800
|
|
|
742
|
-
[`
|
|
801
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vaultConnector`](IEngineServerEnvironmentVariables.md#vaultconnector)
|
|
743
802
|
|
|
744
803
|
***
|
|
745
804
|
|
|
@@ -751,7 +810,7 @@ Hashicorp Vault token.
|
|
|
751
810
|
|
|
752
811
|
#### Inherited from
|
|
753
812
|
|
|
754
|
-
[`
|
|
813
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultToken`](IEngineServerEnvironmentVariables.md#hashicorpvaulttoken)
|
|
755
814
|
|
|
756
815
|
***
|
|
757
816
|
|
|
@@ -763,7 +822,7 @@ Hashicorp Vault endpoint.
|
|
|
763
822
|
|
|
764
823
|
#### Inherited from
|
|
765
824
|
|
|
766
|
-
[`
|
|
825
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hashicorpVaultEndpoint`](IEngineServerEnvironmentVariables.md#hashicorpvaultendpoint)
|
|
767
826
|
|
|
768
827
|
***
|
|
769
828
|
|
|
@@ -771,83 +830,107 @@ Hashicorp Vault endpoint.
|
|
|
771
830
|
|
|
772
831
|
> `optional` **loggingConnector**: `string`
|
|
773
832
|
|
|
774
|
-
The type of
|
|
833
|
+
The type of logging task connector, can be a comma separated list: console, entity-storage.
|
|
775
834
|
|
|
776
835
|
#### Inherited from
|
|
777
836
|
|
|
778
|
-
[`
|
|
837
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`loggingConnector`](IEngineServerEnvironmentVariables.md#loggingconnector)
|
|
779
838
|
|
|
780
839
|
***
|
|
781
840
|
|
|
782
|
-
###
|
|
841
|
+
### eventBusConnector?
|
|
783
842
|
|
|
784
|
-
> `optional` **
|
|
843
|
+
> `optional` **eventBusConnector**: `string`
|
|
785
844
|
|
|
786
|
-
The type of
|
|
845
|
+
The type of event bus connector: local.
|
|
787
846
|
|
|
788
847
|
#### Inherited from
|
|
789
848
|
|
|
790
|
-
[`
|
|
849
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusConnector`](IEngineServerEnvironmentVariables.md#eventbusconnector)
|
|
791
850
|
|
|
792
851
|
***
|
|
793
852
|
|
|
794
|
-
###
|
|
853
|
+
### eventBusComponent?
|
|
795
854
|
|
|
796
|
-
> `optional` **
|
|
855
|
+
> `optional` **eventBusComponent**: `string`
|
|
797
856
|
|
|
798
|
-
The type of event bus
|
|
857
|
+
The type of event bus component: service.
|
|
799
858
|
|
|
800
859
|
#### Inherited from
|
|
801
860
|
|
|
802
|
-
[`
|
|
861
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`eventBusComponent`](IEngineServerEnvironmentVariables.md#eventbuscomponent)
|
|
803
862
|
|
|
804
863
|
***
|
|
805
864
|
|
|
806
|
-
###
|
|
865
|
+
### messagingEnabled?
|
|
807
866
|
|
|
808
|
-
> `optional` **
|
|
867
|
+
> `optional` **messagingEnabled**: `string`
|
|
809
868
|
|
|
810
|
-
|
|
869
|
+
Are the messaging components enabled, defaults to false.
|
|
811
870
|
|
|
812
871
|
#### Inherited from
|
|
813
872
|
|
|
814
|
-
[`
|
|
873
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingEnabled`](IEngineServerEnvironmentVariables.md#messagingenabled)
|
|
815
874
|
|
|
816
875
|
***
|
|
817
876
|
|
|
818
|
-
###
|
|
877
|
+
### awsSesRegion?
|
|
819
878
|
|
|
820
|
-
> `optional` **
|
|
879
|
+
> `optional` **awsSesRegion**: `string`
|
|
821
880
|
|
|
822
|
-
|
|
881
|
+
AWS SES region.
|
|
823
882
|
|
|
824
883
|
#### Inherited from
|
|
825
884
|
|
|
826
|
-
[`
|
|
885
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesRegion`](IEngineServerEnvironmentVariables.md#awssesregion)
|
|
827
886
|
|
|
828
887
|
***
|
|
829
888
|
|
|
830
|
-
###
|
|
889
|
+
### awsSesAuthMode?
|
|
831
890
|
|
|
832
|
-
> `optional` **
|
|
891
|
+
> `optional` **awsSesAuthMode**: `string`
|
|
833
892
|
|
|
834
|
-
|
|
893
|
+
AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
835
894
|
|
|
836
895
|
#### Inherited from
|
|
837
896
|
|
|
838
|
-
[`
|
|
897
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAuthMode`](IEngineServerEnvironmentVariables.md#awssesauthmode)
|
|
839
898
|
|
|
840
899
|
***
|
|
841
900
|
|
|
842
|
-
###
|
|
901
|
+
### awsSesSecretAccessKey?
|
|
843
902
|
|
|
844
|
-
> `optional` **
|
|
903
|
+
> `optional` **awsSesSecretAccessKey**: `string`
|
|
845
904
|
|
|
846
|
-
|
|
905
|
+
AWS SES secret access key.
|
|
906
|
+
|
|
907
|
+
#### Inherited from
|
|
908
|
+
|
|
909
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineServerEnvironmentVariables.md#awssessecretaccesskey)
|
|
910
|
+
|
|
911
|
+
***
|
|
912
|
+
|
|
913
|
+
### awsSesAccessKeyId?
|
|
914
|
+
|
|
915
|
+
> `optional` **awsSesAccessKeyId**: `string`
|
|
916
|
+
|
|
917
|
+
AWS SES access key id.
|
|
918
|
+
|
|
919
|
+
#### Inherited from
|
|
920
|
+
|
|
921
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineServerEnvironmentVariables.md#awssesaccesskeyid)
|
|
922
|
+
|
|
923
|
+
***
|
|
924
|
+
|
|
925
|
+
### awsSesEndpoint?
|
|
926
|
+
|
|
927
|
+
> `optional` **awsSesEndpoint**: `string`
|
|
928
|
+
|
|
929
|
+
AWS SES endpoint.
|
|
847
930
|
|
|
848
931
|
#### Inherited from
|
|
849
932
|
|
|
850
|
-
[`
|
|
933
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesEndpoint`](IEngineServerEnvironmentVariables.md#awssesendpoint)
|
|
851
934
|
|
|
852
935
|
***
|
|
853
936
|
|
|
@@ -859,19 +942,43 @@ The applications for the push notifications JSON stringified array of IAwsApplic
|
|
|
859
942
|
|
|
860
943
|
#### Inherited from
|
|
861
944
|
|
|
862
|
-
[`
|
|
945
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsMessagingPushNotificationApplications`](IEngineServerEnvironmentVariables.md#awsmessagingpushnotificationapplications)
|
|
946
|
+
|
|
947
|
+
***
|
|
948
|
+
|
|
949
|
+
### messagingEmailConnector?
|
|
950
|
+
|
|
951
|
+
> `optional` **messagingEmailConnector**: `string`
|
|
952
|
+
|
|
953
|
+
The type of messaging email connector: entity-storage, aws.
|
|
954
|
+
|
|
955
|
+
#### Inherited from
|
|
956
|
+
|
|
957
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingEmailConnector`](IEngineServerEnvironmentVariables.md#messagingemailconnector)
|
|
958
|
+
|
|
959
|
+
***
|
|
960
|
+
|
|
961
|
+
### messagingSmsConnector?
|
|
962
|
+
|
|
963
|
+
> `optional` **messagingSmsConnector**: `string`
|
|
964
|
+
|
|
965
|
+
The type of messaging sms connector: entity-storage, aws.
|
|
966
|
+
|
|
967
|
+
#### Inherited from
|
|
968
|
+
|
|
969
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingSmsConnector`](IEngineServerEnvironmentVariables.md#messagingsmsconnector)
|
|
863
970
|
|
|
864
971
|
***
|
|
865
972
|
|
|
866
|
-
###
|
|
973
|
+
### messagingPushNotificationConnector?
|
|
867
974
|
|
|
868
|
-
> `optional` **
|
|
975
|
+
> `optional` **messagingPushNotificationConnector**: `string`
|
|
869
976
|
|
|
870
|
-
The type of messaging
|
|
977
|
+
The type of messaging push notification connector: entity-storage, aws.
|
|
871
978
|
|
|
872
979
|
#### Inherited from
|
|
873
980
|
|
|
874
|
-
[`
|
|
981
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`messagingPushNotificationConnector`](IEngineServerEnvironmentVariables.md#messagingpushnotificationconnector)
|
|
875
982
|
|
|
876
983
|
***
|
|
877
984
|
|
|
@@ -883,7 +990,7 @@ The type of telemetry connector: entity-storage.
|
|
|
883
990
|
|
|
884
991
|
#### Inherited from
|
|
885
992
|
|
|
886
|
-
[`
|
|
993
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`telemetryConnector`](IEngineServerEnvironmentVariables.md#telemetryconnector)
|
|
887
994
|
|
|
888
995
|
***
|
|
889
996
|
|
|
@@ -895,7 +1002,7 @@ The type of faucet connector: entity-storage, iota.
|
|
|
895
1002
|
|
|
896
1003
|
#### Inherited from
|
|
897
1004
|
|
|
898
|
-
[`
|
|
1005
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`faucetConnector`](IEngineServerEnvironmentVariables.md#faucetconnector)
|
|
899
1006
|
|
|
900
1007
|
***
|
|
901
1008
|
|
|
@@ -907,7 +1014,7 @@ The type of wallet connector: entity-storage, iota.
|
|
|
907
1014
|
|
|
908
1015
|
#### Inherited from
|
|
909
1016
|
|
|
910
|
-
[`
|
|
1017
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`walletConnector`](IEngineServerEnvironmentVariables.md#walletconnector)
|
|
911
1018
|
|
|
912
1019
|
***
|
|
913
1020
|
|
|
@@ -919,7 +1026,7 @@ The type of NFT connector: entity-storage, iota.
|
|
|
919
1026
|
|
|
920
1027
|
#### Inherited from
|
|
921
1028
|
|
|
922
|
-
[`
|
|
1029
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`nftConnector`](IEngineServerEnvironmentVariables.md#nftconnector)
|
|
923
1030
|
|
|
924
1031
|
***
|
|
925
1032
|
|
|
@@ -931,7 +1038,19 @@ The type of identity connector: entity-storage, iota.
|
|
|
931
1038
|
|
|
932
1039
|
#### Inherited from
|
|
933
1040
|
|
|
934
|
-
[`
|
|
1041
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityConnector`](IEngineServerEnvironmentVariables.md#identityconnector)
|
|
1042
|
+
|
|
1043
|
+
***
|
|
1044
|
+
|
|
1045
|
+
### identityWalletAddressIndex?
|
|
1046
|
+
|
|
1047
|
+
> `optional` **identityWalletAddressIndex**: `string`
|
|
1048
|
+
|
|
1049
|
+
The index of the wallet address to use, defaults to 0.
|
|
1050
|
+
|
|
1051
|
+
#### Inherited from
|
|
1052
|
+
|
|
1053
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityWalletAddressIndex`](IEngineServerEnvironmentVariables.md#identitywalletaddressindex)
|
|
935
1054
|
|
|
936
1055
|
***
|
|
937
1056
|
|
|
@@ -943,7 +1062,7 @@ The type of identity resolver connector: entity-storage, iota.
|
|
|
943
1062
|
|
|
944
1063
|
#### Inherited from
|
|
945
1064
|
|
|
946
|
-
[`
|
|
1065
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityResolverConnector`](IEngineServerEnvironmentVariables.md#identityresolverconnector)
|
|
947
1066
|
|
|
948
1067
|
***
|
|
949
1068
|
|
|
@@ -955,7 +1074,7 @@ The type of verifiable storage connector: entity-storage, iota.
|
|
|
955
1074
|
|
|
956
1075
|
#### Inherited from
|
|
957
1076
|
|
|
958
|
-
[`
|
|
1077
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`verifiableStorageConnector`](IEngineServerEnvironmentVariables.md#verifiablestorageconnector)
|
|
959
1078
|
|
|
960
1079
|
***
|
|
961
1080
|
|
|
@@ -967,7 +1086,7 @@ IOTA Faucet Endpoint.
|
|
|
967
1086
|
|
|
968
1087
|
#### Inherited from
|
|
969
1088
|
|
|
970
|
-
[`
|
|
1089
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaFaucetEndpoint`](IEngineServerEnvironmentVariables.md#iotafaucetendpoint)
|
|
971
1090
|
|
|
972
1091
|
***
|
|
973
1092
|
|
|
@@ -979,7 +1098,7 @@ IOTA Node Endpoint.
|
|
|
979
1098
|
|
|
980
1099
|
#### Inherited from
|
|
981
1100
|
|
|
982
|
-
[`
|
|
1101
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNodeEndpoint`](IEngineServerEnvironmentVariables.md#iotanodeendpoint)
|
|
983
1102
|
|
|
984
1103
|
***
|
|
985
1104
|
|
|
@@ -991,7 +1110,7 @@ IOTA network.
|
|
|
991
1110
|
|
|
992
1111
|
#### Inherited from
|
|
993
1112
|
|
|
994
|
-
[`
|
|
1113
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaNetwork`](IEngineServerEnvironmentVariables.md#iotanetwork)
|
|
995
1114
|
|
|
996
1115
|
***
|
|
997
1116
|
|
|
@@ -1003,7 +1122,7 @@ IOTA coin type.
|
|
|
1003
1122
|
|
|
1004
1123
|
#### Inherited from
|
|
1005
1124
|
|
|
1006
|
-
[`
|
|
1125
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaCoinType`](IEngineServerEnvironmentVariables.md#iotacointype)
|
|
1007
1126
|
|
|
1008
1127
|
***
|
|
1009
1128
|
|
|
@@ -1015,7 +1134,7 @@ IOTA Explorer Endpoint.
|
|
|
1015
1134
|
|
|
1016
1135
|
#### Inherited from
|
|
1017
1136
|
|
|
1018
|
-
[`
|
|
1137
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaExplorerEndpoint`](IEngineServerEnvironmentVariables.md#iotaexplorerendpoint)
|
|
1019
1138
|
|
|
1020
1139
|
***
|
|
1021
1140
|
|
|
@@ -1027,7 +1146,7 @@ IOTA Gas Station Endpoint.
|
|
|
1027
1146
|
|
|
1028
1147
|
#### Inherited from
|
|
1029
1148
|
|
|
1030
|
-
[`
|
|
1149
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationEndpoint`](IEngineServerEnvironmentVariables.md#iotagasstationendpoint)
|
|
1031
1150
|
|
|
1032
1151
|
***
|
|
1033
1152
|
|
|
@@ -1039,7 +1158,7 @@ IOTA Gas Station Authentication Token.
|
|
|
1039
1158
|
|
|
1040
1159
|
#### Inherited from
|
|
1041
1160
|
|
|
1042
|
-
[`
|
|
1161
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`iotaGasStationAuthToken`](IEngineServerEnvironmentVariables.md#iotagasstationauthtoken)
|
|
1043
1162
|
|
|
1044
1163
|
***
|
|
1045
1164
|
|
|
@@ -1051,7 +1170,7 @@ Universal Resolver Endpoint.
|
|
|
1051
1170
|
|
|
1052
1171
|
#### Inherited from
|
|
1053
1172
|
|
|
1054
|
-
[`
|
|
1173
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`universalResolverEndpoint`](IEngineServerEnvironmentVariables.md#universalresolverendpoint)
|
|
1055
1174
|
|
|
1056
1175
|
***
|
|
1057
1176
|
|
|
@@ -1063,7 +1182,7 @@ The type of identity profile connector: entity-storage.
|
|
|
1063
1182
|
|
|
1064
1183
|
#### Inherited from
|
|
1065
1184
|
|
|
1066
|
-
[`
|
|
1185
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`identityProfileConnector`](IEngineServerEnvironmentVariables.md#identityprofileconnector)
|
|
1067
1186
|
|
|
1068
1187
|
***
|
|
1069
1188
|
|
|
@@ -1075,7 +1194,7 @@ The identity verification method id to use with immutable proofs.
|
|
|
1075
1194
|
|
|
1076
1195
|
#### Inherited from
|
|
1077
1196
|
|
|
1078
|
-
[`
|
|
1197
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`immutableProofVerificationMethodId`](IEngineServerEnvironmentVariables.md#immutableproofverificationmethodid)
|
|
1079
1198
|
|
|
1080
1199
|
***
|
|
1081
1200
|
|
|
@@ -1087,7 +1206,7 @@ The type of attestation connector: entity-storage, iota.
|
|
|
1087
1206
|
|
|
1088
1207
|
#### Inherited from
|
|
1089
1208
|
|
|
1090
|
-
[`
|
|
1209
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationConnector`](IEngineServerEnvironmentVariables.md#attestationconnector)
|
|
1091
1210
|
|
|
1092
1211
|
***
|
|
1093
1212
|
|
|
@@ -1099,7 +1218,19 @@ The identity verification method id to use with attestation.
|
|
|
1099
1218
|
|
|
1100
1219
|
#### Inherited from
|
|
1101
1220
|
|
|
1102
|
-
[`
|
|
1221
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`attestationVerificationMethodId`](IEngineServerEnvironmentVariables.md#attestationverificationmethodid)
|
|
1222
|
+
|
|
1223
|
+
***
|
|
1224
|
+
|
|
1225
|
+
### dataProcessingEnabled?
|
|
1226
|
+
|
|
1227
|
+
> `optional` **dataProcessingEnabled**: `string`
|
|
1228
|
+
|
|
1229
|
+
Is the data processing enabled, defaults to false.
|
|
1230
|
+
|
|
1231
|
+
#### Inherited from
|
|
1232
|
+
|
|
1233
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataProcessingEnabled`](IEngineServerEnvironmentVariables.md#dataprocessingenabled)
|
|
1103
1234
|
|
|
1104
1235
|
***
|
|
1105
1236
|
|
|
@@ -1111,7 +1242,7 @@ The type of the default data converters, can be a comma separated list: json, xm
|
|
|
1111
1242
|
|
|
1112
1243
|
#### Inherited from
|
|
1113
1244
|
|
|
1114
|
-
[`
|
|
1245
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataConverterConnectors`](IEngineServerEnvironmentVariables.md#dataconverterconnectors)
|
|
1115
1246
|
|
|
1116
1247
|
***
|
|
1117
1248
|
|
|
@@ -1123,7 +1254,43 @@ The type of the default data extractor, can be a comma separated list: json-path
|
|
|
1123
1254
|
|
|
1124
1255
|
#### Inherited from
|
|
1125
1256
|
|
|
1126
|
-
[`
|
|
1257
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataExtractorConnectors`](IEngineServerEnvironmentVariables.md#dataextractorconnectors)
|
|
1258
|
+
|
|
1259
|
+
***
|
|
1260
|
+
|
|
1261
|
+
### auditableItemGraphEnabled?
|
|
1262
|
+
|
|
1263
|
+
> `optional` **auditableItemGraphEnabled**: `string`
|
|
1264
|
+
|
|
1265
|
+
Is the auditable item graph enabled, defaults to false.
|
|
1266
|
+
|
|
1267
|
+
#### Inherited from
|
|
1268
|
+
|
|
1269
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemGraphEnabled`](IEngineServerEnvironmentVariables.md#auditableitemgraphenabled)
|
|
1270
|
+
|
|
1271
|
+
***
|
|
1272
|
+
|
|
1273
|
+
### auditableItemStreamEnabled?
|
|
1274
|
+
|
|
1275
|
+
> `optional` **auditableItemStreamEnabled**: `string`
|
|
1276
|
+
|
|
1277
|
+
Is the auditable item stream enabled, defaults to false.
|
|
1278
|
+
|
|
1279
|
+
#### Inherited from
|
|
1280
|
+
|
|
1281
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`auditableItemStreamEnabled`](IEngineServerEnvironmentVariables.md#auditableitemstreamenabled)
|
|
1282
|
+
|
|
1283
|
+
***
|
|
1284
|
+
|
|
1285
|
+
### documentManagementEnabled?
|
|
1286
|
+
|
|
1287
|
+
> `optional` **documentManagementEnabled**: `string`
|
|
1288
|
+
|
|
1289
|
+
Is the document management enabled, defaults to false.
|
|
1290
|
+
|
|
1291
|
+
#### Inherited from
|
|
1292
|
+
|
|
1293
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`documentManagementEnabled`](IEngineServerEnvironmentVariables.md#documentmanagementenabled)
|
|
1127
1294
|
|
|
1128
1295
|
***
|
|
1129
1296
|
|
|
@@ -1135,7 +1302,7 @@ Is the synchronised storage enabled, defaults to false.
|
|
|
1135
1302
|
|
|
1136
1303
|
#### Inherited from
|
|
1137
1304
|
|
|
1138
|
-
[`
|
|
1305
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEnabled`](IEngineServerEnvironmentVariables.md#synchronisedstorageenabled)
|
|
1139
1306
|
|
|
1140
1307
|
***
|
|
1141
1308
|
|
|
@@ -1147,7 +1314,7 @@ Url which points to the api for a trusted synchronised storage node, not require
|
|
|
1147
1314
|
|
|
1148
1315
|
#### Inherited from
|
|
1149
1316
|
|
|
1150
|
-
[`
|
|
1317
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageTrustedUrl`](IEngineServerEnvironmentVariables.md#synchronisedstoragetrustedurl)
|
|
1151
1318
|
|
|
1152
1319
|
***
|
|
1153
1320
|
|
|
@@ -1156,24 +1323,11 @@ Url which points to the api for a trusted synchronised storage node, not require
|
|
|
1156
1323
|
> `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
|
|
1157
1324
|
|
|
1158
1325
|
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
|
|
1160
|
-
|
|
1161
|
-
#### Inherited from
|
|
1162
|
-
|
|
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.
|
|
1326
|
+
This only required if using a custom verifiable storage item, otherwise it will default to the network name.
|
|
1173
1327
|
|
|
1174
1328
|
#### Inherited from
|
|
1175
1329
|
|
|
1176
|
-
[`
|
|
1330
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageVerifiableStorageKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageverifiablestoragekeyid)
|
|
1177
1331
|
|
|
1178
1332
|
***
|
|
1179
1333
|
|
|
@@ -1187,7 +1341,7 @@ Defaults to synchronised-storage-blob-encryption
|
|
|
1187
1341
|
|
|
1188
1342
|
#### Inherited from
|
|
1189
1343
|
|
|
1190
|
-
[`
|
|
1344
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageEncryptionKeyId`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstorageencryptionkeyid)
|
|
1191
1345
|
|
|
1192
1346
|
***
|
|
1193
1347
|
|
|
@@ -1200,7 +1354,7 @@ Only required for trusted nodes, as regular nodes will not write encrypted data.
|
|
|
1200
1354
|
|
|
1201
1355
|
#### Inherited from
|
|
1202
1356
|
|
|
1203
|
-
[`
|
|
1357
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineServerEnvironmentVariables.md#synchronisedstorageblobstoragekey)
|
|
1204
1358
|
|
|
1205
1359
|
***
|
|
1206
1360
|
|
|
@@ -1218,7 +1372,7 @@ How often to check for entity updates in minutes.
|
|
|
1218
1372
|
|
|
1219
1373
|
#### Inherited from
|
|
1220
1374
|
|
|
1221
|
-
[`
|
|
1375
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageEntityUpdateIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageentityupdateintervalminutes)
|
|
1222
1376
|
|
|
1223
1377
|
***
|
|
1224
1378
|
|
|
@@ -1236,7 +1390,7 @@ Interval to perform consolidation of changesets, only used if this is a trusted
|
|
|
1236
1390
|
|
|
1237
1391
|
#### Inherited from
|
|
1238
1392
|
|
|
1239
|
-
[`
|
|
1393
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationIntervalMinutes`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationintervalminutes)
|
|
1240
1394
|
|
|
1241
1395
|
***
|
|
1242
1396
|
|
|
@@ -1254,7 +1408,7 @@ The number of entities to process in a single consolidation batch, only used if
|
|
|
1254
1408
|
|
|
1255
1409
|
#### Inherited from
|
|
1256
1410
|
|
|
1257
|
-
[`
|
|
1411
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageConsolidationBatchSize`](IEngineServerEnvironmentVariables.md#synchronisedstorageconsolidationbatchsize)
|
|
1258
1412
|
|
|
1259
1413
|
***
|
|
1260
1414
|
|
|
@@ -1272,7 +1426,7 @@ The maximum number of consolidations to keep in storage, only used if this is a
|
|
|
1272
1426
|
|
|
1273
1427
|
#### Inherited from
|
|
1274
1428
|
|
|
1275
|
-
[`
|
|
1429
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`synchronisedStorageMaxConsolidations`](IEngineServerEnvironmentVariables.md#synchronisedstoragemaxconsolidations)
|
|
1276
1430
|
|
|
1277
1431
|
***
|
|
1278
1432
|
|
|
@@ -1284,31 +1438,68 @@ Is the federated catalogue enabled, defaults to false.
|
|
|
1284
1438
|
|
|
1285
1439
|
#### Inherited from
|
|
1286
1440
|
|
|
1287
|
-
[`
|
|
1441
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineServerEnvironmentVariables.md#federatedcatalogueenabled)
|
|
1442
|
+
|
|
1443
|
+
***
|
|
1444
|
+
|
|
1445
|
+
### federatedCatalogueFilters?
|
|
1446
|
+
|
|
1447
|
+
> `optional` **federatedCatalogueFilters**: `string`
|
|
1448
|
+
|
|
1449
|
+
Federated catalog filters, command separated list of filters to add.
|
|
1450
|
+
|
|
1451
|
+
#### Inherited from
|
|
1452
|
+
|
|
1453
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueFilters`](IEngineServerEnvironmentVariables.md#federatedcataloguefilters)
|
|
1454
|
+
|
|
1455
|
+
***
|
|
1456
|
+
|
|
1457
|
+
### trustEnabled?
|
|
1458
|
+
|
|
1459
|
+
> `optional` **trustEnabled**: `string`
|
|
1460
|
+
|
|
1461
|
+
Is the trust management enabled, defaults to false.
|
|
1462
|
+
|
|
1463
|
+
#### Inherited from
|
|
1464
|
+
|
|
1465
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustEnabled`](IEngineServerEnvironmentVariables.md#trustenabled)
|
|
1288
1466
|
|
|
1289
1467
|
***
|
|
1290
1468
|
|
|
1291
|
-
###
|
|
1469
|
+
### trustGenerators?
|
|
1292
1470
|
|
|
1293
|
-
> `optional` **
|
|
1471
|
+
> `optional` **trustGenerators**: `string`
|
|
1294
1472
|
|
|
1295
|
-
|
|
1473
|
+
The trust generators to add to the factory, comma separated list.
|
|
1296
1474
|
|
|
1297
1475
|
#### Inherited from
|
|
1298
1476
|
|
|
1299
|
-
[`
|
|
1477
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustGenerators`](IEngineServerEnvironmentVariables.md#trustgenerators)
|
|
1300
1478
|
|
|
1301
1479
|
***
|
|
1302
1480
|
|
|
1303
|
-
###
|
|
1481
|
+
### trustVerifiers?
|
|
1304
1482
|
|
|
1305
|
-
> `optional` **
|
|
1483
|
+
> `optional` **trustVerifiers**: `string`
|
|
1306
1484
|
|
|
1307
|
-
|
|
1485
|
+
The trust verifiers to add to the factory, comma separated list.
|
|
1308
1486
|
|
|
1309
1487
|
#### Inherited from
|
|
1310
1488
|
|
|
1311
|
-
[`
|
|
1489
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustVerifiers`](IEngineServerEnvironmentVariables.md#trustverifiers)
|
|
1490
|
+
|
|
1491
|
+
***
|
|
1492
|
+
|
|
1493
|
+
### trustVerificationMethodId?
|
|
1494
|
+
|
|
1495
|
+
> `optional` **trustVerificationMethodId**: `string`
|
|
1496
|
+
|
|
1497
|
+
The verification method to use for trust identities.
|
|
1498
|
+
Defaults to node-authentication-assertion.
|
|
1499
|
+
|
|
1500
|
+
#### Inherited from
|
|
1501
|
+
|
|
1502
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustVerificationMethodId`](IEngineServerEnvironmentVariables.md#trustverificationmethodid)
|
|
1312
1503
|
|
|
1313
1504
|
***
|
|
1314
1505
|
|
|
@@ -1320,7 +1511,115 @@ Is the rights management enabled, defaults to false.
|
|
|
1320
1511
|
|
|
1321
1512
|
#### Inherited from
|
|
1322
1513
|
|
|
1323
|
-
[`
|
|
1514
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineServerEnvironmentVariables.md#rightsmanagementenabled)
|
|
1515
|
+
|
|
1516
|
+
***
|
|
1517
|
+
|
|
1518
|
+
### rightsManagementBaseCallbackUrl?
|
|
1519
|
+
|
|
1520
|
+
> `optional` **rightsManagementBaseCallbackUrl**: `string`
|
|
1521
|
+
|
|
1522
|
+
What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
|
|
1523
|
+
|
|
1524
|
+
#### Inherited from
|
|
1525
|
+
|
|
1526
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementBaseCallbackUrl`](IEngineServerEnvironmentVariables.md#rightsmanagementbasecallbackurl)
|
|
1527
|
+
|
|
1528
|
+
***
|
|
1529
|
+
|
|
1530
|
+
### rightsManagementPolicyInformationSources?
|
|
1531
|
+
|
|
1532
|
+
> `optional` **rightsManagementPolicyInformationSources**: `string`
|
|
1533
|
+
|
|
1534
|
+
The rights management policy information sources to add to the factory.
|
|
1535
|
+
|
|
1536
|
+
#### Inherited from
|
|
1537
|
+
|
|
1538
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyInformationSources`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyinformationsources)
|
|
1539
|
+
|
|
1540
|
+
***
|
|
1541
|
+
|
|
1542
|
+
### rightsManagementPolicyNegotiators?
|
|
1543
|
+
|
|
1544
|
+
> `optional` **rightsManagementPolicyNegotiators**: `string`
|
|
1545
|
+
|
|
1546
|
+
The rights management policy negotiators sources to add to the factory.
|
|
1547
|
+
|
|
1548
|
+
#### Inherited from
|
|
1549
|
+
|
|
1550
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyNegotiators`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicynegotiators)
|
|
1551
|
+
|
|
1552
|
+
***
|
|
1553
|
+
|
|
1554
|
+
### rightsManagementPolicyRequesters?
|
|
1555
|
+
|
|
1556
|
+
> `optional` **rightsManagementPolicyRequesters**: `string`
|
|
1557
|
+
|
|
1558
|
+
The rights management policy requesters to add to the factory.
|
|
1559
|
+
|
|
1560
|
+
#### Inherited from
|
|
1561
|
+
|
|
1562
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyRequesters`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyrequesters)
|
|
1563
|
+
|
|
1564
|
+
***
|
|
1565
|
+
|
|
1566
|
+
### rightsManagementPolicyExecutionActions?
|
|
1567
|
+
|
|
1568
|
+
> `optional` **rightsManagementPolicyExecutionActions**: `string`
|
|
1569
|
+
|
|
1570
|
+
The rights management policy execution actions to add to the factory.
|
|
1571
|
+
|
|
1572
|
+
#### Inherited from
|
|
1573
|
+
|
|
1574
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyExecutionActions`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyexecutionactions)
|
|
1575
|
+
|
|
1576
|
+
***
|
|
1577
|
+
|
|
1578
|
+
### rightsManagementPolicyEnforcementProcessors?
|
|
1579
|
+
|
|
1580
|
+
> `optional` **rightsManagementPolicyEnforcementProcessors**: `string`
|
|
1581
|
+
|
|
1582
|
+
The rights management policy enforcement processors to add to the factory.
|
|
1583
|
+
|
|
1584
|
+
#### Inherited from
|
|
1585
|
+
|
|
1586
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyEnforcementProcessors`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyenforcementprocessors)
|
|
1587
|
+
|
|
1588
|
+
***
|
|
1589
|
+
|
|
1590
|
+
### rightsManagementPolicyArbiters?
|
|
1591
|
+
|
|
1592
|
+
> `optional` **rightsManagementPolicyArbiters**: `string`
|
|
1593
|
+
|
|
1594
|
+
The rights management policy arbiters to add to the factory.
|
|
1595
|
+
|
|
1596
|
+
#### Inherited from
|
|
1597
|
+
|
|
1598
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementPolicyArbiters`](IEngineServerEnvironmentVariables.md#rightsmanagementpolicyarbiters)
|
|
1599
|
+
|
|
1600
|
+
***
|
|
1601
|
+
|
|
1602
|
+
### rightsManagementDataAccessHandlers?
|
|
1603
|
+
|
|
1604
|
+
> `optional` **rightsManagementDataAccessHandlers**: `string`
|
|
1605
|
+
|
|
1606
|
+
The rights management data access handlers to add to the factory.
|
|
1607
|
+
|
|
1608
|
+
#### Inherited from
|
|
1609
|
+
|
|
1610
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementDataAccessHandlers`](IEngineServerEnvironmentVariables.md#rightsmanagementdataaccesshandlers)
|
|
1611
|
+
|
|
1612
|
+
***
|
|
1613
|
+
|
|
1614
|
+
### backgroundTasksEnabled?
|
|
1615
|
+
|
|
1616
|
+
> `optional` **backgroundTasksEnabled**: `string`
|
|
1617
|
+
|
|
1618
|
+
Are background tasks enabled, defaults to false.
|
|
1619
|
+
|
|
1620
|
+
#### Inherited from
|
|
1621
|
+
|
|
1622
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`backgroundTasksEnabled`](IEngineServerEnvironmentVariables.md#backgroundtasksenabled)
|
|
1324
1623
|
|
|
1325
1624
|
***
|
|
1326
1625
|
|
|
@@ -1332,7 +1631,7 @@ Is the task scheduler enabled, defaults to false.
|
|
|
1332
1631
|
|
|
1333
1632
|
#### Inherited from
|
|
1334
1633
|
|
|
1335
|
-
[`
|
|
1634
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineServerEnvironmentVariables.md#taskschedulerenabled)
|
|
1336
1635
|
|
|
1337
1636
|
***
|
|
1338
1637
|
|
|
@@ -1344,20 +1643,80 @@ Is the data space connector enabled, defaults to false.
|
|
|
1344
1643
|
|
|
1345
1644
|
#### Inherited from
|
|
1346
1645
|
|
|
1347
|
-
[`
|
|
1646
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorEnabled`](IEngineServerEnvironmentVariables.md#dataspaceconnectorenabled)
|
|
1647
|
+
|
|
1648
|
+
***
|
|
1649
|
+
|
|
1650
|
+
### dataSpaceConnectorRetainActivityLogsFor?
|
|
1651
|
+
|
|
1652
|
+
> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
|
|
1653
|
+
|
|
1654
|
+
The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
|
|
1655
|
+
|
|
1656
|
+
#### Default
|
|
1657
|
+
|
|
1658
|
+
```ts
|
|
1659
|
+
10
|
|
1660
|
+
```
|
|
1661
|
+
|
|
1662
|
+
#### Inherited from
|
|
1663
|
+
|
|
1664
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineServerEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
|
|
1665
|
+
|
|
1666
|
+
***
|
|
1667
|
+
|
|
1668
|
+
### dataSpaceConnectorActivityLogsCleanUpInterval?
|
|
1669
|
+
|
|
1670
|
+
> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
|
|
1671
|
+
|
|
1672
|
+
The interval for cleaning up the activity logs.
|
|
1673
|
+
|
|
1674
|
+
#### Default
|
|
1675
|
+
|
|
1676
|
+
```ts
|
|
1677
|
+
60
|
|
1678
|
+
```
|
|
1679
|
+
|
|
1680
|
+
#### Inherited from
|
|
1681
|
+
|
|
1682
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineServerEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
|
|
1683
|
+
|
|
1684
|
+
***
|
|
1685
|
+
|
|
1686
|
+
### vcAuthenticationEnabled?
|
|
1687
|
+
|
|
1688
|
+
> `optional` **vcAuthenticationEnabled**: `string`
|
|
1689
|
+
|
|
1690
|
+
Enable verifiable credential authentication for the API.
|
|
1691
|
+
|
|
1692
|
+
#### Inherited from
|
|
1693
|
+
|
|
1694
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationEnabled`](IEngineServerEnvironmentVariables.md#vcauthenticationenabled)
|
|
1695
|
+
|
|
1696
|
+
***
|
|
1697
|
+
|
|
1698
|
+
### vcAuthenticationVerificationMethodId?
|
|
1699
|
+
|
|
1700
|
+
> `optional` **vcAuthenticationVerificationMethodId**: `string`
|
|
1701
|
+
|
|
1702
|
+
Verifiable credential assertion for node to node communication.
|
|
1703
|
+
Defaults to node-authentication-assertion.
|
|
1704
|
+
|
|
1705
|
+
#### Inherited from
|
|
1706
|
+
|
|
1707
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`vcAuthenticationVerificationMethodId`](IEngineServerEnvironmentVariables.md#vcauthenticationverificationmethodid)
|
|
1348
1708
|
|
|
1349
1709
|
***
|
|
1350
1710
|
|
|
1351
|
-
###
|
|
1711
|
+
### extensions?
|
|
1352
1712
|
|
|
1353
|
-
> `optional` **
|
|
1713
|
+
> `optional` **extensions**: `string`
|
|
1354
1714
|
|
|
1355
|
-
|
|
1356
|
-
Use the @json: prefix to specify the path to the JSON configuration file.
|
|
1715
|
+
A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
|
|
1357
1716
|
|
|
1358
1717
|
#### Inherited from
|
|
1359
1718
|
|
|
1360
|
-
[`
|
|
1719
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`extensions`](IEngineServerEnvironmentVariables.md#extensions)
|
|
1361
1720
|
|
|
1362
1721
|
***
|
|
1363
1722
|
|
|
@@ -1481,64 +1840,106 @@ Additional MIME type processors to include, comma separated.
|
|
|
1481
1840
|
|
|
1482
1841
|
***
|
|
1483
1842
|
|
|
1484
|
-
###
|
|
1843
|
+
### routeLoggingIncludeBody?
|
|
1844
|
+
|
|
1845
|
+
> `optional` **routeLoggingIncludeBody**: `string`
|
|
1846
|
+
|
|
1847
|
+
Include the body in the REST logging output, useful for debugging.
|
|
1848
|
+
|
|
1849
|
+
#### Inherited from
|
|
1850
|
+
|
|
1851
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingIncludeBody`](IEngineServerEnvironmentVariables.md#routeloggingincludebody)
|
|
1852
|
+
|
|
1853
|
+
***
|
|
1854
|
+
|
|
1855
|
+
### routeLoggingFullBase64?
|
|
1856
|
+
|
|
1857
|
+
> `optional` **routeLoggingFullBase64**: `string`
|
|
1858
|
+
|
|
1859
|
+
Include the full base 64 output in the REST logging output, useful for debugging.
|
|
1860
|
+
|
|
1861
|
+
#### Inherited from
|
|
1862
|
+
|
|
1863
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingFullBase64`](IEngineServerEnvironmentVariables.md#routeloggingfullbase64)
|
|
1864
|
+
|
|
1865
|
+
***
|
|
1866
|
+
|
|
1867
|
+
### routeLoggingObfuscateProperties?
|
|
1485
1868
|
|
|
1486
|
-
> `optional` **
|
|
1869
|
+
> `optional` **routeLoggingObfuscateProperties**: `string`
|
|
1487
1870
|
|
|
1488
|
-
|
|
1871
|
+
List of properties to obfuscate in the REST logging output, comma separated.
|
|
1489
1872
|
|
|
1490
1873
|
#### Inherited from
|
|
1491
1874
|
|
|
1492
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
1875
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`routeLoggingObfuscateProperties`](IEngineServerEnvironmentVariables.md#routeloggingobfuscateproperties)
|
|
1493
1876
|
|
|
1494
1877
|
***
|
|
1495
1878
|
|
|
1496
|
-
###
|
|
1879
|
+
### extensionsMaxSizeMb?
|
|
1497
1880
|
|
|
1498
|
-
> `optional` **
|
|
1881
|
+
> `optional` **extensionsMaxSizeMb**: `number`
|
|
1499
1882
|
|
|
1500
|
-
|
|
1883
|
+
Maximum size in MB for HTTPS extensions downloads.
|
|
1501
1884
|
|
|
1502
1885
|
#### Default
|
|
1503
1886
|
|
|
1504
1887
|
```ts
|
|
1505
|
-
|
|
1888
|
+
10
|
|
1506
1889
|
```
|
|
1507
1890
|
|
|
1508
1891
|
***
|
|
1509
1892
|
|
|
1510
|
-
###
|
|
1893
|
+
### extensionsClearCache?
|
|
1894
|
+
|
|
1895
|
+
> `optional` **extensionsClearCache**: `boolean`
|
|
1511
1896
|
|
|
1512
|
-
|
|
1897
|
+
Whether to clear the extensions cache on startup.
|
|
1513
1898
|
|
|
1514
|
-
|
|
1899
|
+
#### Default
|
|
1900
|
+
|
|
1901
|
+
```ts
|
|
1902
|
+
false
|
|
1903
|
+
```
|
|
1515
1904
|
|
|
1516
1905
|
***
|
|
1517
1906
|
|
|
1518
|
-
###
|
|
1907
|
+
### extensionsCacheDirectory?
|
|
1908
|
+
|
|
1909
|
+
> `optional` **extensionsCacheDirectory**: `string`
|
|
1910
|
+
|
|
1911
|
+
Custom directory for extensions cache storage.
|
|
1519
1912
|
|
|
1520
|
-
|
|
1913
|
+
#### Default
|
|
1521
1914
|
|
|
1522
|
-
|
|
1915
|
+
```ts
|
|
1916
|
+
".tmp"
|
|
1917
|
+
```
|
|
1523
1918
|
|
|
1524
1919
|
***
|
|
1525
1920
|
|
|
1526
|
-
###
|
|
1921
|
+
### extensionsCacheTtlHours?
|
|
1527
1922
|
|
|
1528
|
-
> `optional` **
|
|
1923
|
+
> `optional` **extensionsCacheTtlHours**: `number`
|
|
1529
1924
|
|
|
1530
|
-
|
|
1925
|
+
TTL in hours for HTTPS extensions cache.
|
|
1531
1926
|
|
|
1532
1927
|
#### Default
|
|
1533
1928
|
|
|
1534
1929
|
```ts
|
|
1535
|
-
|
|
1930
|
+
24
|
|
1536
1931
|
```
|
|
1537
1932
|
|
|
1538
1933
|
***
|
|
1539
1934
|
|
|
1540
|
-
###
|
|
1935
|
+
### extensionsForceRefresh?
|
|
1541
1936
|
|
|
1542
|
-
> `optional` **
|
|
1937
|
+
> `optional` **extensionsForceRefresh**: `boolean`
|
|
1543
1938
|
|
|
1544
|
-
|
|
1939
|
+
Force refresh of all cached extensions.
|
|
1940
|
+
|
|
1941
|
+
#### Default
|
|
1942
|
+
|
|
1943
|
+
```ts
|
|
1944
|
+
false
|
|
1945
|
+
```
|