Skip to content

Commit 8c6255a

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

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-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/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

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
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.
8+
9+
This feature was introduced in v0.23.0 and is in beta (for this release).
10+
11+
12+
Usage
13+
======
14+
15+
Create an internet gateway
16+
--------------------------
17+
18+
1. Under a network, switch to the "Internet Gateways" tab
19+
2. Click on Create Gateway
20+
3. Select the desired Linux host to serve as the internet gateway (VPN server, in traditional parlance)
21+
4. Optionally choose the hosts you want to connect to the internet gateway
22+
5. Click on create
23+
24+
**NOTE:** A host can only be connected to at most one internet gateway, regardless of the networks the host is in.
25+
26+
27+
FAQs and Known Issues
28+
=====================
29+
30+
**Q: Why not Remote Access Gateway as an internet gateway.**
31+
32+
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.
33+
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)