Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs update and typos in schema.json #4606

Merged
merged 2 commits into from Oct 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions .vscode/settings.json
Expand Up @@ -5,6 +5,7 @@
"accountcreate",
"accountid",
"accountremove",
"acebase",
"acmd",
"acmepath",
"actiontype",
Expand Down Expand Up @@ -599,6 +600,7 @@
"postflight",
"poweraction",
"powerevents",
"Preconfigured",
"Proto",
"publicid",
"pushlogin",
Expand Down Expand Up @@ -662,6 +664,7 @@
"rport",
"rtpass",
"rtuser",
"runas",
"runasuser",
"runasuseronly",
"runcommand",
Expand Down Expand Up @@ -822,6 +825,7 @@
"usercount",
"userex",
"userfiles",
"userfirst",
"usergroupchange",
"usergroups",
"userid",
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/meshcentral/config.md
Expand Up @@ -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." },
"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." },
"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." },
"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." },
Expand Down Expand Up @@ -410,12 +410,12 @@ See description for information about each item.
"enum": [ "bat", "ps1", "sh", "agent" ]
},
"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",
"enum": ["agent", "userfirst", "user"]
},
"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"
},
"file": {
Expand Down Expand Up @@ -562,13 +562,13 @@ See description for information about each item.
"ldapSyncWithUserGroups": {
"type": [ "boolean", "object" ],
"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,
"properties": {
"filter": {
"type": [ "string", "array" ],
"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."
}
}
},
Expand Down
10 changes: 5 additions & 5 deletions meshcentral-config-schema.json
Expand Up @@ -349,7 +349,7 @@
"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." },
"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." },
"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." },
Expand Down Expand Up @@ -403,12 +403,12 @@
"enum": [ "bat", "ps1", "sh", "agent" ]
},
"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",
"enum": ["agent", "userfirst", "user"]
},
"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"
},
"file": {
Expand Down Expand Up @@ -555,13 +555,13 @@
"ldapSyncWithUserGroups": {
"type": [ "boolean", "object" ],
"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,
"properties": {
"filter": {
"type": [ "string", "array" ],
"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."
}
}
},
Expand Down