docs - updating schema for docs
silversword411 committed
Dec 16, 2022 at 09:07 UTC
a612b5c37b5d6b7ec31d66969d04b1d08ee3230b
1 file changed
+105
-17
docs/docs/meshcentral/config.md
+105
-17
@@ -534,6 +534,7 @@ See description for information about each item.
534
"sms2factor": { "type": "boolean", "default": true, "description": "Set to false to disable SMS 2FA." },
535
"push2factor": { "type": "boolean", "default": true, "description": "Set to false to disable push notification 2FA." },
536
"otp2factor": { "type": "boolean", "default": true, "description": "Set to false to disable one-time-password 2FA." },
537
+ "msg2factor": { "type": "boolean", "default": true, "description": "Set to false to disable user messaging 2FA." },
538
"backupcode2factor": { "type": "boolean", "default": true, "description": "Set to false to disable 2FA backup codes." },
539
"single2factorWarning": { "type": "boolean", "default": true, "description": "Set to false to disable single 2FA warning." },
540
"lock2factor": { "type": "boolean", "default": false, "description": "When set to true, prevents any changes to 2FA." },
@@ -1057,7 +1058,8 @@ See description for information about each item.
1058
"properties": {
1059
"from": { "type": "string", "format": "email", "description": "Email address used in the messages from field." },
1060
"apikey": { "type": "string", "description": "The SendGrid API key." },
1060
- "verifyemail": { "type": "boolean", "default": true, "description": "When set to false, the email format and DNS MX record are not checked." }
1061
+ "verifyemail": { "type": "boolean", "default": true, "description": "When set to false, the email format and DNS MX record are not checked." },
1062
+ "emailDelaySeconds": { "type": "integer", "default": 300, "description": "Time to wait before sending a device connection/disconnection notification email. If many events occur, they will be merged into a single email."}
1063
},
1064
"required": [ "from", "apikey" ]
1065
},
@@ -1099,11 +1101,8 @@ See description for information about each item.
1101
},
1102
"tlscertcheck": { "type": "boolean" },
1103
"tlsstrict": { "type": "boolean" },
1102
- "verifyemail": {
1103
- "type": "boolean",
1104
- "default": true,
1105
- "description": "When set to false, the email format and DNS MX record are not checked."
1106
- }
1104
+ "verifyemail": { "type": "boolean", "default": true, "description": "When set to false, the email format and DNS MX record are not checked." },
1105
+ "emailDelaySeconds": { "type": "integer", "default": 300, "description": "Time to wait before sending a device connection/disconnection notification email. If many events occur, they will be merged into a single email."}
1106
},
1107
"required": [ "from" ]
1108
},
@@ -1114,7 +1113,8 @@ See description for information about each item.
1113
"properties": {
1114
"newline": { "type": "string", "default": "unix", "description": "Possible values are unix or windows" },
1115
"path": { "type": "string", "default": "sendmail", "description": "Path to the sendmail command" },
1117
- "args": { "type": "array", "items": { "type": "string" }, "default": null, "description": "Array or arguments to pass to sendmail" }
1116
+ "args": { "type": "array", "items": { "type": "string" }, "default": null, "description": "Array or arguments to pass to sendmail" },
1117
+ "emailDelaySeconds": { "type": "integer", "default": 300, "description": "Time to wait before sending a device connection/disconnection notification email. If many events occur, they will be merged into a single email."}
1118
}
1119
},
1120
"authStrategies": {
@@ -1306,13 +1306,16 @@ See description for information about each item.
1306
"required": [ "host", "port", "from", "tls" ]
1307
},
1308
"sms": {
1309
- "title" : "SMS provider",
1309
+ "title": "SMS provider",
1310
"description": "Connects MeshCentral to a SMS text messaging provider, allows MeshCentral to send SMS messages for 2FA or user notification.",
1311
"oneOf": [
1312
{
1313
- "type": "object",
1313
+ "type": "object",
1314
"properties": {
1315
- "provider": { "type": "string", "enum": [ "twilio" ] },
1315
+ "provider": {
1316
+ "type": "string",
1317
+ "enum": [ "twilio" ]
1318
+ },
1319
"sid": { "type": "string" },
1320
"auth": { "type": "string" },
1321
"from": { "type": "string" }
@@ -1320,9 +1323,12 @@ See description for information about each item.
1323
"required": [ "provider", "sid", "auth", "from" ]
1324
},
1325
{
1323
- "type": "object",
1326
+ "type": "object",
1327
"properties": {
1325
- "provider": { "type": "string", "enum": [ "plivo" ] },
1328
+ "provider": {
1329
+ "type": "string",
1330
+ "enum": [ "plivo" ]
1331
+ },
1332
"id": { "type": "string" },
1333
"token": { "type": "string" },
1334
"from": { "type": "string" }
@@ -1330,25 +1336,107 @@ See description for information about each item.
1336
"required": [ "provider", "id", "token", "from" ]
1337
},
1338
{
1333
- "type": "object",
1339
+ "type": "object",
1340
"properties": {
1335
- "provider": { "type": "string", "enum": [ "telnyx" ] },
1341
+ "provider": {
1342
+ "type": "string",
1343
+ "enum": [ "telnyx" ]
1344
+ },
1345
"apikey": { "type": "string" },
1346
"from": { "type": "string" }
1347
},
1348
"required": [ "provider", "apikey", "from" ]
1349
},
1350
{
1342
- "type": "object",
1351
+ "type": "object",
1352
"properties": {
1344
- "provider": { "type": "string", "enum": [ "url" ] },
1345
- "url": { "type": "string", "description": "A http or https URL with {{phone}} and {{message}} in the string. These will be replaced with the URL encoded target phone number and message." }
1353
+ "provider": {
1354
+ "type": "string",
1355
+ "enum": [ "url" ]
1356
+ },
1357
+ "url": {
1358
+ "type": "string",
1359
+ "description": "A http or https URL with {{phone}} and {{message}} in the string. These will be replaced with the URL encoded target phone number and message."
1360
+ }
1361
},
1362
"required": [ "url" ]
1363
}
1364
]
1365
+ },
1366
+ "messaging": {
1367
+ "title" : "Messaging server",
1368
+ "description": "This section allow MeshCentral to send messages over user messaging networks like Telegram",
1369
+ "type": "object",
1370
+ "properties": {
1371
+ "telegram": {
1372
+ "type": "object",
1373
+ "description": "Configure Telegram messaging system",
1374
+ "properties": {
1375
+ "apiid": { "type": "number" },
1376
+ "apihash": { "type": "string" },
1377
+ "session": { "type": "string" }
1378
+ }
1379
+ },
1380
+ "discord": {
1381
+ "type": "object",
1382
+ "description": "Configure Discord messaging system",
1383
+ "properties": {
1384
+ "serverurl": { "type": "string", "format": "uri", "description": "An optional HTTP link to the discord server the user must join to get notifications." },
1385
+ "token": { "type": "string", "description": "A Discord bot token that MeshCentral will use to login to Discord." }
1386
+ },
1387
+ "required": [ "token" ]
1388
+ },
1389
+ "xmpp": {
1390
+ "type": "object",
1391
+ "description": "Configure XMPP messaging system",
1392
+ "properties": {
1393
+ "service": { "type": "string", "description": "Host name of the XMPP server." },
1394
+ "credentials": {
1395
+ "type": "object",
1396
+ "description": "Login credentials for the XMPP server.",
1397
+ "properties": {
1398
+ "username": { "type": "string" },
1399
+ "password": { "type": "string" }
1400
+ }
1401
+ }
1402
+ },
1403
+ "required": [ "credentials" ]
1404
+ },
1405
+ "callmebot": {
1406
+ "type": "boolean",
1407
+ "default": false,
1408
+ "description": "Enabled CallMeBot integration support."
1409
+ },
1410
+ "pushover": {
1411
+ "type": "object",
1412
+ "description": "Configure Pushover messaging system",
1413
+ "properties": {
1414
+ "token": { "type": "string", "description": "A Pushover application token that MeshCentral will use to login." }
1415
+ },
1416
+ "required": [ "token" ]
1417
+ },
1418
+ "ntfy": {
1419
+ "type": [ "boolean", "object" ],
1420
+ "default": false,
1421
+ "properties": {
1422
+ "host": { "type": "string", "description": "Host name of the ntfy server." },
1423
+ "userurl": { "type": "string", "description": "A URL given to users to help them setup this service." }
1424
+ },
1425
+ "description": "Enabled ntfy.sh integration support."
1426
+ },
1427
+ "zulip": {
1428
+ "type": "object",
1429
+ "properties": {
1430
+ "site": { "type": "string", "format": "uri", "default": "https://api.zulip.com", "description": "URL to the Zulip server"},
1431
+ "email": { "type": "string", "description": "Bot email address to login as." },
1432
+ "api_key": { "type": "string", "description": "Bot api key." }
1433
+ },
1434
+ "description": "Enabled Zulip integration support."
1435
+ }
1436
+ }
1437
}
1438
},
1439
"required": [ "settings", "domains" ]
1440
}
1441
+
1442
```
\ No newline at end of file