Ylianst/MeshCentral
1
0
Fork 0
mirror of https://github.com/Ylianst/MeshCentral.git synced 2024-11-26 07:57:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Various grammar, spelling, and clarity issues. (#5964)

Browse Source 
* Update plugins.md

* Update faq.md

* Update debugging.md

* Update customization.md

* Update codesigning.md

* Update assistant.md
This commit is contained in:
buckybytes 2024-03-27 06:26:38 -05:00 committed by GitHub
parent 81e98033fc
commit 862e2ee80b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/meshcentral/assistant.md
View File

@ -26,7 +26,7 @@ For link invitation web page customization:
![agent invite code](images/assistant_invitation_link.png)
### Email Invitation
This option will show up if you have a SMTP email server setup with MeshCentral.
This option will show up if you have an SMTP email server set up with MeshCentral.
For invitation email customization:

2
docs/docs/meshcentral/codesigning.md
View File

@ -73,7 +73,7 @@ When doing sign/unsign, you can also change resource properties of the generated
## Automatic Agent Code Signing
If you want to self-sign the mesh agent so you can whitelist the software in your AV, and lock it to your server and organization.
If you want to self-sign the mesh agent so you can whitelist the software in your AV, as well as lock it to your server and organization:
<div class="video-wrapper">
<iframe width="320" height="180" src="https://www.youtube.com/embed/qMAestNgCwc" frameborder="0" allowfullscreen></iframe>

6
docs/docs/meshcentral/customization.md
View File

@ -1,6 +1,6 @@
# Customization
Whitelabeling your MeshCentral installation to personalize it to your companies brand, as well as having your own terms of use is one of the first things many people do after installation.
Whitelabeling your MeshCentral installation to personalize it to your company's brand, as well as having your own terms of use is one of the first things many people do after installation.
<div class="video-wrapper">
<iframe width="320" height="180" src="https://www.youtube.com/embed/xUZ1w9RSKpQ" frameborder="0" allowfullscreen></iframe>
@ -8,7 +8,7 @@ Whitelabeling your MeshCentral installation to personalize it to your companies
## Web Branding
You can put you 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.
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.
![](images/2022-05-19-00-38-51.png)
@ -33,7 +33,7 @@ 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 serve and take a look at the web page. Both the desktop and mobile sites will change.
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.
![](images/2022-05-19-00-39-35.png)

10
docs/docs/meshcentral/debugging.md
View File

@ -23,7 +23,7 @@ Make sure you understand how MeshCentral works with your browser using chrome de
### Understanding node and paths
Note that when running MeshCentral, you should always run like from the path that is parent to node_modules, so you do this:
Note that when running MeshCentral, you should always run from the path that is parent to node_modules, so you do this:
```
cd C:\Program Files\Open Source\MeshCentral
@ -39,7 +39,7 @@ node meshcentral
The problem with the second command is that NPM may install missing modules in the incorrect location.
Also, in general I recommend not using the MeshCentral MSI Installer and just install manually unless you are very much scared of the command prompt. Anyone that knows about bit about the shell should install MeshCentral like this:
Also, in general I recommend not using the MeshCentral MSI Installer and just install manually unless you are very scared of the command prompt. Anyone that knows a bit about the shell should install MeshCentral like this:
```
mkdir c:\meshcentral
@ -50,11 +50,11 @@ node node_modules\meshcentral
node node_modules\meshcentral --install
```
This way, just have a lot more control over what is going on. Just my opinion, the MSI installer basically does the same thing and installs NodeJS for you.
This way, you have a lot more control over what is going on. In my opinion, the MSI installer basically does the same thing and installs NodeJS for you.
### Unable to update server
Generally the problem is that MeshCentral can't find the npm tool and so, can't run it to see if there is a new version. You can fix this by setting the path to npm in the config.json like this:
Generally the problem is that MeshCentral can't find the npm tool and therefore, can't run it to see if there is a new version. You can fix this by setting the path to npm in the config.json like this:
```json
{
@ -86,7 +86,7 @@ node node_modules/meshcentral --stop
### Port Troubleshooting on server
If you're getting a `port 4433 is not available` error, this is because someone else is using this port, very likely another instance of MeshCentral. If your MeshCentral server is bound to ports 81/444 MeshCentral could not get port 80/443 and got the next available ones.
If you're getting a `port 4433 is not available` error, this is because another process is using this port, very likely another instance of MeshCentral. If your MeshCentral server is bound to ports 81/444 MeshCentral could not get port 80/443 and got the next available ones.
In general the problem is that you are running two MeshCentral instances at the same time. Probably one as a background Windows Service and one in the command line. Which ever instance can grab port 4433 will have a running MPS and CIRA should work, but the second instance will not have port 4433 and CIRA will not work.

12
docs/docs/meshcentral/faq.md
View File

@ -67,17 +67,17 @@ To be able to control keyboard and mouse
![](images/2023-11-29-12-58-36.png)
## I'm using cloudflare and I'm getting a black screen but the mouse moves?
## I'm using CloudFlare and I'm getting a black screen but the mouse moves?
If you are using cloudflare for your DNS hosting and your remote screen is black, DONT PANIC!
If you are using CloudFlare for your DNS hosting and your remote screen is black, DONT PANIC!
Unfortunately, MeshCentral currently doesnt work with CloudFlares Proxy DNS Mode, so the remote agent devices have to connect directly to your MeshCentral Server instead of being proxied!
Unfortunately, MeshCentral doesn't always work with CloudFlare's Proxy DNS Mode.
The fix is to simply disable the 'Proxy Status' to OFF inside your DNS A Record.
The fix is to simply set the 'Proxy Status' to OFF inside your DNS A Record, within the CloudFlare control panel.
Simple follow the steps [here](https://developers.cloudflare.com/fundamentals/setup/manage-domains/pause-cloudflare/#disable-proxy-on-dns-records)
Simply follow the steps [here](https://developers.cloudflare.com/fundamentals/setup/manage-domains/pause-cloudflare/#disable-proxy-on-dns-records)
Once done, open your firewall for the `port` and `agentPort` ports of where your meshcentral is hosted, then restart your MeshCentral Server
The is currently a PINNED GitHub issue about this [here](https://github.com/Ylianst/MeshCentral/issues/5302)
There is currently a PINNED GitHub issue about this [here](https://github.com/Ylianst/MeshCentral/issues/5302)

12
docs/docs/meshcentral/plugins.md
View File

@ -5,7 +5,7 @@
## Use Cases
Certain feature requests may not be suitable for all MeshCentral users and thus are available as a plugin. Furthermore users can develop their own plugins - as described further below - to extend functionality or benefit from integrating the powerful MeshCentral into their existing application environment much better.
Certain feature requests may not be suitable for all MeshCentral users and thus are available as a plugin. Furthermore users can develop their own plugins - as described further below - to extend functionality or benefit from integrating MeshCentral into their existing application environment.
## List of publically available plugins
@ -17,10 +17,10 @@ Certain feature requests may not be suitable for all MeshCentral users and thus
>"plugins": {
> "enabled": true
>},
2. Restart MeshCentral in case you just enabled plugins in the configuration.
2. Restart MeshCentral if you needed to change the configuration.
2. Log into MeshCentral as full administrator.
3. Go my `My Server` -> `Plugins`, hit the Download plugin button.
4. A dialog opens requesting an URL, e.g. put in: <https://github.com/ryanblenis/MeshCentral-ScriptTask>
3. Go my `My Server` -> `Plugins`, then hit the Download plugin button.
4. A dialog opens requesting a URL, e.g. put in: <https://github.com/ryanblenis/MeshCentral-ScriptTask>
5. The plugin pops up in the plugin list below the download button, you can now configure and enable/disable it.
# Plugins - Development & Hooks
@ -30,7 +30,7 @@ Certain feature requests may not be suitable for all MeshCentral users and thus
## Overview
Not all feature requests may be suitable for all MeshCentral users and thus can't be integrated into MeshCentral directly. Hwoever, Instead of maintaining a complete fork of MeshCentral it is so much easier to benefit from and extend MeshCentral's functionality by using hooks and writing plugins for it.
Not all feature requests may be suitable for all MeshCentral users and thus can't be integrated into MeshCentral directly. Hwoever, Instead of maintaining a complete fork of MeshCentral it is much easier to extend MeshCentral's functionality using hooks and writing plugins for it.
## Anatomy of a plugin:
@ -78,7 +78,7 @@ A valid JSON object within a file named `config.json` in the root folder of your
| configUrl | Yes | string | the URL to the config.json of the project |
| downloadUrl | Yes | string | the URL to a ZIP of the project (used for installation/upgrades) |
| repository | Yes | JSON object | contains the following attributes |
| repository.type | Yes | string | valid values are `git` and in the future, `npm` will also be supported in the future |
| repository.type | Yes | string | valid values are `git` and in the future, `npm` will also be supported. |
| repository.url | Yes | string | the URL to the project's repository |
| versionHistoryUrl | No | string | the URL to the project's versions/tags |
| meshCentralCompat | Yes | string | the minimum version string of required compatibility with the MeshCentral server, can be formatted as "0.1.2-c" or ">=0.1.2-c". Currently only supports minimum version, not full semantic checking. |