Schema update.
Ylian Saint-Hilaire committed
Jun 15, 2020 at 06:54 UTC
8e5cb6d5eeecccb629f125cc7a20fb2e0316597a
1 file changed
+17
-17
meshcentral-config-schema.json
+17
-17
@@ -34,17 +34,17 @@
34
"RedirPort": { "type": "integer", "minimum": 1, "maximum": 65535 },
35
"RedirPortBind": { "type": "string" },
36
"RedirAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535 },
37
- "AgentPort": { "type": "integer", "minimum": 1, "maximum": 65535 },
38
- "AgentPortBind": { "type": "string" },
39
- "AgentAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535 },
40
- "AgentAliasDNS": { "type": "string", "format": "hostname" },
41
- "AgentPortTls": { "type": "boolean", "default": true },
37
+ "AgentPort": { "type": "integer", "minimum": 1, "maximum": 65535, "description": "When set, enabled a new HTTPS server port that only accepts agent connections" },
38
+ "AgentPortBind": { "type": "string", "description": "When set, binds the agent port to a specific network interface" },
39
+ "AgentAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535, "description": "When set, indicates the actual publically visible agent-only port. If not set, the AgentPort value is used" },
40
+ "AgentAliasDNS": { "type": "string", "format": "hostname", "description": "When set, specified the DNS name used by agents to connect to the agent-only port" },
41
+ "AgentPortTls": { "type": "boolean", "default": true, "description": "Indicates if the agent-only port must perform TLS, this should be set to false if TLS is performed in front of this server" },
42
"ExactPorts": { "type": "boolean", "default": false },
43
"AllowLoginToken": { "type": "boolean", "default": false },
44
"AllowFraming": { "type": "boolean", "default": false },
45
"CookieIpCheck": { "type": "boolean" },
46
"CookieEncoding": { "type": "string", "enum": [ "hex", "base64" ], "default": "base64" },
47
- "WebRTC": { "type": "boolean", "default": false },
47
+ "WebRTC": { "type": "boolean", "default": false, "description": "When enabled, allows use of WebRTC to allow direct network traffic between the agent and browser" },
48
"Nice404": { "type": "boolean" },
49
"ClickOnce": { "type": "boolean" },
50
"SelfUpdate": { "type": "boolean", "default": false, "description": "When true, this server will attempt to self-update everyday after midnight." },
@@ -55,13 +55,13 @@
55
"AgentIdleTimeout": { "type": "integer", "minimum": 1 },
56
"MeshErrorLogPath": { "type": "string" },
57
"NpmPath": { "type": "string" },
58
- "NpmProxy": { "type": "string" },
59
- "AllowHighQualityDesktop": { "type": "boolean" },
60
- "DesktopMultiplex": { "type": "boolean" },
61
- "UserAllowedIP": { "type": "string" },
62
- "UserBlockedIP": { "type": "string" },
63
- "AgentAllowedIP": { "type": "string" },
64
- "AgentBlockedIP": { "type": "string" },
58
+ "NpmProxy": { "type": "string", "format": "uri" },
59
+ "AllowHighQualityDesktop": { "type": "boolean", "default": true },
60
+ "DesktopMultiplex": { "type": "boolean", "default": false },
61
+ "UserAllowedIP": { "type": [ "string", "array" ] },
62
+ "UserBlockedIP": { "type": [ "string", "array" ] },
63
+ "AgentAllowedIP": { "type": [ "string", "array" ] },
64
+ "AgentBlockedIP": { "type": [ "string", "array" ] },
65
"AuthLog": { "type": "string" },
66
"ManageAllDeviceGroups": { "type": "array", "items": [ { "type": "string" } ] },
67
"ManageCrossDomain": { "type": "array", "items": [ { "type": "string" } ] },
@@ -74,13 +74,13 @@
74
},
75
"required": [ "name", "info" ]
76
},
77
- "TlsOffload": { "type": "string" },
77
+ "TlsOffload": { "type": [ "string", "boolean" ], "default": false },
78
"TrustedProxy": { "type": "string" },
79
"MpsPort": { "type": "integer", "minimum": 1, "maximum": 65535 },
80
"MpsPortBind": { "type": "string" },
81
"MpsAliasPort": { "type": "integer", "minimum": 1, "maximum": 65535 },
82
"MpsAliasHost": { "type": "string" },
83
- "MpsTlsOffload": { "type": "boolean" },
83
+ "MpsTlsOffload": { "type": "boolean", "default": false },
84
"No2FactorAuth": { "type": "boolean" },
85
"Log": { "type": "string" },
86
"syslog": { "type": "string" },
@@ -355,9 +355,9 @@
355
"properties": {
356
"email": { "type": "string", "format": "email" },
357
"names": { "type": "string" },
358
- "production": { "type": "boolean" }
358
+ "production": { "type": "boolean", "default": false }
359
},
360
- "required": [ "email", "names", "production" ]
360
+ "required": [ "email", "names" ]
361
},
362
"peers": {
363
"title" : "Server peering",