mirror of
https://github.com/Ylianst/MeshCentral.git
synced 2024-12-26 07:05:52 -05:00
docs - updating config
This commit is contained in:
silversword411
parent
428d9c649a
commit
d433d5bcee
@ -15,6 +15,7 @@ See description for information about each item.
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cert": { "type": "string", "description": "Set this to the primary DNS name of this MeshCentral server." },
|
||||
"keepCerts": { "type": "boolean", "default": false, "description": "Force MeshCentral to use the HTTPS and MPS certificates even if the name does not match the expected DNS value." },
|
||||
"mongoDb": { "type": "string", "default": null },
|
||||
"mongoDbName": { "type": "string" },
|
||||
"mongoDbChangeStream": { "type": "boolean", "default": false },
|
||||
@ -88,9 +89,9 @@ See description for information about each item.
|
||||
"sessionTime": { "type": "integer", "default": 60, "description": "Duration of a session cookie in minutes. Changing this affects how often the session needs to be automatically refreshed." },
|
||||
"sessionKey": { "type": "string", "default": null, "description": "Password used to encrypt the MeshCentral web session cookies. If null, a random one is generated each time the server starts." },
|
||||
"sessionSameSite": { "type": "string", "default": "lax", "enum": ["strict", "lax", "none"] },
|
||||
"dbEncryptKey": { "type": "string" },
|
||||
"dbRecordsEncryptKey": { "type": "string", "default": null },
|
||||
"dbRecordsDecryptKey": { "type": "string", "default": null },
|
||||
"dbEncryptKey": { "type": "string", "default": null, "description": "This value is only valid when used with NeDB, sets the database encryption and decryption key." },
|
||||
"dbRecordsEncryptKey": { "type": "string", "default": null, "description": "With any database, encrypt and decrypt sensitive information within records using this secret key." },
|
||||
"dbRecordsDecryptKey": { "type": "string", "default": null, "description": "With any database, decrypt sensitive information within records using this secret key, don't use a key to encrypt records." },
|
||||
"dbExpire": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
@ -347,6 +348,7 @@ See description for information about each item.
|
||||
"loginPicture": { "type": "string", "default": null, "description": "Web site .png logo file placed in meshcentral-data that used on the login page when sitestyle is 2." },
|
||||
"rootRedirect": { "type": "string", "default": null, "description": "Redirects HTTP root requests to this URL. When in use, direct users to /login to see the normal login page." },
|
||||
"mobileSite": { "type": "boolean", "default": true, "description": "When set to false, this setting will disable the mobile site." },
|
||||
"maxDeviceView": { "type": "integer", "default": null, "description": "The maximum number of devices a user can see on the devices page at the same time. By default all devices will show, but this may need to be limited on servers with large number of devices." },
|
||||
"unknownUserRootRedirect": { "type": "string", "default": null, "description": "Redirects HTTP root requests to this URL only where user is not already logged in. When in use, direct users to /login to see the normal login page." },
|
||||
"nightMode": { "type": "integer", "default": 0, "description": "0 = User selects day/night mode, 1 = Always night mode, 2 = Always day mode" },
|
||||
"userQuota": { "type": "integer" },
|
||||
@ -390,6 +392,39 @@ See description for information about each item.
|
||||
"expire": { "type": "number", "description": "When set, limits the self-created guest sharing link to this number of minutes." }
|
||||
}
|
||||
},
|
||||
"PreconfiguredScripts": {
|
||||
"type": "array",
|
||||
"default": null,
|
||||
"description": "When set, your can try click the run button to run on of these scripts on the remote device.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [ "name", "type" ],
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "Name of the script.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The type of script.",
|
||||
"type": "string",
|
||||
"enum": [ "bat", "ps1", "sh", "agent" ]
|
||||
},
|
||||
"runas": {
|
||||
"description": "How to run this script, does not appy 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.",
|
||||
"type": "string"
|
||||
},
|
||||
"file": {
|
||||
"description": "The script file path and name, if set do not use the cmd key. This file path starts in meshcentral-data.",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"preConfiguredRemoteInput": {
|
||||
"type": "array",
|
||||
"default": null,
|
||||
@ -523,6 +558,26 @@ See description for information about each item.
|
||||
"ldapUserPhoneNumber": { "type": "string", "default": "telephoneNumber", "description": "The LDAP value to use for the user's phone number." },
|
||||
"ldapUserImage": { "type": "string", "default": "thumbnailPhoto", "description": "The LDAP value to use for the user's image." },
|
||||
"ldapSaveUserToFile": { "type": "string", "default": null, "description": "When set to a filename, for example c:\\temp\\ldapusers.txt, MeshCentral will save the LDAP user object to this file each time a user logs in. This is used for debugging LDAP issues." },
|
||||
"ldapUserGroups": { "type": "string", "default": "memberOf", "description": "The LDAP value to use for the user's group memberships." },
|
||||
"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.",
|
||||
"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."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ldapSiteAdminGroups": {
|
||||
"type": [ "string", "array" ],
|
||||
"default": null,
|
||||
"description": "When set to a list of LDAP groups, users that are part of one of these groups will be set a site administrator, otherwise site administrator rights will be removed."
|
||||
},
|
||||
"ldapUserRequiredGroupMembership": { "type": [ "string", "array" ], "default": null, "description": "A list of LDAP groups. Users must be part of at least one of these groups to allow login. If null, all users are allowed to login." },
|
||||
"ldapOptions": { "type": "object", "description": "LDAP options passed to ldapauth-fork" },
|
||||
"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." },
|
||||
"agentNoProxy": { "type": "boolean", "default": false, "description": "When enabled, all newly installed MeshAgents will be instructed to no use a HTTP/HTTPS proxy even if one is configured on the remote system" },
|
||||
@ -1167,7 +1222,22 @@ See description for information about each item.
|
||||
"tokenURL": { "type": "string", "format": "uri", "description": "If set, this will be used as the token URL. (If set authorizationURL and userInfoURL need set also)" },
|
||||
"userInfoURL": { "type": "string", "format": "uri", "description": "If set, this will be used as the user info URL. (If set authorizationURL and tokenURL need set also)" },
|
||||
"logouturl": { "type": "string", "format": "uri", "description": "Then set, the user will be redirected to this URL when hitting the logout link." },
|
||||
"newAccounts": { "type": "boolean", "default": true }
|
||||
"newAccounts": { "type": "boolean", "default": true },
|
||||
"groups": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"required": { "type": [ "string", "array" ], "description": "When set, the user must be part of one of the OIDC user groups to login to MeshCentral." },
|
||||
"siteadmin": { "type": [ "string", "array" ], "description": "When set, users part of these groups will be promoted with site administrator in MeshCentral, users that are not part of these groups will be demoted." },
|
||||
"sync": {
|
||||
"type": [ "boolean", "object" ],
|
||||
"description": "Allows some or all ODIC user groups to be mirrored within MeshCentral as user groups.",
|
||||
"properties": {
|
||||
"enabled": { "type": "boolean", "default": false },
|
||||
"filter": { "type": [ "string", "array" ], "description": "When set, limits what OIDC groups are mirrored into MeshCentral user groups." }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [ "issuer", "clientid", "clientsecret", "callbackURL" ]
|
||||
}
|
||||
@ -1267,6 +1337,14 @@ See description for information about each item.
|
||||
"from": { "type": "string" }
|
||||
},
|
||||
"required": [ "provider", "apikey", "from" ]
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"provider": { "type": "string", "enum": [ "url" ] },
|
||||
"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." }
|
||||
},
|
||||
"required": [ "url" ]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user