Merge pull request #4745 from silversword411/master

Adding to docs
This commit is contained in:
Ylian Saint-Hilaire 2022-11-14 16:12:04 -08:00 committed by GitHub
commit 53bdbfb540
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 130 additions and 3 deletions

View File

@ -779,6 +779,7 @@
"tokenuserid",
"tokenusername",
"totalsize",
"TOTP",
"tpass",
"tpassword",
"tpush",

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB

View File

@ -49,6 +49,16 @@ Intel® AMT
If you are looking into managing remote computers that would be difficult to physically get access to for remote support or maintenance, one should probably look at getting a PC with Intel AMT.
## Bare-Metal Activation Server
The `AmtProvisioningServer` section in the `settings` section of the config.json will enable this feature. MeshCentral will then listen for activation requests, match against your ACM activation certificates and if everything goes well, will activate and add the device to a Intel AMT only device group. No agent or MeshCMD is involved.
This bare-metal activation server is not enabled by default and only makes sense when activating devices on the local network.
Once enabled, Intel AMT can send “hello” data to the MeshCentral provisioning server on port 9971 and MeshCentral will respond by connecting back, authenticating, and activating Intel AMT. MeshCentral will then log the event, add the device to a pre-defined agent-less device group and complete any remaining configuration. A trusted CA certificate is required to perform this operation fully automatically.
![baremetal](images/amtprovisioningserver.png)
## MeshCentral Group Types
Once MeshCentral is installed, a user will typically create a new device group. Here is the first hint that MeshCentral supports Intel AMT. Device groups come in two types. You can manage using a software agent, or using Intel AMT only.
@ -175,6 +185,10 @@ Once setup, Intel AMT will not automatically activate to Intel AMT unless the ri
- The name “meshcentral.com” by have been set as “Trusted FQDN” in MEBx.
- The name “meshcentral.com” must have been set using a USB key with a setup.bin file.
<div class="video-wrapper">
<iframe width="320" height="180" src="https://www.youtube.com/embed/mhq0bsWJEOw" frameborder="0" allowfullscreen></iframe>
</div>
Once Intel AMT is in a situation where ACM activation can occur, the activation command line can be run or the Mesh Agent will detect this situation and ask the server to perform activation.
![](images/2022-05-16-23-16-05.png)

View File

@ -50,7 +50,7 @@ For OSx 11+ including Big Sur, Monterey and later
## Apple macOS
For macOS 10.x including Catalina, Mojave, High Sierra, Sierra, El Capitan, Yosemite, Mavericks, Mountain Lion and earlier
For macOS 10.x including Catalina, Mojave, High Sierra, Sierra, El Capitan, Yosemite, Mavericks, Mountain Lion and earlier.
## Mobile Device (Android)

View File

@ -210,3 +210,60 @@ Note you can show CPU and Memory usage info by clicking the icon in the top righ
For debugging and communicating with the mesh agent.
It allows JS commands to be issued to the device but also run extra commands from the meshcore. Type `help` for all available options
- 2falock
- acceleratorsstats
- agentissues
- agentstats
- amtacm
- amtmanager
- amtpasswords
- amtstats
- args
- autobackup
- backupconfig
- bad2fa
- badlogins
- certexpire
- certhashes
- closeusersessions
- cores
- dbcounters
- dbstats
- dispatchtable
- dropallcira
- dupagents
- email
- emailnotifications
- firebase
- heapdump
- heapdump2
- help
- info
- le
- lecheck
- leevents
- maintenance
- migrationagents
- mps
- mpsstats
- msg
- nodeconfig
- print
- relays
- removeinactivedevices
- resetserver
- serverupdate
- setmaxtasks
- showpaths
- sms
- swarmstats
- tasklimiter
- trafficdelta
- trafficstats
- updatecheck
- usersessions
- versions
- watchdog
- webpush
- webstats

View File

@ -44,7 +44,9 @@ You're sure you're typing in everything right, giving it 2FA code and can't logi
![](images/2022-08-04-18-19-19.png)
# Branding and Customisation
# Branding and Customization
You can brand and customise MeshCentral almost as much as you like without delving into the code, a few changes in the config.json file and uplaoding images can change the way your system looks. Read more [here](https://ylianst.github.io/MeshCentral/meshcentral/#branding-terms-of-use)
You can brand and customize MeshCentral almost as much as you like without delving into the code, a few changes in the config.json file and uploading images can change the way your system looks. Read more [here](https://ylianst.github.io/MeshCentral/meshcentral/#branding-terms-of-use)
!!!note
You will need to reinstall the agent for agent customizations to take effect.

View File

@ -1258,6 +1258,59 @@ You can also customize the Agent to add your own logo.
![](images/2022-08-24-06-42-40.png)
```json
"agentCustomization": {
"displayName": {
"type": "string",
"default": "MeshCentral Agent",
"description": "The name of the agent as displayed to the user."
},
"description": {
"type": "string",
"default": "Mesh Agent background service",
"description": "The description of the agent as displayed to the user."
},
"companyName": {
"type": "string",
"default": "Mesh Agent",
"description": "This will be used as the path to install the agent, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's."
},
"serviceName": {
"type": "string",
"default": "Mesh Agent",
"description": "The name of the background service, by default this is 'Mesh Agent' in Windows and 'meshagent' in other OS's but should be set to an all lower case, no space string."
},
"installText": {
"type": "string",
"default": null,
"description": "Text string to show in the agent installation dialog box."
},
"image": {
"type": "string",
"default": null,
"description": "The filename of a image file in .png format located in meshcentral-data to display in the MeshCentral Agent installation dialog, image should be square and from 64x64 to 200x200."
},
"fileName": {
"type": "string",
"default": "meshagent",
"description": "The agent filename."
},
"foregroundColor": {
"type": "string",
"default": null,
"description": "Foreground text color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF."
},
"backgroundColor": {
"type": "string",
"default": null,
"description": "Background color, valid values are RBG in format 0,0,0 to 255,255,255 or format #000000 to #FFFFFF."
}
}
```
!!!note
You will need to reinstall the agent for agent customizations to take effect.
### Terms of use
You can change the terms of use of the web site by adding a “terms.txt” file in the “meshcentral-data” folder. The file can include HTML markup. Once set, the server does not need to be restarted, the updated terms.txt file will get used the next time its requested.