config.json schema improvements.

This commit is contained in:
Ylian Saint-Hilaire 2020-07-14 12:24:58 -07:00
parent 30f727c32e
commit 4943dd4f6d
1 changed files with 8 additions and 7 deletions

View File

@ -7,25 +7,26 @@
"settings": { "settings": {
"type": "object", "type": "object",
"properties": { "properties": {
"cert": { "type": "string" }, "cert": { "type": "string", "description": "Set this to the primary DNS name of this MeshCentral server." },
"mongoDb": { "type": "string" }, "mongoDb": { "type": "string" },
"mongoDbName": { "type": "string" }, "mongoDbName": { "type": "string" },
"mongoDbChangeStream": { "type": "boolean" }, "mongoDbChangeStream": { "type": "boolean" },
"mongoDumpPath": { "type": "string" }, "mongoDumpPath": { "type": "string" },
"WANonly": { "type": "boolean", "default": false }, "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." },
"LANonly": { "type": "boolean", "default": false }, "LANonly": { "type": "boolean", "default": false, "description": "When enabled, only MeshCentral LAN features are enabled and agents will find the server using multicast LAN packets." },
"sessionTime": { "type": "integer" }, "sessionTime": { "type": "integer" },
"sessionKey": { "type": "string" }, "sessionKey": { "type": "string" },
"sessionSameSite": { "type": "string" }, "sessionSameSite": { "type": "string" },
"dbEncryptKey": { "type": "string" }, "dbEncryptKey": { "type": "string" },
"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." },
"dbRecordsEncryptKey": { "type": "string" }, "dbRecordsEncryptKey": { "type": "string" },
"dbRecordsDecryptKey": { "type": "string" }, "dbRecordsDecryptKey": { "type": "string" },
"dbExpire": { "dbExpire": {
"type": "object", "type": "object",
"properties": { "properties": {
"events": { "type": "integer" }, "events": { "type": "integer", "default": 1728000, "description": "Amount of time in seconds that events are kept in the database." },
"powerevents": { "type": "integer" }, "powerevents": { "type": "integer", "default": 864000, "description": "Amount of time in seconds that device power events are kept in the database." },
"statsevents": { "type": "integer" } "statsevents": { "type": "integer", "default": 2592000, "description": "Amount of time in seconds that server statistics are kept in the database." }
} }
}, },
"port": { "type": "integer", "minimum": 1, "maximum": 65535 }, "port": { "type": "integer", "minimum": 1, "maximum": 65535 },
@ -42,7 +43,7 @@
"agentCoreDump": { "type": "boolean", "default": false, "description": "Automatically activates and transfers any agent crash dump files to the server in meshcentral-data/coredumps." }, "agentCoreDump": { "type": "boolean", "default": false, "description": "Automatically activates and transfers any agent crash dump files to the server in meshcentral-data/coredumps." },
"exactPorts": { "type": "boolean", "default": false }, "exactPorts": { "type": "boolean", "default": false },
"allowLoginToken": { "type": "boolean", "default": false }, "allowLoginToken": { "type": "boolean", "default": false },
"allowFraming": { "type": "boolean", "default": false }, "allowFraming": { "type": "boolean", "default": false, "description": "When enabled, the MeshCentral web site can be embedded within another website's iframe." },
"cookieIpCheck": { "type": "boolean" }, "cookieIpCheck": { "type": "boolean" },
"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." }, "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." },
"webRTC": { "type": "boolean", "default": false, "description": "When enabled, allows use of WebRTC to allow direct network traffic between the agent and browser." }, "webRTC": { "type": "boolean", "default": false, "description": "When enabled, allows use of WebRTC to allow direct network traffic between the agent and browser." },