Skip to content
This is a full computer management web site. With MeshCentral, you can run your own web server and it to remotely manage and control computers on a local network or anywhere on the internet. Once you get the server started, will create a mesh (a group of computers) and then download and install a mesh agent on each computer you want to manage. A…
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
agents Meshcore merge. Jun 14, 2019
amt Minor MeshCommander fix Apr 26, 2019
public Server fixes and webapp trace support. Jun 18, 2019
views Server fixes and webapp trace support. Jun 18, 2019
.gitignore Removed package-lock.json Jun 6, 2019
CreateSourcePackage.bat Initial main commit Aug 28, 2017
LICENSE Changed copyrights headers for 2019. Jan 4, 2019
MeshCentral.sln Initial main commit Aug 28, 2017
MeshCentralServer.njsproj Make MeshAgent and MeshCore update. Jun 14, 2019
SourceFileList.txt Improved MeshAgent and MeshCmd. Jan 26, 2018
Webauthn.js Fixed dependencies. May 17, 2019
amt-ider.js First server with working hard-coded server-side IDER support. Apr 24, 2019
amtevents.js Changed copyrights headers for 2019. Jan 4, 2019
amtscanner.js Added MongoDB change stream support. May 29, 2019
amtscript.js Changed copyrights headers for 2019. Jan 4, 2019
certoperations.js Started work on Intel AMT ACM activation. Jun 13, 2019
common.js Can now batch add users to a device group. May 30, 2019
db.js Server fixes, added locale arg in web app. Jun 11, 2019
exeHandler.js Changed copyrights headers for 2019. Jan 4, 2019
interceptor.js Changed copyrights headers for 2019. Jan 4, 2019
letsEncrypt.js Added support for wildcard Let's Encrypt certs. Jun 7, 2019
meshaccelerator.js Minor security fixes. Jan 5, 2019
meshagent.js Server fixes when agent comes in with unknown agentid. Jun 17, 2019
meshcentral.js Server fixes and webapp trace support. Jun 18, 2019
meshmail.js More work on Intel AMT ACM activation. Jun 13, 2019
meshrelay.js Added half relay timeout, terms page fix. May 13, 2019
meshscanner.js Server improvements, first Intel AMT CCM activation. Mar 5, 2019
meshuser.js Removed dup agent count on server stats page. Jun 14, 2019
mpsserver.js Added support fo domain MaxDevices limit Jun 5, 2019
multiserver.js Minor security fixes. Jan 5, 2019
package.json Server fixes when agent comes in with unknown agentid. Jun 17, 2019
pass.js Added batch account addition. May 14, 2019
readme.txt Spelling and Grammar May 12, 2019
redirserver.js Fixed content-disposition headers. Apr 30, 2019
reinstall-modules.bat Module dependency cleanup. Mar 25, 2019
sample-config.json Server fixes. Jun 17, 2019
swarmserver.js Fixed SSPI session release bug. Mar 12, 2019
webserver.js Server fixes and webapp trace support. Jun 18, 2019
winservice.js Changed copyrights headers for 2019. Jan 4, 2019

readme.txt

MeshCentral
===========

For more information, [visit MeshCommander.com/MeshCentral2](http://www.meshcommander.com/meshcentral2).

Download the [full PDF user's guide](http://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2UserGuide.pdf) with more information on configuring and running MeshCentral2. In addition, the (installation guide)[http://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2InstallGuide.pdf] can help get MeshCentral installed on Amazon AWS, Microsoft Azure, Ubuntu or Raspberry Pi.

This is a full computer management web site. With MeshCentral, you can run your own web server to remotely manage and control computers on a local network or anywhere on the internet. Once you get the server started, create a mesh (a group of computers) and then download and install a mesh agent on each computer you want to manage. A minute later, the new computer will show up on the web site and you can take control of it. MeshCentral includes full web-based remote desktop, terminal and file management capability.

To test this server, feel free to try [MeshCentral.com](http://meshcentral.com).


Installation
------------

Make sure you have NodeJS and npm installed. If you are behind a proxy, setup npm to use the proxy:

```
	npm config set proxy http://proxy.com:88
	npm config set https-proxy http://proxy.com:88
```

Then, install MeshCentral by creating an empty folder and using npm to download the module:

```
	mkdir meshcentral
	cd meshcentral
	npm install meshcentral
```

To run MeshCentral you may need to use "nodejs" instead of "node" on Linux.

```
	cd ./node_modules/meshcentral
	node meshcentral [arguments]
```

You can launch MeshCentral with no arguments to start it in LAN mode. In LAN mode only devices on the local network can be managed. To setup a more secure server, use --cert to specify an IP address or name that resolves to your server. This name will be used by mesh agents to connect back to the server. So, make sure you set **a name that will resolve back to your server**. MeshCentral will not register this name for you. You must make sure to setup the DNS name yourself first, or use the right IP address. If you are just taking a quick look at MeshCentral, you can skip this step and do it at later time.

```
	node meshcentral --cert servername.domain.com
	node meshcentral --cert 1.2.3.4
```

On Windows, you can install MeshCentral to run as a background service, just run it using "--install". Once running, open a browser and enter the server url. By default, a TLS self-signed certificate is created so you will need to ignore the security warning given by your browser. A link to the root certificate that can be loaded into your browser is provided on the website so you can make the warnings go away. You can run without TLS security using --notls, but this is not recommended.


Update and uninstall
--------------------

Uninstalling MeshCentral is super easy, just use npm as usual. For updating, just install over the previous version by installing again, data files will not be changed. From the parent folder of node_module, enter ether:

```
	npm install meshcentral
	npm uninstall meshcentral
```

Command Line
------------

Command line arguments on Windows only:

| Arguments                             | Description
| ------------------------------------- | -----------
| --install				| Install MeshCentral as a background service.
| --uninstall				| Uninstall MeshCentral background service.
| --start				| Start MeshCentral as a background service.
| --stop				| Stop MeshCentral background service.


Command line arguments on any platform:

| Arguments                             | Description
| ------------------------------------- | -----------
| --notls 				| Use HTTP instead of HTTPS for the main web server.
| --user [username] 			| Always login as [username] if the account exists.
| --port [number] 			| Web server port number (default to 443).
| --mpsport [number] 			| Intel AMT server port number (default to 4433).
| --redirport [number] 			| Redirection web server, redirects users to the HTTPS server (default to 80).
| --exactports 				| Server must run with correct ports or exit.
| --cert [name], (country), (org) 	| Create a web server certificate with a server name. Country and organization can optionaly be set.


Configuration File
------------------

As an alternative to using command line arguments, you can create a ./node-module/meshcentral-data/config.json file, for example:

```json
	{
		"settings": {
			"port": 8080,
			"redirport": 81
		},
		"domains": {
			"": {
				"title": "MyServer",
				"title2": "Servername",
				"userQuota": 1048576,
				"meshQuota": 248576,
				"newAccounts" : 1
			},
			"Customer1": {
				"title": "Customer1",
				"title2": "Extra String",
				"newAccounts" : 0
			},
			"Customer2": {
				"title": "Customer2",
				"title2": "Other String"
			}
		},
		"peers": {
			"serverId" : "Server1",
			"servers": {
				"Server1": { "url": "wss://192.168.1.100:443/" },
				"Server2": { "url": "wss://192.168.1.101:443/" }
			}
		}
	}
```

The "settings" part are for command line arguments. For example, instead of running with "--port 8080", you can put "port: 8080" in the settings portion of the config.json file. In addition, you can use the config.json file to create multi-tenancy servers. In the domains section, you can set options for the default domain ("") in addition to creating new domains.

For the configuration above, the root domain and two other domains will be accessible like this:

```
	https://servername:8080/
	https://servername:8080/customer1
	https://servername:8080/customer2
```

When you setup many domains, the server considers each domain separately. Each domain has separate user accounts, administrators, etc. Within each domain, you can put a "title" and "title2" as strings that will show up at the top of the web site. "userQuota" indicates the default maximum amount of data a user can have in it's "My Files" folder. "meshQuota" is the maximum total size of files in each mesh folder. "newAccounts" indicates if new accounts can be created from the login page, 0 if not allowed, 1 if allowed. Note that if a web site has no accounts, the new account option will be available until an account is created and the first account will be the site administrator.

MeshCentral also supports server peering, add the "peers" section with a list of all peers. If you want to do server peering, make sure all servers are configured to use the same database. Also, the "serverId" value is optional. If it's not specified, the computer hostname is used instead.

Other Notes
-----------

For Windows users, if you install MeshCentral globally using "npm install meshcentral -g", it will not be able to run correctly as a Windows Service. It will immediately stop each time you start it.

For more information on MeshCentral or other tools, visit [MeshCommander.com](http://meshcommander.com).


Tutorials
---------

How to install MeshCentral2 in a few minutes.

[![MeshCentral2 - Installation](https://img.youtube.com/vi/LSiWuu71k_U/mqdefault.jpg)](https://www.youtube.com/watch?v=LSiWuu71k_U)


Demonstration of MeshCentral2 usages and more tips & tricks.

[![MeshCentral2 - Usages](https://img.youtube.com/vi/1E3NqGJzYds/mqdefault.jpg)](https://www.youtube.com/watch?v=1E3NqGJzYds)


How to setup Intel® AMT client initiated remote access (CIRA) to connect to MeshCentral2.

[![MeshCentral2 - Intel AMT CIRA](https://img.youtube.com/vi/rA2KHa2jkO0/mqdefault.jpg)](https://www.youtube.com/watch?v=rA2KHa2jkO0)


License
-------

This software is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
You can’t perform that action at this time.