Improved config.json schema
Ylian Saint-Hilaire committed
Aug 11, 2020 at 13:14 UTC
5277dd5686c801a5d9b1c3649eab87f2a3d56446
1 file changed
+12
-12
meshcentral-config-schema.json
+12
-12
@@ -143,23 +143,23 @@
143
"userNameIsEmail": { "type": "boolean", "default": false, "description": "When enabled, the username of each account is also the email address of the account." },
144
"newAccountEmailDomains": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
145
"newAccountsRights": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
146
- "welcomeText": { "type": "string" },
147
- "welcomePicture": { "type": "string" },
146
+ "welcomeText": { "type": "string", "description": "Text that will be shown on the login screen." },
147
+ "welcomePicture": { "type": "string", "description": "Name of the JPG file that will be shown on the login screen. Out this file in the meshcentral-data folder and place the name here." },
148
"hide": { "type": "integer" },
149
"footer": { "type": "string" },
150
- "certUrl": { "type": "string", "format": "uri" },
150
+ "certUrl": { "type": "string", "format": "uri", "description": "https url when to get the TLS certificate that MeshAgent's will see when connecting to this server. This setting is used when a reverse proxy like NGINX is used in front of MeshCentral." },
151
"passwordRequirements": {
152
"type": "object",
153
"properties": {
154
- "min": { "type": "integer" },
155
- "max": { "type": "integer" },
156
- "upper": { "type": "integer" },
157
- "lower": { "type": "integer" },
158
- "numeric": { "type": "integer" },
159
- "nonalpha": { "type": "integer" },
160
- "reset": { "type": "integer" },
161
- "force2factor": { "type": "boolean" },
162
- "skip2factor": { "type": "string" }
154
+ "min": { "type": "integer", "description": "Minimum number of characters allowed for the account password." },
155
+ "max": { "type": "integer", "description": "Maximum number of characters allowed for the account password." },
156
+ "upper": { "type": "integer", "description": "Minimum number of upper case characters required in the password." },
157
+ "lower": { "type": "integer", "description": "Minimum number of lower case characters required in the password." },
158
+ "numeric": { "type": "integer", "description": "Minimum number of numeric characters required in the password." },
159
+ "nonalpha": { "type": "integer", "description": "Minimum number of non-alpha-numeric characters required in the password." },
160
+ "reset": { "type": "integer", "description": "Number of days after which the user is required to change the account password." },
161
+ "force2factor": { "type": "boolean", "description": "Requires that all accounts setup 2FA." },
162
+ "skip2factor": { "type": "string", "description": "IP addresses where 2FA login is skipped, for example: 127.0.0.1,192.168.2.0/24" }
163
}
164
},
165
"agentInviteCodes": { "type": "boolean", "default": false, "description": "Enabled a feature where you can set one or more invitation codes in a device group. You can then give a invitation link to users who can use it to download the agent." },