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