From dbeafec1dc65909c5f4299b396acfe73929be063 Mon Sep 17 00:00:00 2001
From: Ylian Saint-Hilaire <ysainthilaire@hotmail.com>
Date: Tue, 11 Aug 2020 13:14:38 -0700
Subject: [PATCH] Improved config.json schema

---
 meshcentral-config-schema.json | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/meshcentral-config-schema.json b/meshcentral-config-schema.json
index dab03421..a1730c96 100644
--- a/meshcentral-config-schema.json
+++ b/meshcentral-config-schema.json
@@ -143,23 +143,23 @@
           "userNameIsEmail": { "type": "boolean", "default": false, "description": "When enabled, the username of each account is also the email address of the account." },
           "newAccountEmailDomains": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
           "newAccountsRights": { "type": "array", "uniqueItems": true, "items": { "type": "string" } },
-          "welcomeText": { "type": "string" },
-          "welcomePicture": { "type": "string" },
+          "welcomeText": { "type": "string", "description": "Text that will be shown on the login screen." },
+          "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." },
           "hide": { "type": "integer" },
           "footer": { "type": "string" },
-          "certUrl": { "type": "string", "format": "uri" },
+          "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." },
           "passwordRequirements": {
             "type": "object",
             "properties": {
-              "min": { "type": "integer" },
-              "max": { "type": "integer" },
-              "upper": { "type": "integer" },
-              "lower": { "type": "integer" },
-              "numeric": { "type": "integer" },
-              "nonalpha": { "type": "integer" },
-              "reset": { "type": "integer" },
-              "force2factor": { "type": "boolean" },
-              "skip2factor": { "type": "string" }
+              "min": { "type": "integer", "description": "Minimum number of characters allowed for the account password." },
+              "max": { "type": "integer", "description": "Maximum number of characters allowed for the account password." },
+              "upper": { "type": "integer", "description": "Minimum number of upper case characters required in the password." },
+              "lower": { "type": "integer", "description": "Minimum number of lower case characters required in the password." },
+              "numeric": { "type": "integer", "description": "Minimum number of numeric characters required in the password." },
+              "nonalpha": { "type": "integer", "description": "Minimum number of non-alpha-numeric characters required in the password." },
+              "reset": { "type": "integer", "description": "Number of days after which the user is required to change the account password." },
+              "force2factor": { "type": "boolean", "description": "Requires that all accounts setup 2FA." },
+              "skip2factor": { "type": "string", "description": "IP addresses where 2FA login is skipped, for example: 127.0.0.1,192.168.2.0/24" }
             }
           },
           "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." },