0
edits
Changes
Template:Networking rutos manual setup wizard (view source)
Revision as of 10:32, 14 May 2020
, 10:32, 14 May 2020prepare for release
<!-- Template uses {{{name}}}, {{{series}}}, {{{mobile}}} (0), {{{wireless}}} (0)-->
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.03
| series = {{{series}}}
}}
__TOC__
==Summary==
The <b>Setup Wizard</b> is a tool that offers a simplified version of other WebUI pages used to set some of the most relevant device parameters:
<ul>
<li>[[{{{name}}} NTP|Time]]</li>
<li>[[{{{name}}} LAN|LAN]]</li>
{{#ifeq:{{{mobile}}}|0||<li>[[{{{name}}} WAN|WAN]]</li>}}
{{#ifeq:{{{wireless}}}|0||<li>[[{{{name}}} Wireless|WiFi]]</li>}}
<li>[[{{{name}}}_Cloud_Solutions#RMS|RMS]]</li>
</ul>
You will be greeted with the Setup Wizard the first time you login, after you have changed the device default password. On other logins you will be redirected to the [[{{{name}}} Overview|Overview]] page, but you can reach the Setup Wizard any time via the <i>System → <b>Setup Wizard</b></i> page.
This page is an overview of the Setup Wizard tool for {{{name}}} devices.
==Set new password==
On your very first login you will be <b>required to change the device default password</b>. This is done for safety reasons. In many cases devices are used to provide access to remote networks and systems. Since many manufacturers use similar default passwords (like <i>admin</i>, <i>admin01</i>, <i>admin123</i>, etc.) it is easy for attackers to gain access to devices that use such passwords and compromise the systems behind them. Therefore, to avoid such malicious attacks, this step is mandatory and you will not able to access the rest of the WebUI before you change the password.
The new password must contain:
<ul>
<li>8-32 characters;</li>
<li>at least one upper case letter;</li>
<li>at least one lower case letter;</li>
<li>at least one digit.</li>
</ul>
[[File:Networking_rutx_manual_setup_wizard_password_v1.png]]
After you have entered the new password, click 'Submit'. Afterwards you will be redirected to the first page of the Setup Wizard.
==General==
The <b>General</b> section is used to configure the device's time settings.
[[File:Networking_rutx_manual_setup_wizard_general_v1.png]]
If you wish to set the device's time zone settings later instead, you can do so via the <i>Services → [[{{{name}}} NTP|NTP]]</i> page.
==LAN==
The <b>LAN</b> section is used to configure the device's local area network (LAN) and DHCP server settings. A DHCP (Dynamic Host Configuration Protocol) server can automatically configure the TCP/IP settings for any device that requests such a service. If you connect a device that has been configured to obtain an IP address automatically, the DHCP server will lease out an IP address from the available IP pool and the device will be able to communicate within the device's private network.
{{#ifeq:{{{series}}}|TRB14X|
[[File:Networking_trb1_manual_setup_wizard_lan_v1.png|border|class=tlt-border]] <!-- 192.168.2.1 -->
|
[[File:Networking_rutx_manual_setup_wizard_lan_v3.png|border|class=tlt-border]] <!-- 192.168.1.1 -->
}}
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>IP address</td>
<td>ip; default: <b>{{#ifeq:{{{series}}}|TRB14X|192.168.2.1|192.168.1.1}}</b></td>
<td>The LAN interface's IPv4 address. An IP address identifies a device on a network and allows it to communicate with other devices.</td>
</tr>
<tr>
<td>Netmask</td>
<td>netmask; default: <b>255.255.255.0</b></td>
<td>A <b>[[What is a Netmask?|netmask]]</b> is used to define how "large" a network is by specifying which part of the IP address denotes the network and which part denotes the device.</td>
</tr>
<tr>
<td>Enable DHCP</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Turns the DHCP server on or off.</td>
</tr>
<tr>
<td>Start</td>
<td>integer [1..255]; default: <b>100</b></td>
<td>The starting IP address value. e.g., if your device's LAN IP is 192.168.1.1 and your subnet mask is 255.255.255.0 that means that in your network a valid IP address has to be in the range of [192.168.1.0..192.168.1.254] (192.168.1.255 is a special unavailable address). If the Start value is set to 100 then the DHCP server will only lease out addresses starting from 192.168.1.<b>100</b>.</td>
</tr>
<tr>
<td>Limit</td>
<td>integer [1..255]; default: <b>150</b></td>
<td>How many addresses the DHCP server can lease out. Continuing from the example above: if the start address is 192.168.1.100 and the server can lease out 150 addresses, available addresses will be from 192.168.1.<b>100</b> to 192.168.1.<b>249</b> (<i>100 + 150 – 1 = 249</i>; this is because the first address is inclusive).</td>
</tr>
<tr>
<td>Lease time</td>
<td>interger [2..999999]; default: <b>12</b></td>
<td>A DHCP lease will expire after the amount of time specified in this field and the device that was using the lease will have to request a new one. However, if the device stays connected, its lease will be renewed after half of the specified amount of time passes (e.g., if lease time is 12 hours, then every 6 hours the device will ask the DHCP server to renew its lease).<br>The minimal amount of time that can be specified is 2 minutes.</td>
</tr>
<tr>
<td>Units</td>
<td>Hours {{!}} Minutes; default: <b>Hours</b></td>
<td>Lease time measuring units.</td>
</tr>
</table>
If you wish to set the device's LAN and DHCP settings later instead, you can do so via the <i>Network → [[{{{name}}} LAN|LAN]]</i> page.
{{#ifeq:{{{mobile}}}|0||
==Mobile==
The <b>Mobile</b> section is used to configure the device's SIM card parameters.
[[File:Networking_rutx_manual_setup_wizard_wan_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Auto APN</td>
<td><span style="color:blue">off</span> {{!}} on; default: <b>on</b></td>
<td>An Access Point Name (APN) is a gateway between a GSM, GPRS, 3G or 4G mobile network and another computer network. Depending on the contract, some operators may require you to enter the APN just to complete the registration to a network. In other cases an APN is used to get special parameters from the operator (e.g., a [[Private_and_Public_IP_Addresses#Public_IP_address|public IP address]]) depending on the contract. Auto APN scans an internal Android APN database and selects an APN based on the SIM card's operator and country. If the first automatically selected APN doesn't work, it attempts to use the next existing APN from the database.</td>
</tr>
<tr>
<td><span style="color:blue">Off:</span> APN</td>
<td>Suggestion from device {{!}} <span style="color:chocolate">Custom</span>; default: <b>Suggestion from device</b></td>
<td>Select between a suggested APN from device or enter your custom APN.</td>
</tr>
<tr>
<td><span style="color:chocolate">Custom:</span> Custom APN</td>
<td>string; default: <b>none</b></td>
<td>Custom APN Network Identifier. Cannot start with any of the following strings: "rac", "lac", "sgsn" or "rnc"; it cannot end in ".gprs" and it cannot take the value "*".</td>
</tr>
<tr>
<td><span style="color:chocolate">Custom:</span> Authentication Type</td>
<td>None {{!}} PAP/CHAP (both) {{!}} PAP {{!}} CHAP; default: <b>None</b></td>
<td>The method that your carrier uses to authenticate new connections on its network. If you select PAP, CHAP or
both you will be required to enter a username and password.</td>
</tr>
<tr>
<td>PIN</td>
<td>string; default: <b>none</b></td>
<td>A 4-digit long numeric password used to authenticate the modem to the SIM card.</td>
</tr>
</table>
<b>Note</b>: this table has coloring scheme to indicate which fields can be seen with different configuration.
If you wish to set the device's Mobile WAN settings later instead, you can do so via the <i>Network → [[{{{name}}} WAN|WAN]]</i> page.
}}
{{#ifeq:{{{wireless}}}|0||
==WiFi==
The <b>WiFi</b> section is used to configure the device's WiFi access points (APs). The {{{name}}} supports two types of WiFi: 2.4 GHz and 5 GHz. 2.4 GHz WiFi provides better coverage and works at a longer range, but has lower data transfer speeds when compared to 5 GHz WiFi.
[[File:Networking_rutx_manual_setup_wizard_wifi_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Turns the WiFi access point on or off.</td>
</tr>
<tr>
<td>Channel</td>
<td>WiFi channel number {{!}} auto; default: <b>auto</b></td>
<td>WiFi channel used by the access point. When this field is set to 'auto', the access point will choose the least populated channel.</td>
</tr>
<tr>
<td>SSID</td>
<td>string; default: <b>RUT_<last 4 symbols of WiFi MAC>_<frequency></b></td>
<td>The Service Set Identifier (SSID) is an identification string (name) for the access point. It is how the access point will be seen by connecting devices.</td>
</tr>
<tr>
<td>Encryption</td>
<td>No encryption {{!}} WPA-PSK {{!}} WPA2-PSK {{!}} WPA-PSK/WPA2-PSK Mixed Mode {{!}} WPA-EAP {{!}} WPA2-EAP; default: <b>WPA2-PSK</b></td>
<td>The type of encryption used by the access point.</td>
</tr>
<tr>
<td>Cipher</td>
<td>auto {{!}} Force CCMP (AES) {{!}} Force TKIP {{!}} Force TKIP and CCMP (AES); default: <b>Force TKIP and CCMP (AES)</b></td>
<td>An algorithm for performing encryption and decryption.</td>
</tr>
<tr>
<td>Key</td>
<td>string; default: <b>unique to each device</b></td>
<td>A password used to authenticate users to the access point.</td>
</tr></table>
If you wish to set the device's WiFi settings later instead, you can do so via the <i>Network → [[{{{name}}} Wireless|Wireless]]</i> page.
}}
==RMS==
This section is used to configure the settings required to connect the device to the <b>RMS</b> (<b>Remote Management System</b>) - a cloud system designed by Teltonika and intended for remote monitoring and management of Teltonika's [[Network products|networking products]].
In order to add a device(s) to RMS, get yourself acquainted by watching [https://www.youtube.com/watch?v=bZeqdrAcdVU this instructional video] and register an account by [https://rms.teltonika.lt/ clicking here]. <b>Each unique device receives a free month-long RMS license</b> when added to RMS for the first time.
{{#ifeq:{{{series}}}|RUTX|
[[File:Networking_rutx_manual_setup_wizard_rms_v2.png]]
|
[[File:Networking_trb1_manual_setup_wizard_rms_v1.png|border|class=tlt-border]]
}}
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Connection type</td>
<td>Enabled {{!}} Standby {{!}} Disabled; default: <b>Enabled</b></td>
<td>Defines how the device will connect to RMS:
<ul>
<li><b>Enabled</b> - the device attempts to connect to RMS every 2-5 minutes (every 2 minutes the first hour; then every 5 minutes). If it cannot connect for 14 days, it will enter Standby mode.</li>
<li><b>Standby</b> - the device attempts to connect to RMS every 6 hours.</li>
<li><b>Disabled</b> - RMS functionality is disabled.</li>
</ul>
</td>
</tr>
<tr>
<td>Hostname</td>
<td>host {{!}} ip; default: <b>rms.teltonika.lt</b></td>
<td>Address of the RMS server. If you're using regular RMS, just leave the default address (<i>rms.teltonika.lt</i>).</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>15009</b></td>
<td>Port number for connecting to RMS. If you're using regular RMS, just leave the default port (<i>15009</i>).</td>
</tr>
</table>
If you wish to set the device's RMS settings later instead, you can do so via the <i>Services → Cloud Solutions → [[{{{name}}}_Cloud_Solutions#RMS|RMS]]</i> page.
[[Category:{{{name}}} System section]]
{{Template:Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.03
| series = {{{series}}}
}}
__TOC__
==Summary==
The <b>Setup Wizard</b> is a tool that offers a simplified version of other WebUI pages used to set some of the most relevant device parameters:
<ul>
<li>[[{{{name}}} NTP|Time]]</li>
<li>[[{{{name}}} LAN|LAN]]</li>
{{#ifeq:{{{mobile}}}|0||<li>[[{{{name}}} WAN|WAN]]</li>}}
{{#ifeq:{{{wireless}}}|0||<li>[[{{{name}}} Wireless|WiFi]]</li>}}
<li>[[{{{name}}}_Cloud_Solutions#RMS|RMS]]</li>
</ul>
You will be greeted with the Setup Wizard the first time you login, after you have changed the device default password. On other logins you will be redirected to the [[{{{name}}} Overview|Overview]] page, but you can reach the Setup Wizard any time via the <i>System → <b>Setup Wizard</b></i> page.
This page is an overview of the Setup Wizard tool for {{{name}}} devices.
==Set new password==
On your very first login you will be <b>required to change the device default password</b>. This is done for safety reasons. In many cases devices are used to provide access to remote networks and systems. Since many manufacturers use similar default passwords (like <i>admin</i>, <i>admin01</i>, <i>admin123</i>, etc.) it is easy for attackers to gain access to devices that use such passwords and compromise the systems behind them. Therefore, to avoid such malicious attacks, this step is mandatory and you will not able to access the rest of the WebUI before you change the password.
The new password must contain:
<ul>
<li>8-32 characters;</li>
<li>at least one upper case letter;</li>
<li>at least one lower case letter;</li>
<li>at least one digit.</li>
</ul>
[[File:Networking_rutx_manual_setup_wizard_password_v1.png]]
After you have entered the new password, click 'Submit'. Afterwards you will be redirected to the first page of the Setup Wizard.
==General==
The <b>General</b> section is used to configure the device's time settings.
[[File:Networking_rutx_manual_setup_wizard_general_v1.png]]
If you wish to set the device's time zone settings later instead, you can do so via the <i>Services → [[{{{name}}} NTP|NTP]]</i> page.
==LAN==
The <b>LAN</b> section is used to configure the device's local area network (LAN) and DHCP server settings. A DHCP (Dynamic Host Configuration Protocol) server can automatically configure the TCP/IP settings for any device that requests such a service. If you connect a device that has been configured to obtain an IP address automatically, the DHCP server will lease out an IP address from the available IP pool and the device will be able to communicate within the device's private network.
{{#ifeq:{{{series}}}|TRB14X|
[[File:Networking_trb1_manual_setup_wizard_lan_v1.png|border|class=tlt-border]] <!-- 192.168.2.1 -->
|
[[File:Networking_rutx_manual_setup_wizard_lan_v3.png|border|class=tlt-border]] <!-- 192.168.1.1 -->
}}
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>IP address</td>
<td>ip; default: <b>{{#ifeq:{{{series}}}|TRB14X|192.168.2.1|192.168.1.1}}</b></td>
<td>The LAN interface's IPv4 address. An IP address identifies a device on a network and allows it to communicate with other devices.</td>
</tr>
<tr>
<td>Netmask</td>
<td>netmask; default: <b>255.255.255.0</b></td>
<td>A <b>[[What is a Netmask?|netmask]]</b> is used to define how "large" a network is by specifying which part of the IP address denotes the network and which part denotes the device.</td>
</tr>
<tr>
<td>Enable DHCP</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Turns the DHCP server on or off.</td>
</tr>
<tr>
<td>Start</td>
<td>integer [1..255]; default: <b>100</b></td>
<td>The starting IP address value. e.g., if your device's LAN IP is 192.168.1.1 and your subnet mask is 255.255.255.0 that means that in your network a valid IP address has to be in the range of [192.168.1.0..192.168.1.254] (192.168.1.255 is a special unavailable address). If the Start value is set to 100 then the DHCP server will only lease out addresses starting from 192.168.1.<b>100</b>.</td>
</tr>
<tr>
<td>Limit</td>
<td>integer [1..255]; default: <b>150</b></td>
<td>How many addresses the DHCP server can lease out. Continuing from the example above: if the start address is 192.168.1.100 and the server can lease out 150 addresses, available addresses will be from 192.168.1.<b>100</b> to 192.168.1.<b>249</b> (<i>100 + 150 – 1 = 249</i>; this is because the first address is inclusive).</td>
</tr>
<tr>
<td>Lease time</td>
<td>interger [2..999999]; default: <b>12</b></td>
<td>A DHCP lease will expire after the amount of time specified in this field and the device that was using the lease will have to request a new one. However, if the device stays connected, its lease will be renewed after half of the specified amount of time passes (e.g., if lease time is 12 hours, then every 6 hours the device will ask the DHCP server to renew its lease).<br>The minimal amount of time that can be specified is 2 minutes.</td>
</tr>
<tr>
<td>Units</td>
<td>Hours {{!}} Minutes; default: <b>Hours</b></td>
<td>Lease time measuring units.</td>
</tr>
</table>
If you wish to set the device's LAN and DHCP settings later instead, you can do so via the <i>Network → [[{{{name}}} LAN|LAN]]</i> page.
{{#ifeq:{{{mobile}}}|0||
==Mobile==
The <b>Mobile</b> section is used to configure the device's SIM card parameters.
[[File:Networking_rutx_manual_setup_wizard_wan_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Auto APN</td>
<td><span style="color:blue">off</span> {{!}} on; default: <b>on</b></td>
<td>An Access Point Name (APN) is a gateway between a GSM, GPRS, 3G or 4G mobile network and another computer network. Depending on the contract, some operators may require you to enter the APN just to complete the registration to a network. In other cases an APN is used to get special parameters from the operator (e.g., a [[Private_and_Public_IP_Addresses#Public_IP_address|public IP address]]) depending on the contract. Auto APN scans an internal Android APN database and selects an APN based on the SIM card's operator and country. If the first automatically selected APN doesn't work, it attempts to use the next existing APN from the database.</td>
</tr>
<tr>
<td><span style="color:blue">Off:</span> APN</td>
<td>Suggestion from device {{!}} <span style="color:chocolate">Custom</span>; default: <b>Suggestion from device</b></td>
<td>Select between a suggested APN from device or enter your custom APN.</td>
</tr>
<tr>
<td><span style="color:chocolate">Custom:</span> Custom APN</td>
<td>string; default: <b>none</b></td>
<td>Custom APN Network Identifier. Cannot start with any of the following strings: "rac", "lac", "sgsn" or "rnc"; it cannot end in ".gprs" and it cannot take the value "*".</td>
</tr>
<tr>
<td><span style="color:chocolate">Custom:</span> Authentication Type</td>
<td>None {{!}} PAP/CHAP (both) {{!}} PAP {{!}} CHAP; default: <b>None</b></td>
<td>The method that your carrier uses to authenticate new connections on its network. If you select PAP, CHAP or
both you will be required to enter a username and password.</td>
</tr>
<tr>
<td>PIN</td>
<td>string; default: <b>none</b></td>
<td>A 4-digit long numeric password used to authenticate the modem to the SIM card.</td>
</tr>
</table>
<b>Note</b>: this table has coloring scheme to indicate which fields can be seen with different configuration.
If you wish to set the device's Mobile WAN settings later instead, you can do so via the <i>Network → [[{{{name}}} WAN|WAN]]</i> page.
}}
{{#ifeq:{{{wireless}}}|0||
==WiFi==
The <b>WiFi</b> section is used to configure the device's WiFi access points (APs). The {{{name}}} supports two types of WiFi: 2.4 GHz and 5 GHz. 2.4 GHz WiFi provides better coverage and works at a longer range, but has lower data transfer speeds when compared to 5 GHz WiFi.
[[File:Networking_rutx_manual_setup_wizard_wifi_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off {{!}} on; default: <b>on</b></td>
<td>Turns the WiFi access point on or off.</td>
</tr>
<tr>
<td>Channel</td>
<td>WiFi channel number {{!}} auto; default: <b>auto</b></td>
<td>WiFi channel used by the access point. When this field is set to 'auto', the access point will choose the least populated channel.</td>
</tr>
<tr>
<td>SSID</td>
<td>string; default: <b>RUT_<last 4 symbols of WiFi MAC>_<frequency></b></td>
<td>The Service Set Identifier (SSID) is an identification string (name) for the access point. It is how the access point will be seen by connecting devices.</td>
</tr>
<tr>
<td>Encryption</td>
<td>No encryption {{!}} WPA-PSK {{!}} WPA2-PSK {{!}} WPA-PSK/WPA2-PSK Mixed Mode {{!}} WPA-EAP {{!}} WPA2-EAP; default: <b>WPA2-PSK</b></td>
<td>The type of encryption used by the access point.</td>
</tr>
<tr>
<td>Cipher</td>
<td>auto {{!}} Force CCMP (AES) {{!}} Force TKIP {{!}} Force TKIP and CCMP (AES); default: <b>Force TKIP and CCMP (AES)</b></td>
<td>An algorithm for performing encryption and decryption.</td>
</tr>
<tr>
<td>Key</td>
<td>string; default: <b>unique to each device</b></td>
<td>A password used to authenticate users to the access point.</td>
</tr></table>
If you wish to set the device's WiFi settings later instead, you can do so via the <i>Network → [[{{{name}}} Wireless|Wireless]]</i> page.
}}
==RMS==
This section is used to configure the settings required to connect the device to the <b>RMS</b> (<b>Remote Management System</b>) - a cloud system designed by Teltonika and intended for remote monitoring and management of Teltonika's [[Network products|networking products]].
In order to add a device(s) to RMS, get yourself acquainted by watching [https://www.youtube.com/watch?v=bZeqdrAcdVU this instructional video] and register an account by [https://rms.teltonika.lt/ clicking here]. <b>Each unique device receives a free month-long RMS license</b> when added to RMS for the first time.
{{#ifeq:{{{series}}}|RUTX|
[[File:Networking_rutx_manual_setup_wizard_rms_v2.png]]
|
[[File:Networking_trb1_manual_setup_wizard_rms_v1.png|border|class=tlt-border]]
}}
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Connection type</td>
<td>Enabled {{!}} Standby {{!}} Disabled; default: <b>Enabled</b></td>
<td>Defines how the device will connect to RMS:
<ul>
<li><b>Enabled</b> - the device attempts to connect to RMS every 2-5 minutes (every 2 minutes the first hour; then every 5 minutes). If it cannot connect for 14 days, it will enter Standby mode.</li>
<li><b>Standby</b> - the device attempts to connect to RMS every 6 hours.</li>
<li><b>Disabled</b> - RMS functionality is disabled.</li>
</ul>
</td>
</tr>
<tr>
<td>Hostname</td>
<td>host {{!}} ip; default: <b>rms.teltonika.lt</b></td>
<td>Address of the RMS server. If you're using regular RMS, just leave the default address (<i>rms.teltonika.lt</i>).</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>15009</b></td>
<td>Port number for connecting to RMS. If you're using regular RMS, just leave the default port (<i>15009</i>).</td>
</tr>
</table>
If you wish to set the device's RMS settings later instead, you can do so via the <i>Services → Cloud Solutions → [[{{{name}}}_Cloud_Solutions#RMS|RMS]]</i> page.
[[Category:{{{name}}} System section]]