Update readme.md
Added Table of Contents, Added Feedback section, updated video tutorials, removed installation instructions (redundant, it exists in the Install guide), added Social section, separated sections
Darryl H committed
Aug 5, 2020 at 16:17 UTC
b2219f5647840725bc06bdd8bb5a5ceb30a8429b
1 file changed
+51
-131
readme.md
+51
-131
@@ -1,153 +1,73 @@
1
-MeshCentral
2
-===========
3
-
4
-For more information, [visit MeshCommander.com/MeshCentral2](https://www.meshcommander.com/meshcentral2).
5
-Discussion forum on [Reddit](https://www.reddit.com/r/MeshCentral/).
6
-
7
-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.
8
-
9
-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 device group and download and install an 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.
10
-
11
-To test this server, feel free to try [MeshCentral.com](http://meshcentral.com).
12
-
13
-
14
-Installation
15
-------------
16
-
17
-Make sure you have NodeJS and npm installed. If you are behind a proxy, setup npm to use the proxy:
18
-
19
-```
20
- npm config set proxy http://proxy.com:88
21
- npm config set https-proxy http://proxy.com:88
22
-```
23
-
24
-Then, install MeshCentral by creating an empty folder and using npm to download the module:
25
-
26
-```
27
- mkdir meshcentral
28
- cd meshcentral
29
- npm install meshcentral
30
-```
31
-
32
-To run MeshCentral you may need to use `nodejs` instead of `node` on Linux.
33
-
34
-```
35
- cd ./node_modules/meshcentral
36
- node meshcentral [arguments]
37
-```
38
-
39
-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 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.
40
-
41
-```
42
- node meshcentral --cert servername.domain.com
43
- node meshcentral --cert 1.2.3.4
44
-```
45
-
46
-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.
1
+# MeshCentral
2
3
+## Table of Contents
4
49
-Update and uninstall
50
---------------------
5
+[About](#about)
6
+[Social Media](#social-media)
7
+[Documentation](#documentation)
8
+[Video Tutorials](#video-tutorials)
9
+[Feedback](#feedback)
10
+[License](#license)
11
+## About
12
52
-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:
13
+MeshCentral 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 device group and download and install an 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.
14
54
-```
55
- npm install meshcentral
56
- npm uninstall meshcentral
57
-```
15
+To try out this software, please go to [MeshCentral.com](http://meshcentral.com).
16
+**NOTE:** Be mindful of adding your own MeshCentral agent machines to this server as it will be publically available!
17
59
-Command Line
60
-------------
61
-
62
-Command line arguments on Windows only:
63
-
64
-| Arguments | Description
65
-| ------------------------------------- | -----------
66
-| --install | Install MeshCentral as a background service.
67
-| --uninstall | Uninstall MeshCentral background service.
68
-| --start | Start MeshCentral as a background service.
69
-| --stop | Stop MeshCentral background service.
70
-
71
-
72
-Command line arguments on any platform:
73
-
74
-| Arguments | Description
75
-| ------------------------------------- | -----------
76
-| --notls | Use HTTP instead of HTTPS for the main web server.
77
-| --user [username] | Always login as [username] if the account exists.
78
-| --port [number] | Web server port number (default is 443).
79
-| --mpsport [number] | Intel AMT server port number (default is 4433).
80
-| --redirport [number] | Redirection web server, redirects users to the HTTPS server (default to 80).
81
-| --exactports | Server must run with correct ports or exit.
82
-| --cert [name], (country), (org) | Create a web server certificate with a server name. Country and organization can optionaly be set.
83
-
84
-
85
-Configuration File
86
-------------------
87
-
88
-As an alternative to using command line arguments, you can create a `./node-module/meshcentral-data/config.json` file, for example:
18
+For more information, [visit MeshCommander.com/MeshCentral2](https://www.meshcommander.com/meshcentral2).
19
90
-```json
91
- {
92
- "settings": {
93
- "port": 8080,
94
- "redirport": 81
95
- },
96
- "domains": {
97
- "": {
98
- "title": "MyServer",
99
- "title2": "Servername",
100
- "userQuota": 1048576,
101
- "meshQuota": 248576,
102
- "newAccounts" : 1
103
- },
104
- "Customer1": {
105
- "title": "Customer1",
106
- "title2": "Extra String",
107
- "newAccounts" : 0
108
- },
109
- "Customer2": {
110
- "title": "Customer2",
111
- "title2": "Other String"
112
- }
113
- }
114
- }
115
-```
20
+## Social Media
21
+[Reddit](https://www.reddit.com/r/MeshCentral/)
22
+[Twitter](https://twitter.com/MeshCentral)
23
+[BlogSpot](https://meshcentral2.blogspot.com/)
24
117
-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.
25
+## Documentation
26
+The [User's Guide](http://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2UserGuide.pdf) contains information every adminstrator 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.
27
119
-For the configuration above, the root domain and two other domains will be accessible like this:
28
+The [Installation Guide](http://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2InstallGuide.pdf) 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.
29
121
-```
122
- https://servername:8080/
123
- https://servername:8080/customer1
124
- https://servername:8080/customer2
125
-```
30
+The [Design and Architecture Guide](http://info.meshcentral.com/downloads/MeshCentral2/MeshCentral2DesignArchitecture.pdf) 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.
31
127
-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.
32
+## Video Tutorials
33
+How to install MeshCentral2 in Microsoft Windows
34
+[](https://www.youtube.com/watch?v=LSiWuu71k_U)
35
129
-Other Notes
130
------------
36
+Demonstration of MeshCentral2 usages and more tips & tricks
37
+[](https://www.youtube.com/watch?v=1E3NqGJzYds)
38
132
-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.
39
+How to setup Intel® AMT client initiated remote access (CIRA) to connect to MeshCentral2
40
+[](https://www.youtube.com/watch?v=rA2KHa2jkO0)
41
134
-For more information on MeshCentral or other tools, visit [MeshCommander.com](http://meshcommander.com).
42
+Explaining the MeshAgent
43
+[](https://youtu.be/oJi0zydaeH0)
44
45
+Microsoft ClickOnce Demonstration
46
+[](https://youtu.be/--RCkWqJ-gI)
47
137
-Tutorials
138
----------
48
+MeshCmd Router Demonstration
49
+[](https://youtu.be/S38mg_BPe-M)
50
140
-How to install MeshCentral2 in a few minutes.
141
-[](https://www.youtube.com/watch?v=LSiWuu71k_U)
51
+MeshCentral2 with NGINX
52
+[](https://youtu.be/ebDVAsistbk)
53
143
-Demonstration of MeshCentral2 usages and more tips & tricks.
144
-[](https://www.youtube.com/watch?v=1E3NqGJzYds)
54
+MeshCommander Demonstration
55
+[](https://youtu.be/nsqF1uOCJx4)
56
146
-How to setup Intel® AMT client initiated remote access (CIRA) to connect to MeshCentral2.
147
-[](https://www.youtube.com/watch?v=rA2KHa2jkO0)
57
+## Feedback
58
+If you encounter a problem or have a suggestion to improve the product, you may file an [issue report](https://github.com/Ylianst/MeshCentral/issues/)
59
60
+If you are filing a problem report, you should include:
61
+* The version of the software you are using
62
+* The Operating System and version
63
+* The observed output
64
+* The expected output
65
+* Any troubleshooting you took to resolve the issue yourself
66
+* Any other similar reports
67
150
-License
151
--------
68
+If you are having issues with the following other products, you should file a report on their respective issue pages
69
+[MeshAgent](https://github.com/Ylianst/MeshAgent/issues)
70
+[MeshRouter](https://github.com/Ylianst/MeshCentralRouter/issues)
71
72
+## License
73
This software is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).