config.json schema improvements.
Ylian Saint-Hilaire committed
Jul 14, 2020 at 12:24 UTC
e00e0e82d005c228d82399055eff4efa856bcf30
1 file changed
+8
-7
meshcentral-config-schema.json
+8
-7
@@ -7,25 +7,26 @@
7
"settings": {
8
"type": "object",
9
"properties": {
10
- "cert": { "type": "string" },
10
+ "cert": { "type": "string", "description": "Set this to the primary DNS name of this MeshCentral server." },
11
"mongoDb": { "type": "string" },
12
"mongoDbName": { "type": "string" },
13
"mongoDbChangeStream": { "type": "boolean" },
14
"mongoDumpPath": { "type": "string" },
15
- "WANonly": { "type": "boolean", "default": false },
16
- "LANonly": { "type": "boolean", "default": false },
15
+ "WANonly": { "type": "boolean", "default": false, "description": "When enabled, only MeshCentral WAN features are enabled and agents will connect to the server using a well known DNS name." },
16
+ "LANonly": { "type": "boolean", "default": false, "description": "When enabled, only MeshCentral LAN features are enabled and agents will find the server using multicast LAN packets." },
17
"sessionTime": { "type": "integer" },
18
"sessionKey": { "type": "string" },
19
"sessionSameSite": { "type": "string" },
20
"dbEncryptKey": { "type": "string" },
21
+ "multicastKey": { "type": "string", "description": "When set, encrypts all multicast LAN traffic to agents using this key. This is only useful in LAN mode when agents and tools will multicast to find the server." },
22
"dbRecordsEncryptKey": { "type": "string" },
23
"dbRecordsDecryptKey": { "type": "string" },
24
"dbExpire": {
25
"type": "object",
26
"properties": {
26
- "events": { "type": "integer" },
27
- "powerevents": { "type": "integer" },
28
- "statsevents": { "type": "integer" }
27
+ "events": { "type": "integer", "default": 1728000, "description": "Amount of time in seconds that events are kept in the database." },
28
+ "powerevents": { "type": "integer", "default": 864000, "description": "Amount of time in seconds that device power events are kept in the database." },
29
+ "statsevents": { "type": "integer", "default": 2592000, "description": "Amount of time in seconds that server statistics are kept in the database." }
30
}
31
},
32
"port": { "type": "integer", "minimum": 1, "maximum": 65535 },
@@ -42,7 +43,7 @@
43
"agentCoreDump": { "type": "boolean", "default": false, "description": "Automatically activates and transfers any agent crash dump files to the server in meshcentral-data/coredumps." },
44
"exactPorts": { "type": "boolean", "default": false },
45
"allowLoginToken": { "type": "boolean", "default": false },
45
- "allowFraming": { "type": "boolean", "default": false },
46
+ "allowFraming": { "type": "boolean", "default": false, "description": "When enabled, the MeshCentral web site can be embedded within another website's iframe." },
47
"cookieIpCheck": { "type": "boolean" },
48
"cookieEncoding": { "type": "string", "enum": [ "hex", "base64" ], "default": "base64", "description": "Encoding format of cookies in the HTTP headers, this is typically Base64 but some reverse proxies will require HEX." },
49
"webRTC": { "type": "boolean", "default": false, "description": "When enabled, allows use of WebRTC to allow direct network traffic between the agent and browser." },