Skip to content

Commit 66f7cde

Browse files
committed
docs(NET-1024): add docs for internet gateways
1 parent 942ece8 commit 66f7cde

7 files changed

+85
-0
lines changed

features.rst

+2
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Netmaker Professional is our advanced Netmaker offering for business use cases.
4343

4444
- **Relays:** All traffic routing to and from in a network for a relayed machine will go through the relay machine.
4545

46+
- **Internet Gateways:** These work similar to traditional VPNs, and can work with netclients (hosts in the mesh network) as well as with remote devices connected to the network via client configs.
47+
4648
.. toctree::
4749
:maxdepth: 1
4850

pro/images/inet-gw-create.png

145 KB
Loading

pro/images/inet-gw-delete.png

96 KB
Loading

pro/images/inet-gw-feature.png

263 KB
Loading

pro/images/inet-gw-update.png

100 KB
Loading

pro/index.rst

+8
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,11 @@ FailOvers
6969
:maxdepth: 2
7070

7171
pro-failovers
72+
73+
Internet Gateways
74+
-----------------------
75+
76+
.. toctree::
77+
:maxdepth: 2
78+
79+
internet-gateways

pro/internet-gateways.rst

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
===================================
2+
Internet Gateways
3+
===================================
4+
5+
Internet gateways is a Pro-only feature that allows hosts in a Netmaker mesh network to connect to the internet via a gateway. This brings the possibility of a traditional VPN to machines with netclient installed on them. Internet gateways can be configured from the Internet gateway tab.
6+
7+
.. image:: images/inet-gw-feature.png
8+
:alt: internet gateway feature
9+
:align: center
10+
:width: 50%
11+
12+
Only Linux hosts can be setup as internet gateways. Both Windows and Linux hosts can be connected to an internet gateway however. Remote clients can also be connected to internet gateways via a client config.
13+
14+
This feature was introduced in v0.23.0 and is in beta (for this release).
15+
16+
Any relay behind an internet gateway will have its traffic, as well as traffic of its relayed hosts going through the internet gateway.
17+
This behaviour also happens with remote access gateways and their connected clients; a remote access gateway behind an internet gateway would have its traffic, as well as traffic of its clients, passing through the internet gateway.
18+
19+
20+
**For Community Edition (CE) Users**, clients can still access internet gateways via the `Remote Access tab`. View `here for more info <../external-clients.html#internet-gateway-traditional-vpn>`_.
21+
22+
Usage
23+
======
24+
25+
Create an internet gateway
26+
--------------------------
27+
28+
.. image:: images/inet-gw-create.png
29+
:alt: internet gateway creation
30+
:align: center
31+
:width: 50%
32+
33+
1. Under a network, switch to the "Internet Gateways" tab
34+
2. Click on Create Gateway
35+
3. Select the desired Linux host to serve as the internet gateway (VPN server, in traditional parlance)
36+
4. Optionally choose the hosts you want to connect to the internet gateway
37+
5. Click on create
38+
39+
**NOTE:** A host can only be connected to at most one internet gateway, regardless of the networks the host is in.
40+
41+
**NOTE:** A host already connected to an internet gateway cannot be a gateway itself. ie: internet gateway chaining is not supported currently.
42+
43+
44+
Update an internet gateway
45+
--------------------------
46+
47+
.. image:: images/inet-gw-update.png
48+
:alt: internet gateway update
49+
:align: center
50+
:width: 50%
51+
52+
1. Select an internet gateway from the gateways table
53+
2. Click on the update gateway button (from the table row actions dropdown or "Update connected hosts" button on top of the associated "Connected Hosts" table)
54+
3. Update the gateway and save changes
55+
56+
57+
Delete an internet gateway
58+
--------------------------
59+
60+
.. image:: images/inet-gw-delete.png
61+
:alt: internet gateway deletion
62+
:align: center
63+
:width: 50%
64+
65+
1. Click on the delete button from the table row actions dropdown
66+
2. Confirm gateway deletion. This does not entirely remove the host from the network; it only stops the host from serving as an internet gateway.
67+
68+
69+
FAQs and Known Issues
70+
=====================
71+
72+
**Q: Why not Remote Access Gateway as an internet gateway.**
73+
74+
A: Although possible, that serves a similar but different use case. Internet gateways allow not only remote clients, but also and peculiarly, hosts in the Netmaker mesh network to also connect to the internet via a gateway.
75+
This brings the possiblility of a traditional VPN to machines with netclient installed on them. This feature can be accessed from the Internet gateway tab.

0 commit comments

Comments
 (0)