external/MeshCentral
1
0
Fork 0
mirror of https://github.com/Ylianst/MeshCentral.git synced 2025-02-15 04:21:51 +00:00
Code Issues Releases Wiki Activity

docs - updating config

Browse source
This commit is contained in:
silversword411 2022-09-30 13:03:24 -04:00
parent dee3f58892
commit 64c81569c3
No known key found for this signature in database
GPG key ID: CF805301BBB8CC0C
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/docs/meshcentral/config.md
View file

@ -356,7 +356,7 @@ See description for information about each item.
"loginKey": { "type": [ "string", "array" ], "items": { "type": "string" }, "default": null, "description": "Requires that users add the value ?key=xxx in the URL in order to see the web site." }, "loginKey": { "type": [ "string", "array" ], "items": { "type": "string" }, "default": null, "description": "Requires that users add the value ?key=xxx in the URL in order to see the web site." },
"agentKey": { "type": [ "string", "array" ], "items": { "type": "string" }, "default": null, "description": "Requires that agents add the value ?key=xxx in the URL in order to connect. This is not automatic and needs to be manually added in the meshagent.msh file." }, "agentKey": { "type": [ "string", "array" ], "items": { "type": "string" }, "default": null, "description": "Requires that agents add the value ?key=xxx in the URL in order to connect. This is not automatic and needs to be manually added in the meshagent.msh file." },
"ipkvm": { "type": "boolean", "default": false, "description": "Set to true to enable IP KVM device support in this domain." }, "ipkvm": { "type": "boolean", "default": false, "description": "Set to true to enable IP KVM device support in this domain." },
"minify": { "type": "boolean", "default": false, "description": "When enabled, the server will send reduced sided web pages." }, "minify": { "type": "boolean", "default": false, "description": "When enabled, the server will send reduced sized web pages." },
"newAccounts": { "type": "boolean", "default": false, "description": "When set to true, allow new user accounts to be created from the login page." }, "newAccounts": { "type": "boolean", "default": false, "description": "When set to true, allow new user accounts to be created from the login page." },
"newAccountsPass": { "type": "string", "default": null, "description": "When set this password will be required in order to create a new account from the login screen." }, "newAccountsPass": { "type": "string", "default": null, "description": "When set this password will be required in order to create a new account from the login screen." },
"newAccountsCaptcha": { "type": "boolean", "default": false, "description": "When set to true, users will get a CAPTCHA when creating a new account from the login screen." }, "newAccountsCaptcha": { "type": "boolean", "default": false, "description": "When set to true, users will get a CAPTCHA when creating a new account from the login screen." },
@ -410,12 +410,12 @@ See description for information about each item.
"enum": [ "bat", "ps1", "sh", "agent" ] "enum": [ "bat", "ps1", "sh", "agent" ]
}, },
"runas": { "runas": {
"description": "How to run this script, does not appy to agent scripts.", "description": "How to run this script, does not apply to agent scripts.",
"type": "string", "type": "string",
"enum": ["agent", "userfirst", "user"] "enum": ["agent", "userfirst", "user"]
}, },
"cmd": { "cmd": {
"description": "The command or \\r\\n seperated commands to run, if set do not use the file key.", "description": "The command or \\r\\n separated commands to run, if set do not use the file key.",
"type": "string" "type": "string"
}, },
"file": { "file": {
@ -562,13 +562,13 @@ See description for information about each item.
"ldapSyncWithUserGroups": { "ldapSyncWithUserGroups": {
"type": [ "boolean", "object" ], "type": [ "boolean", "object" ],
"default": false, "default": false,
"description": "When set to true or set to an object, MeshCentral will syncronized LDAP user memberships to MeshCentral user groups.", "description": "When set to true or set to an object, MeshCentral will synchronize LDAP user memberships to MeshCentral user groups.",
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"filter": { "filter": {
"type": [ "string", "array" ], "type": [ "string", "array" ],
"default": null, "default": null,
"description": "When set to a string or array of strings, only LDAP membership groups that includes one of the strings will be syncronized with MeshCentral user groups." "description": "When set to a string or array of strings, only LDAP membership groups that includes one of the strings will be synchronized with MeshCentral user groups."
} }
} }
}, },