mirror of
https://github.com/Ylianst/MeshCentral.git
synced 2025-11-06 20:33:03 -05:00
fix(docs): update links to ODT files and change image formats from PNG to JPG and other misc fixes (#7401)
This commit is contained in:
silversword411
GitHub
@@ -430,4 +430,4 @@ MeshCentral and this document are both opens source and licensed using Apache 2.
|
||||
|
||||
[MeshCentral Guide](https://meshcentral.com/docs/MeshCentral2UserGuide.pdf)
|
||||
|
||||
MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral User's Guide v0.2.9.odt?raw=true)
|
||||
MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCmdUserGuide.pdf) [as .odt](../documents/MeshCentral%20Design%20&%20Architecture%20v0.0.4.odt)
|
||||
@@ -19,7 +19,7 @@ For more information, [visit MeshCentral.com](https://meshcentral.com).
|
||||
|
||||
The [User's Guide](meshcentral/index.md) contains information every administrator should know including usage, the server configuration file, databases, TLS offloading, Lets Encrypt, IP Filtering, Email setup, embedding, server port aliasing, reverse proxy setup, multi factor authentication, branding & terms of use, HashiCorp Vault support, and SSO.
|
||||
|
||||
The [Installation Guide](install/install.md) has detailed instructions for installing the MeshCentral Server on Windows 8.1, Windows 10, Windows 2012 R2, Amazon Linux 2, Raspberry Pi, Microsoft Azure, Google Cloud, Ubuntu 18, Ubuntu 16 and OpenBSD.
|
||||
The [Installation Guide](install/quickstart.md) has detailed instructions for installing the MeshCentral Server on Windows 8.1, Windows 10, Windows 2012 R2, Amazon Linux 2, Raspberry Pi, Microsoft Azure, Google Cloud, Ubuntu 18, Ubuntu 16 and OpenBSD.
|
||||
|
||||
The [Design and Architecture Guide](design/index.md) is a short document that includes information on the design overview, dependencies, source code descriptions of each file, certificates, TLS security, the agent to server handshake, browser to agent relay and WebRTC and the messenger service.
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Quickstart
|
||||
|
||||
## 🚀 Quick Start Guide: Basic NPM Installation
|
||||
|
||||
MeshCentral is platform-agnostic, running almost anywhere thanks to being primarily written in JavaScript. This guide covers the simplest way to get started using **NPM**.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Secure
|
||||
|
||||
## 🔒 Increased Security Installation on Debian/Ubuntu
|
||||
|
||||
For enhanced security on Debian-based Linux distributions (like Ubuntu), it's best practice to run **MeshCentral** under a dedicated, low-privilege user account. This prevents the server from making unauthorized changes to the system.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# Quickstart
|
||||
|
||||
## 🪟 Quick Start on Windows with the Installer
|
||||
|
||||
For Microsoft Windows users, the easiest way to install MeshCentral is by using the dedicated installer tool. This tool automates the setup, including checking for and installing **Node.js** if necessary.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Intel AMT
|
||||
|
||||
|
||||
Intel AMT Guide [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral Intel AMT Guide v0.0.1.odt?raw=true)
|
||||
Intel AMT Guide [as .odt](../documents/MeshCentral%20Intel%20AMT%20Guide%20v0.0.1.odt)
|
||||
|
||||
## Video Walkthru
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## Agent Invitation
|
||||
Click on the 'Invite' button next to the device group name to access it.
|
||||
@@ -23,7 +23,7 @@ For link invitation web page customization:
|
||||
2. Create a `views` folder in it and copy the file `node_modules/meshcentral/views/invite.handlebars` into it.
|
||||
3. That copy will be served instead of the default one, so you can customize it as you want.
|
||||
|
||||
|
||||
|
||||
|
||||
### Email Invitation
|
||||
This option will show up if you have an SMTP email server set up with MeshCentral.
|
||||
@@ -34,10 +34,10 @@ For invitation email customization:
|
||||
2. Create an `emails` folder in it and copy the files `node_modules/meshcentral/emails/mesh-invite.txt` and `node_modules/meshcentral/emails/mesh-invite.html` into it.
|
||||
3. These copies will be used instead of the default ones, so you can customize them as you want.
|
||||
|
||||
|
||||
|
||||
|
||||
## Email notification
|
||||
|
||||
You can also get an email notification when someone clicks the "Request Help" button in the Assistant agent.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -37,6 +37,6 @@ Some options you can find relate to:
|
||||
|
||||
and more!
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ Whitelabeling your MeshCentral installation to personalize it to your company's
|
||||
|
||||
You can put your own logo on the top of the web page. To get started, get the file “logoback.png” from the folder “node_modules/meshcentral/public/images” and copy it to your “meshcentral-data” folder. In this example, we will change the name of the file “logoback.png” to “title-mycompany.png”. Then use any image editor to change the image and place your logo.
|
||||
|
||||
|
||||
|
||||
|
||||
Once done, edit the config.json file and set one or all of the following values:
|
||||
|
||||
@@ -35,19 +35,19 @@ Once done, edit the config.json file and set one or all of the following values:
|
||||
|
||||
This will set the title and sub-title text to empty and set the background image to the new title picture file. You can now restart the server and take a look at the web page. Both the desktop and mobile sites will change.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The title image must a PNG image of size 450 x 66.
|
||||
|
||||
You can also customize the server icon in the “My Server” tab. By default, it’s a picture of a desktop with a padlock.
|
||||
|
||||
|
||||
|
||||
|
||||
If, for example, MeshCentral is running on a Raspberry Pi. You may want to put a different picture at this location. Just put a “server.jpg” file that is 200 x 200 pixels in the “meshcentral-data” folder. The time MeshCentral page is loaded, you will see the new image.
|
||||
|
||||
|
||||
|
||||
|
||||
This is great to personalize the look of the server within the web site.
|
||||
|
||||
@@ -57,7 +57,7 @@ MeshCentral lets you change the icons for different devices shown in the Web Use
|
||||
To update device icons, you need to edit these files: `meshcentral-web/public/images/webp/iconsXX.webp` (`icons16.webp`, `icons32.webp`, `icons50.webp`, `icons100.webp`), and `meshcentral-web/public/images/iconsXX.png` (`icons16.png`, `icons32.png`, `icons50.png`, `icons64.png`, `icons100.png`) and the corresponding `meshcentral-web/public/images/icons256-X-1.png`. Make sure to keep the resolution of these files as it is.
|
||||
|
||||
By following these steps, you can customize any icon in MeshCentral. Just find and change the corresponding image files in the `meshcentral-web/public/images` folder. Similarly, you can also move other folders from `node_modules/meshcentral` to `meshcentral-web` while keeping the original folder structure. This allows you to modify other parts of MeshCentral too, like the `.handlebars` templates for the web interface. Simply copy files from `node_modules/meshcentral/views` to `meshcentral-web/views` and make your changes in `meshcentral-web`. This lets you match MeshCentral's look to your company's brand or your own style.
|
||||
|
||||
|
||||
|
||||
### Customizing Web Style
|
||||
MeshCentral gives you the flexibility to override some or all of the web interface. An easy way to modify the style is to do the following:
|
||||
@@ -99,7 +99,7 @@ You can customize the Agent to add your own logo, change the title bar, install
|
||||
!!!note
|
||||
The Customization must be done FIRST and BEFORE you deploy your agents! Once the agents have been deployed, any customization made afterwards, will not sync! This is because the setup files are customized on the fly, then when you install the agents, the exe and .msh file with the customizations in are copied over to the required folder, so you will need to reinstall the agent for agent customizations to take effect.
|
||||
|
||||
|
||||
|
||||
|
||||
```json
|
||||
"domains": {
|
||||
@@ -119,7 +119,7 @@ You can customize the Agent to add your own logo, change the title bar, install
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## Terms of use
|
||||
|
||||
|
||||
@@ -237,7 +237,7 @@ Of course, this is just for debugging.
|
||||
|
||||
<https://serverurl/meshagents> aka trying figure out what this is
|
||||
|
||||
|
||||
|
||||
|
||||
### Pull down cert .crt file from internet
|
||||
|
||||
@@ -372,12 +372,12 @@ Same idea, browser side instead of agent side.
|
||||
|
||||
To debug issues, confirm that Intel AMT is active and there MeshCentral is not showing any red errors on the "Intel AMT" line:
|
||||
|
||||
|
||||
|
||||
|
||||
Next, you can go in the "My Server / Trace" tab and enable tracing on the "Intel AMT Manager" like this:
|
||||
|
||||
|
||||
|
||||
|
||||
You can then open another tab and select to power off or power on Intel AMT, you should see "performPowerAction" with 2 or 8 depending on power on/off.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
|
||||
You can search your list of agents using any of these criteria using the filter box (also viewable in the tooltip of the Filter box):
|
||||
|
||||
```
|
||||
user:xxx or u:xxx
|
||||
ip:xxx
|
||||
group:xxx or g:xxx
|
||||
@@ -17,6 +18,7 @@ wsc:noav
|
||||
wsc:noupdate
|
||||
wsc:nofirewall
|
||||
wsc:any
|
||||
```
|
||||
|
||||
## General
|
||||
|
||||
@@ -50,7 +52,7 @@ Chat
|
||||
|
||||
### 7 Day Power State
|
||||
|
||||
|
||||
|
||||
|
||||
Legend
|
||||
|
||||
@@ -64,7 +66,7 @@ Legend
|
||||
|
||||
You can set alternate port in the link if it's not default by right-clicking.
|
||||
|
||||
|
||||
|
||||
|
||||
* Interfaces
|
||||
* Location
|
||||
@@ -92,13 +94,13 @@ Right-clicking on Connect button will give you additional options:
|
||||
* Ask Consent
|
||||
* Privacy Bar
|
||||
|
||||
|
||||
|
||||
|
||||
### RDP Connect Button
|
||||
|
||||
Right-clicking on RDP Connect button allows you to specify Alternate Port.
|
||||
|
||||
|
||||
|
||||
|
||||
### Intel AMT Connect Button
|
||||
|
||||
@@ -108,7 +110,7 @@ Uses Intel AMT to control video output of the hardware video card.
|
||||
|
||||
**Bottom left include:**
|
||||
|
||||
|
||||
|
||||
|
||||
* Sending special Keys
|
||||
|
||||
@@ -116,7 +118,7 @@ Uses Intel AMT to control video output of the hardware video card.
|
||||
|
||||
Actions
|
||||
|
||||
|
||||
|
||||
|
||||
* Wake Up
|
||||
* Run Commands
|
||||
@@ -127,7 +129,7 @@ Actions
|
||||
|
||||
Settings
|
||||
|
||||
|
||||
|
||||
|
||||
* Quality
|
||||
* Scaling
|
||||
@@ -138,7 +140,7 @@ Settings
|
||||
* Automatic Clipboard
|
||||
* Lock on Disconnect
|
||||
|
||||
|
||||
|
||||
|
||||
* Session recording indicator
|
||||
* Screen rotating
|
||||
@@ -147,7 +149,7 @@ Settings
|
||||
|
||||
Bottom right include:
|
||||
|
||||
|
||||
|
||||
|
||||
* Session Sharing with Guest
|
||||
* Toggling keyboard lockout on guest
|
||||
@@ -177,7 +179,7 @@ Right-clicking on Connect button allows you to:
|
||||
* User Powershell (Windows)
|
||||
* SSH (Linux)
|
||||
|
||||
|
||||
|
||||
|
||||
## Files
|
||||
|
||||
@@ -202,7 +204,7 @@ Agent information that includes:
|
||||
|
||||
Note you can show CPU and Memory usage info by clicking the icon in the top right corner
|
||||
|
||||
|
||||
|
||||
|
||||
## Intel AMT
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ No, you haven't.
|
||||
|
||||
3. You have the option enabled to submit unknown applications for analysis.
|
||||
|
||||
|
||||
|
||||
|
||||
4. They ran it against their virtualization testing cluster.
|
||||
|
||||
@@ -57,15 +57,15 @@ You have to manually grant Mac permissions outside of the agent install process
|
||||
|
||||
To see the screen (otherwise you just see the menu bar, and otherwise blank)
|
||||
|
||||
|
||||
|
||||
|
||||
To be able to transfer files
|
||||
|
||||
|
||||
|
||||
|
||||
To be able to control keyboard and mouse
|
||||
|
||||
|
||||
|
||||
|
||||
## I'm using CloudFlare and I'm getting a black screen but the mouse moves?
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ In this section we will cover the basics of MeshCentral in your newly setup serv
|
||||
### Launch
|
||||
|
||||
Start your web browser and access MeshCentral via IP address/URL, `http://serverFQDN/`. If MeshCentral is running locally, enter `http://127.0.0.1/`. MeshCentral will redirect the browser to HTTPS if the server was accessed with HTTP. Once on HTTPS you will likely see this message:
|
||||
|
||||
|
||||
|
||||
This is because by default MeshCentral is using a self-signed certificate that is not known to the browser as a “trusted” or “trustworthy” certificate. To prevent this warning from recurring, the following chapter will provide useful steps that can be considered.
|
||||
|
||||
@@ -89,7 +89,7 @@ Once logged in, create a new device group. This is a group of computers that we
|
||||
2. Key in a suitable “Name”, .e.g. “SampleGroup”
|
||||
3. Leave “Type” to default “Manage using a software agent” and click ‘OK”.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note
|
||||
There are two types of groups: <br>
|
||||
@@ -429,7 +429,7 @@ Click on the "OAuth Consent Screen" link, Under "APIs and Services" from the lef
|
||||
|
||||
If you have a Google Workspace account, you will have the option to choose "Internal" application and skip the next steps. If not, you will be required to provide Google with information about why you want access, as well as verifying domain ownership.
|
||||
|
||||
|
||||
|
||||
|
||||
Add the Gmail address under which you have created this project to the fields labelled ‘User support email’ and ‘Developer contact information’ so that you will be allowed for authentication. After that, you will want to add a scope for your app, so that your token is valid for gmail:
|
||||
|
||||
@@ -880,11 +880,11 @@ As illustrated above, we see the business site using the token key to generate a
|
||||
|
||||
There are multiple options available for user to explicitly choose the features that will be loaded from MeshCentral to the business website. The argument in the in the URL can dictate which web page should display and how. The three embedding URL arguments are Viewmode, Hide and Node.
|
||||
|
||||
| Embedding Options / URL Argument | Description | "Values<br><br>**Note**: For values 10 and above, a node identifier must be specified."
|
||||
| -------------------------------- | ----------- | ------------------------------------------------------------------------------------------ |
|
||||
| **viewmode** | "Indicates the information to show. <br>This is an integer value, possible values are:" | "1 = Devices tab<br><br>2 = Account tab<br><br>3 = Events tab<br><br>4 = Users tab (Site admins only)<br><br>5 = Server files tab<br><br>10 = Device general information<br><br>11 = Device remote desktop<br><br>12 = Device terminal<br><br>14 = Device Intel AMT console.<br><br>15 = Device Mesh Agent console |
|
||||
| **hide** | "Indicates which portion of the web page to hide. <br>This is a bitmask integer hence it will need the sum of values. <br>For .e.g.: To hide all of the values, add 1+2+4+8 and use 15 as the value. | 1 = Hide the page header<br><br>2 = Hide the page tab<br><br>4 = Hide the page footer<br><br>8 = Hide the page title<br><br>16 = Hide the left tool bar<br><br>32 = Hide back buttons |
|
||||
| **node** | Optional unless Viewmode is set to value of 10 or greater. <br>Indicates which node to show on the screen,<br><br>For example, if we want to embed the remote desktop <br>page for a given node and hide the header, tabs, <br>footer and page title, we could have this URL: <br>https://localhost/?node=UkSNlz7t...2Sve6Srl6FltDd&viewmode=11&hide=15" | Node or NodeID is a long base64 encoded SHA384 value |
|
||||
| Embedding Options / URL Argument | Description | Values |
|
||||
| -------------------------------- | ----------- | ------ |
|
||||
| **viewmode** | Indicates the information to show. This is an integer value, possible values are: | 1 = Devices tab<br>2 = Account tab<br>3 = Events Live<br>4 = Users General<br>5 = Server files tab<br>6 = Server General<br>10 = Device general information<br>11 = Device remote desktop<br>12 = Device terminal<br>13 = Device files<br>14 = Device Intel AMT console<br>15 = Device Mesh Agent console<br>16 = Device events<br>17 = Device info<br>19 = Device plugins<br>20 = Mesh General<br>21 = Mesh Summary<br>30 = User General<br>31 = User Events<br>40 = Server Stats<br>41 = Server Trace<br>42 = Server Plugins<br>50 = Users Groups<br>52 = Users Recordings<br>60 = Events Report<br>115 = Server Console<br><br>**Note**: For values 10-19, a node identifier must be specified. For values 20-29, a mesh identifier must be specified. For values 30-39, a user identifier must be specified. For values 50-59, a user group identifier may be required. |
|
||||
| **hide** | Indicates which portion of the web page to hide. This is a bitmask integer hence it will need the sum of values. For example: To hide all of the values, add 1+2+4+8 and use 15 as the value. | 1 = Hide the page header<br>2 = Hide the page tab<br>4 = Hide the page footer<br>8 = Hide the page title<br>16 = Hide the left tool bar<br>32 = Hide back buttons |
|
||||
| **node** | Optional unless Viewmode is set to value of 10-19. Indicates which node to show on the screen. For example, if we want to embed the remote desktop page for a given node and hide the header, tabs, footer and page title, we could have this URL: `https://localhost/?node=UkSNlz7t...2Sve6Srl6FltDd&viewmode=11&hide=15` | Node or NodeID is a long base64 encoded SHA384 value |
|
||||
|
||||
---
|
||||
|
||||
@@ -1621,7 +1621,7 @@ Before you get started, your MeshCentral server must be publicly facing on the i
|
||||
|
||||
You can integrate LDAP using [these](https://github.com/Ylianst/MeshCentral/blob/f05eb9a198bed249c2b1a969ce17a41404ef70a6/meshcentral-config-schema.json#L505-L513) configuration options
|
||||
|
||||
|
||||
|
||||
|
||||
### Twitter Authentication
|
||||
|
||||
@@ -1804,7 +1804,7 @@ Once setup, you will need to allow one or more users to use the new application.
|
||||
|
||||
We are now almost done with JumpCloud. The last thing we need to do is download the certificate that JumpCloud will be using to sign the SAML assertions. You can get this certificate by going in the `Applications` tab, click on your new application and select `Download Certificate` as shown here.
|
||||
|
||||
|
||||
|
||||
|
||||
Save the certificate as `jumpcloud-saml.pem` and place it in the `meshcentral-data` folder. You are now ready to configure MeshCentral.
|
||||
|
||||
@@ -2084,4 +2084,4 @@ MeshCentral has built-in web-based integration of SSH in the "Terminal" tab and
|
||||
|
||||
[MeshCentral Guide](https://meshcentral.com/docs/MeshCentral2UserGuide.pdf)
|
||||
|
||||
MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCmdUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral User's Guide v0.2.9.odt?raw=true)
|
||||
MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCmdUserGuide.pdf) [as .odt](../documents/MeshCentral%20User's%20Guide%20v0.2.9.odt)
|
||||
@@ -16,7 +16,7 @@ Adjust these items in your `config.json`
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## Disabling TLS 1.0/1.1 for AMT
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ While this is a huge step up, it's not perfect. If you notice, there are some in
|
||||
|
||||
Hopefully this will help verify your config is syntactically correct and prevent needless formatting errors, misspellings, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
## Downloading Folders
|
||||
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## User Tokens
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Software Integration Tokens
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Access the official MeshCmd user guide in your preferred format
|
||||
|
||||
> - [📄 PDF version](https://meshcentral.com/docs/MeshCmdUserGuide.pdf)
|
||||
> - [📝 ODT version](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCmd%20User%27s%20Guide%20v0.0.3.odt?raw=true)
|
||||
> - [📝 ODT version](../documents/MeshCmd%20User's%20Guide%20v0.0.3.odt)
|
||||
---
|
||||
|
||||
## 🎬 Video Walkthru
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# MeshCtrl
|
||||
|
||||
MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCtrlUsersGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCtrl User's Guide v0.0.1.odt?raw=true)
|
||||
MeshCmd Guide [as .pdf](https://meshcentral.com/docs/MeshCtrlUsersGuide.pdf) [as .odt](../documents/MeshCtrl%20User's%20Guide%20v0.0.1.odt)
|
||||
|
||||
## Video Walkthru
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
|
||||
|
||||
MeshCentral Router Guide [as .pdf](https://meshcentral.com/docs/MeshCentral2RouterUserGuide.pdf) [as .odt](https://github.com/Ylianst/MeshCentral/blob/master/docs/MeshCentral%20Router%20User%20Guide%20v0.0.2.odt?raw=true)
|
||||
MeshCentral Router Guide [as .pdf](https://meshcentral.com/docs/MeshCentral2RouterUserGuide.pdf) [as .odt](../documents/MeshCentral%20Router%20User%20Guide%20v0.0.2.odt)
|
||||
|
||||
## Video Walkthru
|
||||
|
||||
|
||||
Reference in New Issue
Block a user