View source for ZeroTier Configuration

<span style="color: red;">The information in this page is updated in accordance with the <span style="color: #0054A6;"><b>RUTXXX_R_00_07_02</b></span> firmware version.</span>

<b>ZeroTier One</b> is an open source software which can establish Peer to Peer VPN (P2PVPN) connection between various devices running various operating systems. It also provides network management possibilities such as routing and creating firewall rules.


==Introduction==

This article contains step-by-step instructions on how to set up and manage a Zerotier network using Teltonika-Networks devices alongs with other equipment.

== Setting up a ZeroTier network==

<ul>
    <li>Go to https://my.zerotier.com/login and log in or create an account if you haven't already.</li>
    <li>Open the 'Networks' tab and click the 'Create a Network' button.<br>[[File:Zerotier_configuration_1.png|border|class=tlt-border]]</li>
    <li>Click the newly created network to begin configuration.<br>[[File:Zerotier_configuration_2.png|border|class=tlt-border]]</li>
    <li>Before configuring anything else, you may want to set up some basic settings.
        <ol>
            <li>Copy the Network ID; you will need it later for ZeroTier node configuration.</li>
            <li>Optionally, set up a name and description for your network for easier management.</li>
            <li>Select 'Private' access control type; <u>unless</u> you want nodes to connect freely, without authorization.</li>
        </ol>[[File:Zerotier_configuration_3.png|border|class=tlt-border]]
    </li>
    <li>Scroll down to find the 'IPv4 Auto-Assign' section. Select one of the provided private IP ranges for your network or click 'Advanced' and set up the range manually. For this example we'll be using the <b>10.147.17.*</b> selection which means our network will be using the <b>10.147.17.0/24</b> IP range.<br>[[File:Zerotier_configuration_4.png|border|class=tlt-border]]</li>
</ul>

The last step concludes the ZeroTier network configuration. However, you may want to modify to the settings based on your specific requirements, but this particular network will function without any additional settings.

The next step is configuring members (aka nodes) for our ZeroTier network.

==Node configuration ==

Zerotier <b>nodes</b> or <b>members</b> are clients that can connect to a ZeroTier network. This section provides information on how to configure ZeroTier nodes on different types of machines.

Take note that if 'Private' access control type is selected, the nodes will only come online after they authorized by you from the ZeroTier Central dashboard. To learn how to authorize nodes, read the [[#Node_authorization|node authorization]] section of this article.

=== Teltonika-Networks device===
----
<ul>
    <li>Log in to your device's WebUI, and navigate to the Services → Package Manager page.</li>
    <li>Find the ZeroTier package in the list and install it.</li>
    <li>Navigate to the Services → VPN → ZeroTier page and create a new ZeroTier configuration.
        <ol>
            <li>Enter a custom name for the configuration.</li>
            <li>Click 'Add'.</li>
            <li>Click the 'Edit' button next to the newly created configuration.</li>
        </ol>[[File:Zerotier_configuration_5.png|border|class=tlt-border]]
    </li>
    <li>Complete the configuration.
        <ol>
            <li>Turn the instance on.</li>
            <li>Paste the ZeroTier Network ID into the 'Networks' field.</li>
            <li>Click 'Save & Apply'.</li>
        </ol>[[File:Zerotier_configuration_6.png|border|class=tlt-border]]
    </li>
    <li>Go to the ZeroTier Central dashboard and [[#Node_authorization|authorize]] this node.</li>
    <li>To check the status of the connection from your device, go to the Services → CLI page and [[Command Line Interfaces|log in]].<br><br>Check connection status with this command:<pre>zerotier-cli info</pre>Check ZeroTier interface IP address with this command (<u>replacing <i><network></i> with the ZeroTier Network ID</u>):<pre>zerotier-cli get <network> ip</pre>[[File:Zerotier_configuration_15.png|border|class=tlt-border]]</li>
</ul>

===Windows device===
----
<ul>
    <li>Download and install ZeroTier for Windows from https://www.zerotier.com/download/.</li>
    <li>Look to the right side of the Windows taskbar and perform these actions:
        <ol>
            <li>Click 'Show hidden icons'.</li>
            <li>Right-click the ZeroTier icon.</li>
            <li>Click 'Join Network...'</li>
            <li>Paste the ZeroTier Network ID.</li>
            <li>Click 'Join'.</li>
        </ol>[[File:Zerotier_configuration_7.png]]
    </li>
    <li>Go to the ZeroTier Central dashboard and [[#Node_authorization|authorize]] this node.</li>
    <li>To check the status of the connection, click 'Show hidden icons' again and click 'Show Networks...'<br>[[File:Zerotier_configuration_16.png]]</li>
</ul>

=== Android/Apple iOS device===
----
<ul>
    <li>Open the 'Google Play Store' or the 'App Store' depending on your mobile device.</li>
    <li>Find the 'ZeroTier One' app and install it.</li>
    <li>Open the application and configure it as follows.
        <ol>
            <li>Click the plus symbol.</li>
            <li>Enter the ZeroTier Network ID.</li>
            <li>Click 'Add Network'.</li>
            <li>Enable the connection to this network by moving the slider next to it.</li>
            <li>In the 'Connection request' pop-up click 'OK' to confirm the connection.</li>
            <li>After you have [[#Node_authorization|authorized]] the new member (your phone), the status indication at the bottom of the screen should turn to 'Online'.</li>
        </ol>[[File:Zerotier_configuration_9.png]]
    </li>
</ul>

==Node authorization==

When Access Control is set to 'Private', you will have to approve new nodes manually from the ZeroTier dashboard before they can become members of the network.

To do this, simply scroll down to the 'Members' section.

<ol>
    <li>Place check marks next to nodes that you wish to authorize.</li>
    <li>Additionally, you may want to add names and descriptions for your nodes to make it easier to differentiate between them.</li>
</ol>

[[File:Zerotier_configuration_10.png|border|class=tlt-border]]

==Private network access==

This section provides instructions on how to set up remote access to private networks behind ZeroTier nodes. For the following instruction, we'll use an example ZeroTier network that consists of three members: a Teltonika-Networks device, a computer and a phone.

For the purposes of this example, let's assume we want to provide remote access for the computer and the phone to the 192.168.1.0/24 network behind the Teltonika-Networks device.

[[File:Zerotier_configuration_access_scheme.png]]

=== ZeroTier routing===
----
<ul>
    <li>Go ZeroTier Central and find the <b><nowiki/>'Managed Routes'</b> box in the 'Advanced' section.</li>
    <li>Add the following route.
        <ol>
            <li>Specify <i>192.168.1.0/24</i> as the destination.</li>
            <li>Specify <i>10.147.17.23</i> (Teltonika device ZeroTier IP) in the 'via' field.</li>
            <li>Click 'Submit'.</li>
        </ol>[[File:Zerotier_configuration_11.png|border|class=tlt-border]]
    </li>
    <li>Configuring it like this will make the entire 192.168.1.0/24 network accessible to other ZeroTier nodes via the Teltonika device's ZeroTier IP address. To configure a route to a single IP address instead, you can specify the address with a <i>/32</i> netmask:<br>[[File:Zerotier_configuration_12.png|border|class=tlt-border]]</li>
</ul>

=== Port forwarding===
----
<ul>
    <li>Enter your Teltonika device's WebUI and navigate to the Network → Firewall → Port Forwards page.</li>
    <li>Find the 'Add New Port Forward' section and add rule such as this:
        <ol>
            <li>Enter a custom name for the rule.</li>
            <li>Select <i>zerotier</i> as the external zone.</li>
            <li>Enter an external port number for listening for incoming connections.</li>
            <li>Select <i>lan</i> as the internal zone.</li>
            <li>Enter a device's IP in the local network.</li>
            <li>Enter a device's listening port number.</li>
            <li>Click 'Add'.</li>
        </ol>[[File:Zerotier_configuration_13.png|border|class=tlt-border]]
    </li>
    <li>Since this configuration concerns port 80, the default HTTP port, configuring it like this would eliminate WebUI access to the Teltonika device over the ZeroTier network. To maintain that access, consider using a different external port:<br>[[File:Zerotier_configuration_14.png|border|class=tlt-border]]</li>
</ul>

==Bridge Configuration ==

ZeroTier bridge configuration will allow two (or more) LAN's in the same ZeroTier network to be interconnected. For this example, we will use two RUTX routers. Both of these routers should already have the ZeroTier package installed and be connected to the ZeroTier Portal.

===First router===
----

*Navigate to '''''Services → VPN → ZeroTier'''''  and access the ZeroTier Instance created previously to edit it for the bridging of LAN’s.
[[File:Zerotier Interfacev2.png|border|class=tlt-border|1050x1050px]]
*From the '''''Bridge to''''' dropdown menu, select '''''LAN'''''. This option bridges The ZeroTier interface with the device's LAN interface, which extends the network and allows for Layer 2 communication via ZeroTier. Bridges operate at the data link layer and facilitate seamless communication between devices on different LAN segments
*Save & Apply settings

===Second Router===
----

*Navigate to '''''Services → VPN → Zerotier''''' → and access the ZeroTier instance, configuring it the same way as the first router.
* Navigate to '''''Network → LAN → General settings''''' and change the '''IPv4 address''' to an IP that is in the same subnet as the first router (We will use 192.168.1.2 for this example)
*Navigate to '''''Network → Interfaces → LAN → DHCP Server''''' and Disable '''DHCP server''' option
*Save & Apply settings
[[File:Zerotier configuration rut 2 configuration v1.png|border|class=tlt-border]]

=== ZeroTier Portal===
----

*Open your ZeroTier Portal (https://my.zerotier.com/) and navigate to your ZeroTier Network.
*Scroll down to Members and enable '''"Allow Ethernet Bridging"''' option on both devices
[[File:ZeroTier Portal Bridging v1.3.png|500×200]][[File:ZeroTier Portal Bridging v1.2.png|500x200]]
*Make sure to turn off '''Auto-Assign from Range''' in the '''advanced section'''. Since this is a Layer 2 bridge configuration, there is no need for IP addresses on the ZeroTier Interfaces and managed IPs. With Layer 2 bridging, devices communicate directly using their local MAC addresses, eliminating the necessity for IP address management.
*'''NOTE: Make sure to remove any Managed IPs that might have stayed when the Auto-assigned feature was turned on (by default, ZeroTier keeps it on).'''

*In the '''Advanced section → Managed Routes,''' add the LAN network route (in this case, 192.168.1.0/24), which ensures communication within the bridge. This allows devices in the ZeroTier network to communicate with devices on the LAN.
[[File:Managed Routes.png||500×200]]

*To ensure convenience and avoid any IP or routing conflicts, it is recommended to remove any other automatically assigned routes in ZeroTier. By doing so, you can prevent routing issues and ensure smoother communication within the LAN bridge network of 192.168.1.0/24 over the ZeroTier Network.

If everything was done correctly, you should be able to ping devices connected to separate routers. Let us test this by pinging a laptop connected to the second router (192.168.1.163) from a laptop connected to the first router (192.168.1.220):

[[File:Zerotier configuration testing v1.png]]


'''Note:''' If you wish to add more routers to the bridged network, you should configure them according to the second router configuration.
[[Category:VPN]]