219
edits
Changes
no edit summary
<!-- Template uses {{{name}}}, {{{series}}} -->
<!-- Template uses {{{name}}}, {{{series}}} -->
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| series = {{{series}}}
| name = {{{name}}}
| name = {{{name}}}
}}
}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} VPN (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} VPN (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} VPN (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} VPN (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==
To begin configuration, click the button that looks like a pencil next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
To begin configuration, click the button that looks like a pencil next to the client instance. Refer to the figure and table below for information on the OpenVPN client's configuration fields:
[[File:Networking_rutos_vpn_openvpn_client_configuration_v3.png|border|class=tlt-border|]]
[[File:Networking_rutos_vpn_openvpn_client_configuration_v4.png|border|class=tlt-border|]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>United Kingdom {{!}} USA {{!}} Australia {{!}} South Africa {{!}} Custom; default: <b>United Kingdom</b></td>
<td>United Kingdom {{!}} USA {{!}} Australia {{!}} South Africa {{!}} Custom; default: <b>United Kingdom</b></td>
<td>Represents a list of available VPN servers. </td>
<td>Represents a list of available VPN servers. </td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Password used for authentication to the VPN server.</td>
<td>Password used for authentication to the VPN server.</td>
</tr>
<tr>
<td>Enable OpenVPN config from file</td>
<td>off {{!}} <span style="color:#ffce33 ;">on</span>; default: <b>off</b></td>
<td>Enables or disables custom OpenVPN config from file.</td>
</tr>
<tr>
<td><span style="color:#ffce33 ;">OpenVPN configuration file</span></td>
<td>-(interactive button)</td>
<td>Upload OpenVPN configuration. Warning! This will overwrite your current configuration.</td>
</tr>
<tr>
<td><span style="color:#ffce33 ;">Upload OpenVPN authentications files</span></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Upload OpenVPN authentication files, which will be automatically included in configuration.</td>
</tr>
</tr>
<tr>
<tr>
<td>TUN/TAP</td>
<td>TUN/TAP</td>
<td>TUN (tunnel) {{!}} TAP (bridged); default: <b>TUN (tunnel)</b></td>
<td>TUN (tunnel) {{!}} <span style="color:brown ;">TAP (bridged)</span>; default: <b>TUN (tunnel)</b></td>
<td>Virtual network device type.
<td>Virtual network device type.
<ul>
<ul>
</ul>
</ul>
</td>
</td>
</tr>
<tr>
<td><span style="color:brown ;">Bridge</span></td>
<td>Bridge interface for TAP; default: br-lan</td>
<td>Assign a TAP interface to a bridge.</td>
</tr>
</tr>
<tr>
<tr>
<td>Yes {{!}} No {{!}} None; default: <b>None</b></td>
<td>Yes {{!}} No {{!}} None; default: <b>None</b></td>
<td>Turns LZO data compression on or off.</td>
<td>Turns LZO data compression on or off.</td>
</tr>
</tr>
<tr>
<tr>
</ul>
</ul>
</td>
</td>
</tr>
<tr>
<td>Encryption</td>
<td>DES-CBC 64 {{!}} RC2-CBC 128 {{!}} DES-EDE-CBC 128 {{!}} DES-EDE3-CBC 192 {{!}} DESX-CBC 192 {{!}} BF-CBC 128 {{!}} RC2-40-CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-64CBC 64 {{!}} AES-128-CBC 128 {{!}} AES-128-CFB 128 {{!}} AES-128-CFB1 128 {{!}} AES-128-CFB8 128 {{!}} AES-128-OFB 128 {{!}} AES-128-GCM 128 {{!}} AES-192-CBC 192 {{!}} AES-192-CFB 192 {{!}} AES-192-CFB1 192 {{!}} AES-192-CFB8 192 {{!}} AES-192-OFB 192 {{!}} AES-192-GCM 192 {{!}} AES-256-CBC 256 {{!}} AES-256-CFB 256 {{!}} AES-256-CFB1 256 {{!}} AES-256-CFB8 256 {{!}} AES-256-OFB 256 {{!}} AES-256-GCM 256 {{!}} none; default: <b>AES-256-CBC 256</b></td>
<td>Algorithm used for packet encryption.</td>
</tr>
</tr>
<tr>
<tr>
<tr>
<tr>
<td>Keep alive</td>
<td>Keep alive</td>
<td>two integers separated by a space; default: <b>none</b></td>
<td>two integers separated by a space; default: <b>10 120</b></td>
<td>Defines two time intervals: the first is used to periodically send ICMP requests to the OpenVPN server, the second one defines a time window, which is used to restart the OpenVPN service if no ICMP response is received during the specified time slice. When this value is specfiied on the OpenVPN server, it overrides the 'keep alive' values set on client instances.<br><b>Example</b>: <i>10 120</i></td>
<td>Defines two time intervals: the first is used to periodically send ICMP requests to the OpenVPN server, the second one defines a time window, which is used to restart the OpenVPN service if no ICMP response is received during the specified time slice. When this value is specfiied on the OpenVPN server, it overrides the 'keep alive' values set on client instances.<br><b>Example</b>: <i>10 120</i></td>
</tr>
</tr>
</tr>
</tr>
<tr>
<tr>
<td>Remote network IP netmask</td>
<td>Remote network netmask</td>
<td>netmask; default: <b>none</b></td>
<td>netmask; default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (server).</td>
<td>LAN IP subnet mask of the remote network (server).</td>
To begin configuration, click the button that looks like a pencil next to the server instance. Refer to the figure and table below for information on the OpenVPN server's configuration fields:
To begin configuration, click the button that looks like a pencil next to the server instance. Refer to the figure and table below for information on the OpenVPN server's configuration fields:
[[File:Networking_rutx_vpn_openvpn_server_configuration_v2.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_openvpn_server_configuration_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Encryption</td>
<td>Encryption</td>
<td>DES-CBC 64 {{!}} RC2-CBC 128 {{!}} DES-EDE-CBC 128 {{!}} DES-EDE3-CBC 192 {{!}} DESX-CBC 192 {{!}} BF-CBC 128 {{!}} RC2-40-CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-40CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-64-CBC 64{{!}} AES-128-CBC 128 {{!}} AES-192-CBC 192 {{!}} AES-256-CBC 256 {{!}} none; default: <b>BF-CBC 128</b></td>
<td>DES-CBC 64 {{!}} RC2-CBC 128 {{!}} DES-EDE-CBC 128 {{!}} DES-EDE3-CBC 192 {{!}} DESX-CBC 192 {{!}} BF-CBC 128 {{!}} RC2-40-CBC 40 {{!}} CAST5-CBC 128 {{!}} RC2-64CBC 64 {{!}} AES-128-CBC 128 {{!}} AES-128-CFB 128 {{!}} AES-128-CFB1 128 {{!}} AES-128-CFB8 128 {{!}} AES-128-OFB 128 {{!}} AES-128-GCM 128 {{!}} AES-192-CBC 192 {{!}} AES-192-CFB 192 {{!}} AES-192-CFB1 192 {{!}} AES-192-CFB8 192 {{!}} AES-192-OFB 192 {{!}} AES-192-GCM 192 {{!}} AES-256-CBC 256 {{!}} AES-256-CFB 256 {{!}} AES-256-CFB1 256 {{!}} AES-256-CFB8 256 {{!}} AES-256-OFB 256 {{!}} AES-256-GCM 256 {{!}} none; default: <b>AES-256-CBC 256</b></td>
<td>Algorithm used for packet encryption.</td>
<td>Algorithm used for packet encryption.</td>
</tr>
</tr>
<td>netmask; default: <b>none</b></td>
<td>netmask; default: <b>none</b></td>
<td>LAN IP subnet mask of the remote network (client).</td>
<td>LAN IP subnet mask of the remote network (client).</td>
</tr>
<tr>
<td><span style="color: purple;">Static key:</span> Authentication algorithm</td>
<td>None {{!}} MD5 {{!}} SHA1 {{!}} SHA256 {{!}} SHA384 {{!}} SHA512; default: <b>SHA1</b></td>
<td>Algorithm used for exchanging authentication and hash information.</td>
</tr>
</tr>
<tr>
<tr>
To create a new IPsec instance, go to the <i>Services → VPN → IPsec</i> section, enter a custom name and click the 'Add' button. An IPsec instance with the given name will appear in the "IPsec Configuration" list.
To create a new IPsec instance, go to the <i>Services → VPN → IPsec</i> section, enter a custom name and click the 'Add' button. An IPsec instance with the given name will appear in the "IPsec Configuration" list.
[[File:Networking rutos vpn ipsec add button.png|border|class=tlt-border]]
===IPsec Instance===
===IPsec Instance===
The <b>general settings</b> section is used to configure the main IPsec parameters. Refer to the figure and table below for information on the configuration fields located in the general settings section.
The <b>general settings</b> section is used to configure the main IPsec parameters. Refer to the figure and table below for information on the configuration fields located in the general settings section.
[[File:Networking_rutos_vpn_ipsec_ipsec_instance_general_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_ipsec_ipsec_instance_general_settings_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Authentication method</td>
<td>Authentication method</td>
<td>Pre-shared key {{!}} X.509; default: <b>Pre-shared key</b></td>
<td>Pre-shared key {{!}} <span style="color:darkred">X.509 {{!}} EAP</span> {{!}} <span style="color:blue">PKCS#12</span>; default: <b>Pre-shared key</b></td>
<td>Specify authentication method. Choose between Pre-shared key and X.509 certificates.</td>
<td>Specify authentication method. Choose between Pre-shared key and X.509 certificates.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:chocolate">Pre-shared key:</span> Pre shared key</td>
<td><span style="color:blue">PKCS#12:</span> PKCS12 container</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>A shared password used for authentication between IPsec peers before a secure channel is established.</td>
<td></td>
</tr>
<tr>
<td><span style="color:blue">PKCS#12:</span> PKCS12 decryption passphrase</td>
<td>string; default: <b>none</b></td>
<td></td>
</tr>
<tr>
<td><span style="color:chocolate">Pre-shared key:</span> Pre shared key</td>
<td>string; default: <b>none</b></td>
<td>A shared password used for authentication between IPsec peers before a secure channel is established.</td>
</tr>
</tr>
<!-- removed on 7.0, to return on 7.1 <tr>
<!-- removed on 7.0, to return on 7.1 <tr>
</tr> -->
</tr> -->
<tr>
<tr>
<td><span style="color:darkred">X.509:</span> Key</td>
<td><span style="color:darkred">X.509: {{!}} EAP:</span> Key</td>
<td>A private key file; default: <b>none</b></td>
<td>A private key file; default: <b>none</b></td>
<td>A private key file.</td>
<td>A private key file.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkred">X.509:</span> Key decryption passphrase</td>
<td><span style="color:darkred">X.509: {{!}} EAP:</span> Key decryption passphrase</td>
<td>A password for private key files; default: <b>none</b></td>
<td>A password for private key files; default: <b>none</b></td>
<td>If the private key file is encrypted, the passphrase must be defined.</td>
<td>If the private key file is encrypted, the passphrase must be defined.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkred">X.509:</span> Local Certificate</td>
<td><span style="color:darkred">X.509: {{!}} EAP:</span> Local Certificate</td>
<td>.der file; default: <b>none</b></td>
<td>.der file; default: <b>none</b></td>
<td>A local certificate file.</td>
<td>A local certificate file.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkred">X.509:</span> CA Certificate</td>
<td><span style="color:darkred">X.509: {{!}} EAP:</span> CA Certificate</td>
<td>.der file; default: <b>none</b></td>
<td>.der file; default: <b>none</b></td>
<td>A certificate authority file.</td>
<td>A certificate authority file.</td>
<ul>
<ul>
<li>Chocolate for <span style="color: chocolate;">Authentication method: Pre-shared key</span></li>
<li>Chocolate for <span style="color: chocolate;">Authentication method: Pre-shared key</span></li>
<li>Dark red for <span style="color: darkred;">Authentication method: X.509</span></li>
<li>Dark red for <span style="color: darkred;">Authentication method: X.509/EAP</span></li>
<li>Blue for <span style="color: blue;">Authentication method: PKCS#12</span></li>
</ul>
</ul>
</li>
</li>
<td>ID Selector</td>
<td>ID Selector</td>
<td>%any, IP or FQDN; default: <b>none</b></td>
<td>%any, IP or FQDN; default: <b>none</b></td>
<td>Each secret can be preceded by a list of optional ID selectors. A selector is an IP address, a Fully Qualified Domain Name, user@FQDN or %any. When using IKEv1 use IP address.</br><b>NOTE:</b> IKEv1 only supports IP address ID selector.</td>
<td>Each secret can be preceded by a list of optional ID selectors. A selector is an IP address, a Fully Qualified Domain Name, user@FQDN or %any. When using IKEv1 use IP address. <b>NOTE:</b> IKEv1 only supports IP address ID selector.</td>
</tr>
</tr>
<tr>
<tr>
<td>Type</td>
<td>Type</td>
<td>psk {{!}} xauth; default: <b>psk</b></td>
<td>PSK {{!}} XAUTH {{!}} EAP {{!}} <span style="color:darkred">RSA</span> {{!}} <span style="color:darkred">PKCS#12</span>; default: <b>PSK</b></td>
<td>IPSec secret type.</br><b>NOTE:</b> XAUTH secrets are IKEv1 only.</td>
<td>IPSec secret type. <b>NOTE:</b> XAUTH secrets are IKEv1 only.</td>
</tr>
</tr>
<tr>
<tr>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkred">RSA</span> Secret</td>
<td><span style="color:darkred">RSA {{!}} PKCS#12:</span> Secret</td>
<td>Private key file; default: <b>none</b></td>
<td>Private key file; default: <b>none</b></td>
<td>A private key file.</td>
<td>A private key file.</td>
</tr>
</tr>
<tr>
<tr>
<td><span style="color:darkred">RSA</span> Key decryption passphrase</td>
<td><span style="color:darkred">RSA {{!}} PKCS#12:</span> Key decryption passphrase</td>
<td>A password for private key files; default: <b>none</b></td>
<td>A password for private key files; default: <b>none</b></td>
<td>If the private key file is encrypted, the passphrase must be defined.</td>
<td>If the private key file is encrypted, the passphrase must be defined.</td>
</tr>
</tr>
</table>
</table>
----
----
[[File:Networking_rutos_vpn_ipsec_connection_settings_general_settings.png|border|class=tlt-border]]
[[File:Networking rutos vpn ipsec connection settings general settings v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</ul>
</ul>
</td>
</td>
</tr>
<tr>
<td>Enable XAuth</td>
<td>on {{!}} off; default: <b>off</b></td>
<td>Enables Extended Authentication.</td>
</tr>
</tr>
</table>
</table>
====Advanced settings====
====Advanced settings====
----
----
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_ipsec_connection_settings_advanced_settings_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<b>Secure Socket Tunneling Protocol</b> (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
<b>Secure Socket Tunneling Protocol</b> (SSTP) is a VPN protocol designed to transport PPP traffic via a secure SSL/TLS channel.
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</br><u><b>Note:</b> SSTP is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
</br><u><b>Note:</b> SSTP is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
}}
===SSTP configuration===
===SSTP configuration===
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
Refer to the figure and table below for information on the fields contained in the Stunnel Globals section.
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</br><u><b>Note:</b> Stunnel is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
</br><u><b>Note:</b> Stunnel is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
}}
[[File:Networking_rutos_manual_vpn_stunnel_globals.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_vpn_stunnel_globals.png|border|class=tlt-border]]
<b>Dynamic Multipoint VPN</b> (<b>DMVPN</b>) is a method of building scalable IPsec VPNs. DMVPN is configured as a hub-and-spoke network, where tunnels between spokes are built dynamically; therefore, no change in configuration is required on the hub in order to connect new spokes.
<b>Dynamic Multipoint VPN</b> (<b>DMVPN</b>) is a method of building scalable IPsec VPNs. DMVPN is configured as a hub-and-spoke network, where tunnels between spokes are built dynamically; therefore, no change in configuration is required on the hub in order to connect new spokes.
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
{{#switch: {{{series}}} | RUTX | RUTM= | #default=
</br><u><b>Note:</b> DMPVN is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
</br><u><b>Note:</b> DMPVN is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
}}
===DMVPN configuration===
===DMVPN configuration===
</tr>
</tr>
<tr>
<tr>
<td>Default route</td>
<td>CHAP secret</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>string; default: <b>none</b></td>
<td>When turned on, this connection will become device default route. This means that all traffic directed to the Internet will go through the L2TP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.{{#switch:{{{series}}}|RUTX|RUTM=<br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.}}</td>
<td>A secret used for L2TP Tunnel Authentication.</td>
</tr>
</tr>
</table>
<tr>
<td>MTU</td>
<td>[68..9200]; default: <b>none</b></td>
<td>Sets the maximum transmission unit (MTU) size. It is the largest size of a protocol data unit (PDU) that can be transmitted in a single network layer transaction.</td>
</tr>
<tr>
<td>Default route</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>When turned on, this connection will become device default route. This means that all traffic directed to the Internet will go through the L2TP server and the server's IP address will be seen as this device's source IP to other hosts on the Internet.{{#switch:{{{series}}}|RUTX|RUTM=<br><b>NOTE</b>: this can only be used when [[{{{name}}} Failover|Failover]] is turned off.}}</td>
</tr>
<tr>
<td>Allow CHAP</td>
<td>on | off; default: <b>on</b></td>
<td>Allows CHAP authentication method to be used.</td>
</tr>
<tr>
<td>Allow PAP</td>
<td>on | off; default: <b>off</b></td>
<td>Allows PAP authentication method to be used.</td>
</tr>
<tr>
<td>Allow MSCHAP-v2</td>
<td>on | off; default: <b>on</b></td>
<td>Allow MSCHAP-v2 authentication method to be used.</td>
</tr>
</table>
<b>Active L2TP client instance example:</b>
----
[[File:Networking rutos manual vpn l2tp active client.png|border|class=tlt-border]]
===L2TP server===
===L2TP server===
<td>ip; default: <b>192.168.0.30</b></td>
<td>ip; default: <b>192.168.0.30</b></td>
<td>L2TP IP address leases will end with the address specified in this field.</td>
<td>L2TP IP address leases will end with the address specified in this field.</td>
</tr>
<tr>
<td>Enable CHAP</td>
<td>on | off; default: <b>off</b></td>
<td>Challenge-Handshake Authentication Protocol for L2TP.</td>
</tr>
<tr>
<td>CHAP authentication</td>
<td>on | off; default: <b>on</b></td>
<td>When turned on it requires CHAP authentication method to be used, when turned off it refuses CHAP authentication method.</td>
</tr>
<tr>
<td>PAP authentication</td>
<td>on | off; default: <b>off</b></td>
<td>When turned on it requires PAP authentication method to be used, when turned off it refuses PAP authentication method.</td>
</tr>
<tr>
<td>MSCHAP-v2 authentication</td>
<td>on | off; default: <b>on</b></td>
<td>When turned on it requires MSCHAP-v2 authentication method to be used, when turned off it refuses MSCHAP-v2 authentication method.</td>
</tr>
</tr>
<tr>
<tr>
</tr>
</tr>
</table>
</table>
<b>Active L2TP server instance example:</b>
----
[[File:Networking rutx vpn l2tp active server.png|border|class=tlt-border]]
==L2TPv3==
==L2TPv3==
<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.
<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.
<u><b>Note:</b> ZeroTier is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
<u><b>Note:</b> ZeroTier is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
----
----
In order to create a new ZeroTier Instance, look to the Add New ZeroTier Configuration section; enter a custom name and click the 'Add' button:
In order to create a new ZeroTier Instance, look to the Add New ZeroTier Configuration section; enter a custom name and click the 'Add' button:
ZeroTier network configuration instance should look similar to this:
ZeroTier network configuration instance should look similar to this:
[[File:Networking rutos manual vpn zerotier network instance.png|border|class=tlt-border]]
[[File:Networking rutos manual vpn zerotier network instance_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>hex string; default: <b>none</b></td>
<td>hex string; default: <b>none</b></td>
<td>ZeroTier Network ID. Log in to your ZeroTier account in order to locate the ZeroTier Network ID, which should be a string of hexadecimal characters.</td>
<td>ZeroTier Network ID. Log in to your ZeroTier account in order to locate the ZeroTier Network ID, which should be a string of hexadecimal characters.</td>
</tr>
<tr>
<td>Bridge to</td>
<td>None {{!}} LAN; default: <b>None</b></td>
<td>Specify to which interface this ZeroTier instance should be bridged to. </td>
</tr>
</tr>
<tr>
<tr>
WireGuard works by adding an interface which acts as a tunnel. To create one enter its name and click the <b>Add</b> button. This should add a new Wireguard instance and open a configuration window.
WireGuard works by adding an interface which acts as a tunnel. To create one enter its name and click the <b>Add</b> button. This should add a new Wireguard instance and open a configuration window.
[[File:Networking_rutx_vpn_wireguard_v1.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_v2.png|border|class=tlt-border]]
===General Instance Settings===
===General Instance Settings===
Private keys and generate them, specify Port and IP addresses for communication.
Private keys and generate them, specify Port and IP addresses for communication.
[[File:Networking_rutx_vpn_wireguard_instance_general_v1.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_instance_general_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Private Key</td>
<td>Private Key</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>-</b></td>
<td>Private Key used in authentication.</td>
<td>Private Key used in authentication.</td>
</tr>
</tr>
</tr>
</tr>
<tr>
<tr>
<td>Generate</td>
<td>Generate key pair</td>
<td>-(interactive button)</td>
<td>-(interactive button)</td>
<td>Click to generate Public Key and Private Key.</td>
<td>Click to generate Public Key and Private Key.</td>
</tr>
</tr>
<tr>
<tr>
Advanced Settings section contains Metric and MTU configuration for this WireGuard interface.
Advanced Settings section contains Metric and MTU configuration for this WireGuard interface.
[[File:Networking_rutos_vpn_wireguard_instance_advanced_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_wireguard_instance_advanced_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>Metric</td>
<td>Metric</td>
<td>positive integer; default: <b>none</b></td>
<td>positive integer; default: <b>none</b></td>
<td>Specify metric for this tunnel interface. Lower number means higher priority.</td>
<td>Specify (Optional) metric for this tunnel interface. Lower number means higher priority.</td>
</tr>
<tr>
<td>Listen port</td>
<td>integer [1..65535]; default: <b>51820</b></td>
<td>Required. UDP port used for outgoing and incoming packets.</td>
</tr>
</tr>
<tr>
<tr>
<td>MTU</td>
<td>MTU</td>
<td>integer [1280..1420]; default: <b>none</b></td>
<td>integer [68..9200]; default: <b>none</b></td>
<td>Maximum Transmission Unit for this tunnel interface.</td>
<td>Maximum Transmission Unit of tunnel interface. Range [68 to 9200]. If not specified, the MTU is automatically determined by physical interface MTU value.</td>
</tr>
</tr>
<tr>
<tr>
<td>DNS servers</td>
<td>DNS servers</td>
<td>ip | ips; default: <b>none</b></td>
<td>ip; default: <b>none</b></td>
<td>DNS server(s) for this Wireguard interface.</td>
<td>DNS server(s) for this Wireguard interface.</td>
</tr>
</tr>
----
----
The Peers section is used to create and configure all the peers for this interface.
The Peers section is used to create and configure all the peers for this interface. To create one enter its name and click the <b>Add</b> button.
To create one enter its name and click the <b>Add</b> button.
[[File:Networking_rutx_vpn_wireguard_instance_peer_v3.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_instance_peer_v2.png|border|class=tlt-border]]
In the General section of Peer instance you can configure basic information about the endpoint to allow communications.
In the General section of Peer instance you can configure basic information about the endpoint to allow communications.
[[File:Networking_rutos_vpn_wireguard_instance_peer_instance_general_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_vpn_wireguard_instance_peer_instance_general_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>Public Key</td>
<td>Public Key</td>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Endpoint's Public Key.</td>
<td>Base64-encoded public key of peer.</td>
</tr>
<tr>
<td>Endpoint host</td>
<td>domain name {{!}} ip; default: <b>none</b></td>
<td>Host of peer. Names are resolved prior to bringing up the interface.</td>
</tr>
</tr>
<tr>
<tr>
<td>Allowed IPs</td>
<td>Allowed IPs</td>
<td>ip; default: <b>none</b></td>
<td>ip; default: <b>none</b></td>
<td>A single IP address or a list of them which are allowed to communicate with this peer.</td>
<td>IP addresses and prefixes that this peer is allowed to use inside the tunnel. Usually the peer's tunnel IP addresses and the networks the peer routes through the tunnel.</td>
</tr>
</tr>
<tr>
<tr>
<td>Route Allowed IPs</td>
<td>Route Allowed IPs</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Enable to create routes for <b>Allowed IPs</b> for this peer.</td>
<td>Create routes for Allowed IPs for this peer.</td>
</tr>
</tr>
</table>
</table>
settings such as its Description, Endpoint Host and Port, Preshared Key and other.
settings such as its Description, Endpoint Host and Port, Preshared Key and other.
See more information below.
See more information below.
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_advanced_v1.png|border|class=tlt-border]]
[[File:Networking_rutx_vpn_wireguard_instance_peer_instance_advanced_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Description</td>
<td>Tunnel source</td>
<td>string; default: <b>none</b></td>
<td>Any {{!}} LAN {{!}} WAN {{!}} Mobile; default: <b>Any</b></td>
<td>Description of this peer.</td>
<td>Interface to bind this instance to.</td>
</tr>
</tr>
<tr>
<tr>
</tr>
</tr>
<tr>
<tr>
<td>Endpoint Port</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>integer [1..65535]; default: <b>none</b></td>
<td>Enable to create routes for <b>Allowed IPs</b> for this peer.</td>
<td>Port of peer.</td>
</tr>
</tr>
<tr>
<tr>
<td>Endpoint Host</td>
<td>Persistent Keep Alive</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Specify port to connect to Remote Endpoint. It will be set to <b>51820</b> if left empty.</td>
<td>Seconds between keep alive messages. Default is 0 (disabled). Recommended value if this device is behind a NAT is 25. Range [0 to 65535].</td>
</tr>
</tr>
<tr>
<tr>
<td>Persistent Keep Alive</td>
<td>Routing table</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Specify time amount in seconds between Keep Alive messages. By default this option is <b>0</b> which means it is disabled. Recommended value for a device behind NAT is 25.</td>
<td>Defines which routing table to use for this peer routes, not necessary to configure for most setups..</td>
</tr>
</tr>
</table>
</table>
<td>.key file; default: <b>none</b></td>
<td>.key file; default: <b>none</b></td>
<td>Generated RSA public key.</td>
<td>Generated RSA public key.</td>
</tr>
</table>
==Tailscale==
Tailscale is a straightforward peer-to-peer VPN service that utilizes the open-source WireGuard protocol.
<u><b>Note:</b> Tailscale is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
[[File:Networking rutx vpn tailscale instance general v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Authentication method</td>
<td>Use login url | <span style="color: red;">Use authentication key</span>; default: <b>Use login url</b></td>
<td>Selects method to authenticate your tailscale network.</td>
</tr>
<tr>
<td><span style="color: red;">Authentication key</span></td>
<td>string; default: <b>none</b></td>
<td>Provide an auth key to automatically authenticate the node as your user account.</td>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Turns tailscale service off or on.</td>
</tr>
<tr>
<td>Login server</td>
<td>full url; default: <b>https://controlplane.tailscale.com</b></td>
<td>Provide the base URL of a control server. If you are using Headscale for your control server, use your Headscale instance’s URL.</td>
</tr>
<tr>
<td>Advertise routes</td>
<td>ipv4 or ipv6 with mask; default: <b>none</b></td>
<td>Expose physical subnet routes to your entire Tailscale network.</td>
</tr>
<tr>
<td>Default route</td>
<td><span style="color: green;">on</span> | off; default: <b>off</b></td>
<td>Route traffic through another exit node.</td>
</tr>
<tr>
<td><span style="color: green;">Exit node IP</span></td>
<td>ip; default: <b>none</b></td>
<td>IP address of the exit node.</td>
</tr>
<tr>
<td>Accept routes</td>
<td>on | off; default: <b>off</b></td>
<td>Accept subnet routes that other nodes advertise.</td>
</tr>
<tr>
<td>Exit node</td>
<td>on | off; default: <b>off</b></td>
<td>Offer to be an exit node for outbound internet traffic from the Tailscale network.</td>
</tr>
</tr>
</table>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]