Docs - meshcentral router pdf to mkdocs conversion
silversword411 committed
May 12, 2022 at 02:42 UTC
2eed4f8b00d2715638dcbbca6b769e3108263fca
6 files changed
+133
docs/docs/meshrouter/images/download-link.png
Binary files /dev/null and b/docs/docs/meshrouter/images/download-link.png differ
docs/docs/meshrouter/images/login.png
Binary files /dev/null and b/docs/docs/meshrouter/images/login.png differ
docs/docs/meshrouter/images/port_maps.png
Binary files /dev/null and b/docs/docs/meshrouter/images/port_maps.png differ
docs/docs/meshrouter/images/port_maps2.png
Binary files /dev/null and b/docs/docs/meshrouter/images/port_maps2.png differ
docs/docs/meshrouter/images/port_maps3.png
Binary files /dev/null and b/docs/docs/meshrouter/images/port_maps3.png differ
docs/docs/meshrouter/index.md
+133
@@ -7,3 +7,136 @@
7
<div class="video-wrapper">
8
<iframe width="320" height="180" src="https://www.youtube.com/embed/BubeVRmbCRM" frameborder="0" allowfullscreen></iframe>
9
</div>
10
+
11
+## Downloading
12
+
13
+MeshCentral router is a Windows application that comes built-into the MeshCentral server or can
14
+be downloaded at: <http://info.meshcentral.com/downloads/MeshCentral2/MeshCentralRouter.exe>
15
+
16
+It’s probably best to use the MeshCentral router that comes with your version of the MeshCentral
17
+server as the two will likely be most compatible. A given MeshCentral Router version may not
18
+work with any MeshCentral server versions. On MeshCentral, you can download MeshCentral
19
+Router with this link:
20
+
21
+
22
+
23
+_The router link will only show up on Windows browsers._
24
+
25
+## Login
26
+
27
+MeshCentral router will need to login to your MeshCentral server just like any browser. You can
28
+do this by entering the server name and account username and password. Depending on your
29
+server and account situation, you may see some or all of the following screens.
30
+
31
+
32
+
33
+If the second factor authentication is required, MeshCentral Router does not support hardware
34
+keys (WebAuthn), but does support the YubiKey™ OTP.
35
+
36
+## Creating Port Maps
37
+
38
+Once logged in, you can start adding port maps using the “Add Map…” and “Add Relay Map…”
39
+buttons on the bottom right. You can then create a map and open the associated application
40
+using the “Open…” button and remote to port map using the “Remove” button.
41
+
42
+
43
+
44
+There are two different types of ports mappings. A normal port map and a relay port map. A
45
+normal port map will route packets to the selected destination computer that is running the mesh
46
+agent as shown here.
47
+
48
+
49
+
50
+A relay port map will route traffic thru the server and thru the remote agent to a target IP address
51
+on the remote agent’s network as shown here.
52
+
53
+
54
+
55
+Note that all traffic is encrypted using TLS from MeshCentral Router to the MeshCentral server
56
+and from the server to the MeshAgent. The server and the agent do have access the traffic so it’s
57
+recommended to use port mappings to tunnel data that is also encrypted for that end-to-end
58
+encryption is assured.
59
+
60
+## Command Line Arguments
61
+
62
+MeshCentral router can be run with command line arguments to make it quicker and easier to
63
+use. The arguments range from debugging to being able to quickly login and setting up port
64
+maps.
65
+
66
+```bash
67
+-debug
68
+```
69
+
70
+Causes MeshCentral Router to generate a “debug.log” dump file that can be useful for
71
+debugging.
72
+
73
+```bash
74
+-host:<hostname>
75
+-user:<username>
76
+-pass:<password>
77
+-ignorecert
78
+```
79
+
80
+This set of command line arguments make logging into the MeshCentral server easier. Note that
81
+specifying the password using a command line argument may not be secure as the command
82
+shell can record the password in the command history. The “ignorecert” argument is not
83
+recommended as it’s going to cause MeshCentral Router to ignore untrusted server certificates.
84
+This should only be used for debugging.
85
+
86
+```bash
87
+-map:<protocol>:<localport>:<computername>:<app>:<remoteport>
88
+```
89
+
90
+The “map” argument will automatically create a network map once MeshCentral Router is logged
91
+In. The protocol must be “TCP” or “UDP, the local port can be 0 for any. The computer name is
92
+the server-side name of the computer, if many computers have the same one, one of them will be
93
+selected. The app can be empty for a custom application, or can be “HTTP”, “HTTPS”, “RDP”,
94
+“PuTTY” or “WinSCP”. For the UDP protocol, no apps are currently supported so it should be left
95
+blank. For example you can use:
96
+
97
+```bash
98
+-map:TCP:0:"MyComputer":HTTP:80
99
+-map:UDP:1235:"MyComputer"::1234
100
+```
101
+
102
+The first example will map a random local port to port 80 of “MyComputer” and is expected for
103
+use with HTTP traffic. The second example maps local UDP port 1235 to port 1234 on
104
+“MyComputer”. It’s best for the computer name to be in quotes.
105
+
106
+In addition to port mapping, you can also setup relay maps where a remote computer is used as a
107
+traffic relay like this:
108
+
109
+```bash
110
+-relaymap:<protocol>:<localport>:<computername>
111
+ :<app>:<remoteip>:<remoteport>
112
+```
113
+
114
+This will relays a local port to thru the server and thru a remote agent to a target IP address and
115
+port. For example:
116
+
117
+```bash
118
+-relaymap:TCP:555:"MyComputer":HTTP:192.168.1.1:80
119
+```
120
+
121
+This will relay local port 555 to a 192.168.1.1:80 for HTTP traffic. A typical use of this is to be able
122
+to remotely configure a home router from anywhere on the Internet.
123
+
124
+```bash
125
+-all
126
+```
127
+
128
+The “all” switch will bind local ports to all network interfaces so that other computers on the
129
+network can use the port maps provided by MeshCentral Router. By default, local ports will be
130
+bound to the loopback interface so that only local application can use the port mappings.
131
+
132
+```bash
133
+-tray
134
+```
135
+
136
+The “tray” switch will place MeshCentral Router on the Windows system tray instead of the
137
+normal application bar.
138
+
139
+## Conclusion
140
+
141
+MeshCentral, MeshCentral Router and this document are all opens source and licensed using
142
+Apache 2.0, the full license can be found at <https://www.apache.org/licenses/LICENSE-2.0>.