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