Difference between revisions of "Template:Networking rutos manual administration"

From Teltonika Networks Wiki
 
(94 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
<!--- {{{series}}}, {{{name}}} --->
 
<!--- {{{series}}}, {{{name}}} --->
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_device_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05
+
| series = {{{series}}}
| series     = {{{series}}}
+
| name  = {{{name}}}
 +
| fw_version ={{Template: Networking_device_manual_latest_fw
 +
| series = {{{series}}}
 +
| name  = {{{name}}}
 +
}}
 
}}
 
}}
 
+
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Administration (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}}} Administration (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>|}}
 +
__TOC__
 
==Summary==
 
==Summary==
  
Line 12: Line 18:
  
 
The <b>General</b> section is used to set up some of device managerial parameters, such as changing device name. For more information on the General section, refer to figure and table below.
 
The <b>General</b> section is used to set up some of device managerial parameters, such as changing device name. For more information on the General section, refer to figure and table below.
 
+
{{#switch:{{{series}}}
[[File:Networking_{{lc:{{{name}}}_manual_administration_general.png|border|class=tlt-border]]
+
| TAP100|TAP200=[[File:Networking_rutos_manual_administration_general_tap100_v1.png|border|class=tlt-border]]
 
+
| TCR1=[[File:Networking_rutos_manual_administration_general_tcr_v2.png|border|class=tlt-border]]
 +
| TRB1|TRB2|TRB5=[[File:Networking_rutos_manual_administration_general_trb_v2.png|border|class=tlt-border]]
 +
| #default=[[File:Networking_rutos_manual_administration_general_rut_v2.png|border|class=tlt-border]]
 +
}}
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 20: Line 29:
 
       <th>Value</th>
 
       <th>Value</th>
 
       <th>Description</th>
 
       <th>Description</th>
 +
    </tr>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 +
    <tr>
 +
      <th>General Settings</th>
 +
        <th></th>
 +
        <th></th>   
 +
    </tr>
 +
    <tr>
 +
      <td>Language</td>
 +
      <td>English {{!}} Turkish<span class="asterisk">*</span> {{!}} Spanish<span class="asterisk">*</span> {{!}} Portuguese<span class="asterisk">*</span> {{!}} German<span class="asterisk">*</span> {{!}} Japanese<span class="asterisk">*</span>; default: <b>English</b></td>
 +
      <td>Changes the router's WebUI language.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Configuration Mode</td>
 +
      <td>Basic {{!}} Advanced; default: <b>Basic</b></td>
 +
      <td>Mode determines what options and configurations are shown. In Basic mode only the essential configurations are shown. In Advanced mode there is greater freedom to configure and access more options.</td>
 +
    </tr>}}
 +
    <tr>
 +
      <th>Device name and hostname</th>
 +
        <th></th>
 +
        <th></th>   
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 32: Line 61:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Mode</td>
+
       <th>LED Indication</th>
      <td>Basic {{!}} Advanced; default: <b>Basic</b></td>
+
        <th></th>
      <td>Mode determines what options and configurations are shown. In Basic mode only the essential configurations are shown. In Advanced mode there is greater freedom to configure and access more options.</td>
+
        <th></th>   
 +
    </tr>
 +
    <tr>
 +
  <td>Enable</td>
 +
        <td>off {{!}} on; default: <b>on</b></td>
 +
        <td>Manages signal strength{{#ifeq:{{{series}}}|RUTX||, LAN}} and connection status indication LEDs.</td>
 +
    </tr>
 +
    <tr>
 +
      <th>Reset Button Configuration</th>
 +
        <th></th>
 +
        <th></th>   
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 45: Line 84:
 
         <td>integer [1..60]; default: <b>none</b></td>
 
         <td>integer [1..60]; default: <b>none</b></td>
 
         <td>Maximum time (in seconds) the button can be held to perform an action, after which no action will be performed.</td>
 
         <td>Maximum time (in seconds) the button can be held to perform an action, after which no action will be performed.</td>
 +
    </tr>
 +
</table>
 +
 +
{{#switch:{{{series}}}|TAP100|TAP200=|#default=<span class="asterisk">*</span> Different language packages can be downloaded separately from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.}}
 +
 +
==Date & Time==
 +
===Summary===
 +
----
 +
<b>Network Time Protocol</b> (<b>NTP</b>) is a networking protocol for clock synchronization between computer
 +
systems over packet-switched, variable-latency data networks. This chapter is an overview of the NTP section for {{{name}}} devices.
 +
===General===
 +
----
 +
The <b>Time Synchronization</b> section lets you select time zone{{#ifeq:{{{gps}}}|1|, enable GPS synchronization|}} and synchronize the time.
 +
 +
The figure below is an example of the Time Synchronization section and the table below
 +
provides information about the fields contained in that section:
 +
 +
[[File:Networking_rutos_ntp_general_gps_{{{gps}}}.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>Current system time</td>
 +
      <td>time; default: <b>none</b></td>
 +
      <td>Current local time of the device.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Sync with browser</td>
 +
      <td>-(interactive button)</td>
 +
      <td>Click to synchronize device time and time zone to browsers, if your device time or time zone is not correct.<br></td>
 +
    </tr>
 +
    <tr>
 +
      <td>Time zone</td>
 +
      <td>time zone; default: <b>UTC</b></td>
 +
      <td>The device will sync time in accordance with the selected time zone.</td>
 +
    </tr>
 +
{{#ifeq:{{{gps}}}|1|
 +
    <tr>
 +
    <td>GPS Synchronization</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Enables periodic time synchronization for the system using the GPS module which does not require an Internet connection.</td>
 +
    </tr>|}}
 +
</table>
 +
===NTP===
 +
----
 +
This section is used to configure NTP client, server and time servers.
 +
 +
====Time Synchronization====
 +
----
 +
This section is used to configure the device's time settings.
 +
 +
[[File:Networking_rutos_ntp_ntp_time_synchronization_{{{mobile}}}.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
    <td>Enable NTP Client</td>
 +
        <td>off {{!}} on; default: <b>on</b></td>
 +
        <td>Turns NTP on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
  <td>Restore to factory defaults</td>
+
    <td>Save time to flash</td>
         <td>-(interactive button)</td>
+
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Restores device to manufacturer's default settings.</td>
+
        <td>Saves last synchronized time to flash memory.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>Force Servers</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Forces unreliable NTP servers.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Update interval (in seconds)</td>
 +
      <td>integer; default: <b>86400</b></td>
 +
      <td>How often the device will update the time.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>Offset frequency</td>
 +
        <td>integer; default: <b>0</b></td>
 +
        <td>Adjusts the minor drift of the clock so that it will run more accurately.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>Count of time synchronizations</td>
 +
         <td>integer; default: <b>none</b></td>
 +
        <td>The amount of times the device will perform time synchronizations. Leave empty in order to set to infinite.</td>
 +
    </tr>{{#ifeq: {{{mobile}}} | 1 |
 +
    <tr>
 +
    <td>Operator Station Synchronization</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Synchronizes time with mobile operator's base station.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>Timezone Synchronization</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Sync time data with mobile operator.</td>
 +
    </tr>|}}
 +
</table>
 +
====Time Servers====
 +
----
 +
This section is used to specify which time servers the device will use for time synchronization. To add more time servers to the list, click the 'Add' button.
 +
 
 +
{{#switch:{{{series}}}|TAP100|TAP200=[[File:Networking_rutos_ntp_ntp_time_servers_tap100_v2.png|border|class=tlt-border]]|#default=[[File:Networking_rutos_ntp_ntp_time_servers_v2.png|border|class=tlt-border]]}}
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
  <td>Restore to user's defaults</td>
+
      <td>Hostname</td>
        <td>-(interactive button)</td>
+
      <td>ip {{!}} url; default: <b>0.openwrt.pool.ntp.org</b></td>
        <td>Restores device to custom configuration set by the user.</td>
+
      <td>NTP servers that this device uses to sync time.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 +
{{#switch:{{{series}}}|TAP100|TAP200=|#default= ====NTP Server====
 +
----
 +
The device can also act as an <b>NTP Server</b>, providing clock synchronization to other devices in the network. From this section you can turn this feature on or off:
 +
 +
[[File:Networking_rutos_ntp_ntp_server.png|border|class=tlt-border]]}}
 +
{{#switch:{{{series}}}|TAP100|TAP200=|#default= ===NTPD===
 +
----
 +
The <b>NTPD</b> program is an operating system daemon that synchronizes the system clock to remote NTP time servers or local reference clocks. NTPD includes the ability to use this to keep your clock in sync and will run more accurately than a clock on a device not running NTPD. NTPD will also use several servers to improve accuracy. It is a complete implementation of NTP version 4 defined by RFC-5905, but also retains compatible with version 3 defined by RFC-1305 and versions 1 and 2, defined by RFC-1059 and RFC-1119, respectively.
 +
 +
<b>Note:</b> NTPD is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
 +
[[File:Networking_rutos_ntp_ntpd_v2.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
    <td>Enable NTPD</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Turns NTPD on or off.</td>
 +
    </tr>
 +
    <tr>
 +
    <td>Enable NTP config from file</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Run NTPD with uploaded configuration file.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>NTP configuration file</td>
 +
      <td>.conf file; default: <b>none</b></td>
 +
      <td>Upload a custom configuration file.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Server</td>
 +
      <td>ip {{!}} url; default: <b>0.openwrt.pool.ntp.org</b></td>
 +
      <td>NTP servers that this device uses to sync time.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Enable Server</td>
 +
      <td>off {{!}} on; default: <b>off</b></td>
 +
      <td>Enables NTPD server to make the router act as an NTP server so that it can provide time synchronization services for other network devices.</td>
 +
    </tr>
 +
</table>}}
 +
 +
==User Settings==
 +
 +
{{Template: Networking_rutos_manual_users | series = {{{series}}} | name = {{{name}}} | wifi = {{{wifi}}} | mobile = {{{mobile}}}}}
  
 
==Access Control==
 
==Access Control==
 
===General===
 
===General===
 
----
 
----
The <b>Access Control</b> page is used to manage remote and local access to device.
+
The <b>Access Control</b> page is used to manage {{#switch:{{{series}}}|TAP100|TAP200=|#default= remote and}} local access to device.
  
<b>Important</b>: turning on remote access leaves your device vulnerable to external attackers. Make sure you use a strong password.
+
{{#switch:{{{series}}}|TAP100|TAP200=|#default=<b>Important</b>: turning on remote access leaves your device vulnerable to external attackers. Make sure you use a strong password.
<br><br>
+
<br><br>}}
 
<b>SSH</b>
 
<b>SSH</b>
----
+
----{{#switch:{{{series}}}
[[File:Networking_rutx_manual_administration_access_control_general_ssh_v1.png]]
+
|TAP100|TAP200 = [[File:Networking_rutos_manual_administration_access_control_general_ssh_tap100_v1.png|border|class=tlt-border]]
 +
|#default = [[File:Networking_rutos_manual_administration_access_control_general_ssh_v1.png|border|class=tlt-border]]}}
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 77: Line 275:
 
     <tr>
 
     <tr>
 
         <td>Enable SSH access</td>
 
         <td>Enable SSH access</td>
         <td>off | on; default: <b>on</b></td>
+
         <td>off {{!}} on; default: <b>on</b></td>
 
         <td>Turns SSH access from the local network (LAN) on or off.</td>
 
         <td>Turns SSH access from the local network (LAN) on or off.</td>
     </tr>
+
     </tr>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 
     <tr>
 
     <tr>
 
         <td>Remote SSH access</td>
 
         <td>Remote SSH access</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns SSH access from remote networks (WAN) on or off.</td>
 
         <td>Turns SSH access from remote networks (WAN) on or off.</td>
     </tr>
+
     </tr>}}
 
     <tr>
 
     <tr>
 
         <td>Port</td>
 
         <td>Port</td>
 
         <td>integer [0..65535]; default: <b>22</b></td>
 
         <td>integer [0..65535]; default: <b>22</b></td>
 
         <td>Selects which port to use for SSH access.</td>
 
         <td>Selects which port to use for SSH access.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Enable key-based authentication</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Use public keys for authentication.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 
<br>
 
<br>
 
<b>WebUI</b>
 
<b>WebUI</b>
----
+
----{{#switch:{{{series}}}
[[File:Networking_rutx_manual_administration_access_control_general_webui_v2.png|border|class=tlt-border]]
+
|TAP100|TAP200 = [[File:Networking_rutos_manual_administration_access_control_general_webui_tap100_v1.png|border|class=tlt-border]]
 +
|#default = [[File:Networking_rutos_manual_administration_access_control_general_webui_v1.png|border|class=tlt-border]]}}
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 104: Line 308:
 
     <tr>
 
     <tr>
 
         <td>Enable HTTP access</td>
 
         <td>Enable HTTP access</td>
         <td>off | on; default: <b>on</b></td>
+
         <td>off {{!}} on; default: <b>on</b></td>
 
         <td>Turns HTTP access from the local network (LAN) to the device WebUI on or off.</td>
 
         <td>Turns HTTP access from the local network (LAN) to the device WebUI on or off.</td>
     </tr><tr><td>Enable HTTPS access
+
     </tr>
</td><td>off | on; default: <b>on</b></td><td>Turns HTTPS access from the local network (LAN) to the device WebUI on or off.</td></tr><tr>
+
    <tr>
 +
        <td>Enable HTTPS access</td>
 +
        <td>off {{!}} on; default: <b>on</b></td>
 +
        <td>Turns HTTPS access from the local network (LAN) to the device WebUI on or off.</td>
 +
    </tr>
 +
    <tr>
 
         <td>Redirect to HTTPS</td>
 
         <td>Redirect to HTTPS</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Redirects connection attempts from HTTP to HTTPS.</td>
 
         <td>Redirects connection attempts from HTTP to HTTPS.</td>
     </tr>
+
     </tr>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 
     <tr>
 
     <tr>
 
         <td>Enable remote HTTP access</td>
 
         <td>Enable remote HTTP access</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns HTTP access from remote networks (WAN) to the device WebUI on or off.</td>
 
         <td>Turns HTTP access from remote networks (WAN) to the device WebUI on or off.</td>
     </tr>
+
     </tr>}}
 
     <tr>
 
     <tr>
 
         <td>Port</td>
 
         <td>Port</td>
 
         <td>integer [0..65535]; default: <b>80</b></td>
 
         <td>integer [0..65535]; default: <b>80</b></td>
 
         <td>Selects which port to use for HTTP access.</td>
 
         <td>Selects which port to use for HTTP access.</td>
     </tr>
+
     </tr>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 
     <tr>
 
     <tr>
 
         <td>Enable remote HTTPS access</td>
 
         <td>Enable remote HTTPS access</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns HTTPS access from remote networks (WAN) to the device WebUI on or off.</td>
 
         <td>Turns HTTPS access from remote networks (WAN) to the device WebUI on or off.</td>
     </tr>
+
     </tr>}}
 
     <tr>
 
     <tr>
 
         <td>Port</td>
 
         <td>Port</td>
 
         <td>integer [0..65535]; default: <b>443</b></td>
 
         <td>integer [0..65535]; default: <b>443</b></td>
 
         <td>Selects which port to use for HTTPS access.</td>
 
         <td>Selects which port to use for HTTPS access.</td>
     </tr>
+
     </tr>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 +
    <tr>
 +
        <td>Ignore private IPs on public interface</td>
 +
        <td>off {{!}} on; default: <b>on</b></td>
 +
        <td>Prevent access from private (RFC1918) IPs on an interface if it has an public IP address.</td>
 +
    </tr>}}{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 +
    <tr>
 +
        <td>Certificate files from device</td>
 +
        <td>off {{!}} on; default: <b>on</b></td>
 +
        <td>Choose this option if you want to select certificate files from device. Certificate files can be generated in [[{{{name}}} Administration#Certificates|Certificates]] section.</td>
 +
    </tr>}}{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 +
    <tr>
 +
        <td>Server certificate</td>
 +
        <td>.crt; default: <b>uhttpd.crt</b></td>
 +
        <td>Server certificate file.</td>
 +
    </tr>}}{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 +
    <tr>
 +
        <td>Server key</td>
 +
        <td>.key; default: <b>uhttpd.key</b></td>
 +
        <td>Server key file.</td>
 +
    </tr>}}
 
</table>
 
</table>
 
<br>
 
<br>
 
<b>CLI</b>
 
<b>CLI</b>
----
+
----{{#switch:{{{series}}}
[[File:Networking_rutx_manual_administration_access_control_general_cli_v1.png]]
+
|TAP100|TAP200 = [[File:Networking_rutos_manual_administration_access_control_general_cli_tap100.png|border|class=tlt-border]]
 +
|#default = [[File:Networking_rutos_manual_administration_access_control_general_cli.png|border|class=tlt-border]]}}
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 146: Line 376:
 
     <tr>
 
     <tr>
 
         <td>Enable CLI</td>
 
         <td>Enable CLI</td>
         <td>off | on; default: <b>on</b></td>
+
         <td>off {{!}} on; default: <b>on</b></td>
 
         <td>Turns CLI access from the local network (LAN) on or off.</td>
 
         <td>Turns CLI access from the local network (LAN) on or off.</td>
     </tr>
+
     </tr>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 
     <tr>
 
     <tr>
 
         <td>Enable remote CLI</td>
 
         <td>Enable remote CLI</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>off {{!}} on; default: <b>off</b></td>
 
         <td>Turns CLI access from remote networks (WAN) on or off.</td>
 
         <td>Turns CLI access from remote networks (WAN) on or off.</td>
     </tr>
+
     </tr>}}
 
     <tr>
 
     <tr>
 
         <td>Port range</td>
 
         <td>Port range</td>
Line 165: Line 395:
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 
+
<br>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
===Security===
+
<b>Telnet</b>
 
----
 
----
[[File:Networking_rutx_manual_administration_access_control_security_v1.png]]
+
[[File:Networking_rutos_manual_administration_access_control_general_telnet.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 177: Line 407:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Fail count</td>
+
         <td>Enable Telnet access</td>
         <td>integer; default: <b>10</b></td>
+
         <td>off {{!}} on; default: <b>on</b></td>
         <td>An amount of times IP address can try to access SSH or WebUI before being blocked.</td>
+
         <td>Turns Telnet access from the local network (LAN) on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Blocked address</td>
+
         <td>Enable remote Telnet access</td>
         <td>ip</td>
+
         <td>off {{!}} on; default: <b>off</b></td>
         <td>IP address which was blocked due to reaching fail count limit.</td>
+
         <td>Turns Telnet access from remote networks (WAN) on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Failed attempts</td>
+
         <td>Port range</td>
         <td>integer</td>
+
         <td>integer [0..65535]; default: <b>23</b></td>
         <td>Amount of times IP address tried to access SSH or WebUI after getting blocked.</td>
+
         <td>Selects which port to use for Telnet access.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
  
==Users & recipients==
+
===PAM===
 
 
The <b>Users & recipients</b> section is used to configure phone groups and email users.
 
 
 
===Phone groups===
 
 
----
 
----
The <b>Phone groups</b> section is used to manage groups of phone numbers.
+
<b>Note:</b> PAM is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
 
 
Refer to the figure below for information on device Phone groups page.
 
 
 
[[File:Networking_rutx_manual_administration_phone_groups_v1.png]]
 
  
You can create a group by writing its name and clicking <b>Add</b> button. To configure group, choose group you want to configure from the list and click [[File:Networking rutx manual edit button v1.png]] <b>Edit</b> button, located at the right side of it.
+
[[File:Networking_rutos_manual_administration_access_control_pam_v2.png|border|class=tlt-border]]
  
===Modify phone group===
+
====Modify PAM Auth====
 
----
 
----
 
+
[[File:Networking_rutos_manual_administration_access_control_pam_modify_pam_auth_v1.png|border|class=tlt-border]]
[[File:Networking_rutx_manual_administration_phone_groups_setup_v1.png]]
 
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 219: Line 440:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
      <td>Group name</td>
+
        <td>Enable</td>
      <td>string; default: <b>none</b></td>
+
        <td>off {{!}} on; default: <b>on</b></td>
      <td>Name of this phone numbers group.</td>
+
        <td>Turns the PAM auth on or off.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Module</td>
 +
        <td><span style="color:blue">TACACS+</span> {{!}} <span style="color:red">Radius</span> {{!}} Local; default: <b>Local</b></td>
 +
        <td>Specifies the PAM module that implements the service.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Type</td>
 +
        <td>Required {{!}} Requisite {{!}} Sufficient {{!}} Optional; default: <b>Required </b></td>
 +
        <td>Determines the continuation or failure behavior for the module</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">TACACS+</span>/<span style="color:red">Radius</span>: Server</td>
 +
        <td>ip4 {{!}} ip6; default: <b>none</b></td>
 +
        <td>The IP address of the RADIUS server</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">TACACS+</span>/<span style="color:red">Radius</span>: Secret</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>RADIUS shared secret</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">TACACS+</span>/<span style="color:red">Radius</span>: Port</td>
 +
        <td>integer [0..65535]; default: <b><span style="color:blue">49</span>/<span style="color:red">1812</span></b></td>
 +
        <td>RADIUS server authentication port</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
      <td>Phone number</td>
+
        <td><span style="color:red">Radius</span>: Timeout</td>
      <td>string; default: <b>none</b></td>
+
        <td>integer [3..10]; default: <b>3</b></td>
      <td>A phone number entry for this group. A phone number containing 0-9*+# characters is accepted.</td>
+
        <td>Timeout in seconds waiting for RADIUS server reply.</td>
 
     </tr>
 
     </tr>
</table>
+
</table>}}
  
===Email users===
+
===Security===
----
+
----  
The <b>Email users</b> section is used to manage email configurations.
+
The <b>Security</b> tab provides the possibility to enable/disable blocking IP's service and delete blocked devices from the list.
  
Refer to the figure below for information on device Email users page.
+
<b>IP Block Settings</b>  
 
 
[[File:Networking_rutx_manual_administration_email_users_v1.png]]
 
 
 
You can create user by writing its name and clicking <b>Add</b> button. To configure email user, choose user you want to configure from the list and click [[File:Networking rutx manual edit button v1.png]] <b>Edit</b> button, located at the right side of it.
 
 
 
===Modify email user===
 
 
----
 
----
[[File:Networking_rutx_manual_administration_email_users_setup_v1.png]]
+
[[File:Networking_rutos_manual_administration_access_control_security_v4.png|border|class=tlt-border]]
 
 
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 251: Line 490:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
      <td>Secure connection</td>
+
        <td>Enable</td>
      <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
+
        <td>off {{!}} on; default: <b>on</b></td>
      <td>Use if your SMTP server supports TLS or SSL encryption.</td>
+
        <td>Enable or disable blocking IP's if they have reached the set amount of failed times.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
      <td>SMTP server</td>
+
        <td>Type</td>
      <td>string; default: <b>none</b></td>
+
        <td>Timed blocking {{!}} Permanent blocking; default: <b>Timed blocking</b></td>
      <td>SMTP server name.</td>
+
        <td>You can choose an option of a blocking type.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
      <td>SMTP server port</td>
+
        <td>Fail count</td>
      <td>integer [0..65535]; default: <b>none</b></td>
+
        <td>integer [1..1000]; default: <b>10</b></td>
      <td>SMTP server port.</td>
+
        <td>An amount of times IP address can try to access SSH or WebUI before being blocked.</td>
    </tr>
 
    <tr>
 
      <td>User name</td>
 
      <td>string; default: <b>none</b></td>
 
      <td>Username used in authentication to SMTP server.</td>
 
    </tr>
 
    <tr>
 
      <td>Password</td>
 
      <td>string; default: <b>none</b></td>
 
      <td>Password used in authentication to SMTP server.</td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
      <td>Sender's email address</td>
+
        <td>Clean after reboot</td>
      <td>string; default: <b>none</b></td>
+
        <td>off {{!}} on; default: <b>off</b></td>
      <td>Configured SMTP server's user's email address.</td>
+
        <td>If enabled, blocked loging attempts list will be cleared on device reboot.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
  
 
+
<b>Login Attempts</b>
==Troubleshoot==
+
----
 
+
[[File:Networking_rutos_manual_administration_access_control_security_login_v2.png|border|class=tlt-border]]
The <b>Troubleshoot</b> section is used to download various files that contain information used for troubleshooting the device. Refer to the figure and table below for information on the Troubleshoot page.
 
 
 
[[File:Networking_rutx_manual_administration_troubleshoot_v1.png]]
 
 
 
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
Line 296: Line 521:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>System log</td>
+
         <td>Source</td>
         <td>- (interactive button)</td>
+
         <td>IP address</td>
         <td>Displays the contents of the device system log file. The system log contains records of various system related events, such as starts/stops of various services, errors, reboots, etc.</td>
+
        <td>Shows the IP address from which the connection failed.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Destination</td>
 +
        <td>IP address</td>
 +
        <td>Shows yours device IP adress</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Port (protocol)</td>
 +
         <td>Port number</td>
 +
        <td>Shows the port number from which the connection failed.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Kernel log</td>
+
         <td>Status</td>
         <td>- (interactive button)</td>
+
         <td>Attempt count {{!}} Blocked</td>
         <td>Displays the contents of the device kernel log file. The kernel log contains records of various events related to the processes of the operating system (OS).</td>
+
         <td>Shows the number of failed attempts to connect to device. Indicates whether the source address is blocked or not.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Troubleshoot file</td>
+
         <td>Reset</td>
         <td>- (interactive button)</td>
+
         <td>Check box</td>
         <td>Downloads the device Troubleshoot file. It contains the device configuration information, logs and some other files. When requesting support, it is recommended to always provide the device Troubleshoot file to Teltonika engineers for analysis.</td>
+
         <td>Allows you to select multiple IP addresses.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>TCP dump file</td>
+
         <td>Actions</td>
         <td>- (interactive button)</td>
+
         <td>-(interactive button)</td>
         <td>Downloads the device TCP dump file. TCP dump is a program used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.</td>
+
         <td>Allows you to select multiple IP addresses.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Enable TCP dump<span class="asterisk">*</span></td>
+
         <td>Unblock all</td>
         <td>off | on; default: <b>off</b></td>
+
        <td>-(interactive button)</td>
         <td>Turns TCP dump packets capture on or off.</td>
+
        <td>Deletes instance.</td>
 +
    </tr>
 +
    <tr>
 +
         <td>Unblock selected</td>
 +
        <td>-(interactive button)</td>
 +
         <td>Unblocks selected source adresses from the list.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
  
<font size="-1"><span class="asterisk">*</span> More on TCP dump in the [[#TCP_dump|next section]].</font>
+
{{#switch:{{{series}}}|TAP100|TAP200= ===Device Pairing===
 +
----
 +
[[File:Networking_rutos_manual_administration_access_control_pairing_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>Enable or disable device pairing.</td>
 +
    </tr>
 +
</table>|#default=}}
 +
 
 +
{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 +
==Recipients==
  
===TCP dump===
+
The <b>Recipients</b> section is used to configure{{#ifeq:{{{mobile}}}|0|&nbsp;|&nbsp;phone groups and&nbsp;}}email
 +
users, which can later be used along with{{#ifeq:{{{mobile}}}|0|&nbsp;|&nbsp;SMS or&nbsp;}}email related
 +
services{{#ifeq:{{{events_reporting}}}|0|.|, such as [[{{{name}}} Events Reporting|Events Reporting]].}}
 +
 
 +
{{#ifeq:{{{mobile}}}|0||
 +
===Phone Groups===
 
----
 
----
<b>TCP dump</b> is a program used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.  
+
A <b>Phone Group</b> is a collection of phone numbers that can be used as the recipient in SMS & call related services instead of specifying every number individually. The phone group list is empty by default thus, you must first add at least one new group before you can add phone numbers to it. To create and begin editing a phone group, follow these steps:
 +
 
 +
<ol>
 +
    <li>Enter a custom name for the phone group into the 'Name' field.</li>
 +
    <li>Click the 'Add' button.</li>
 +
</ol>
  
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
+
[[File:Networking_rutos_manual_administration_recipients_phone_groups_add_button.png|border|class=tlt-border]]
  
[[File:Networking_rutx_manual_administration_troubleshoot_tcp_dump_v3.png|border|class=tlt-border]]
+
After clicking 'Edit' you should be redirected to that phone group's configuration page where you can start adding phone numbers to it.
 +
 
 +
[[File:Networking_rutos_manual_administration_recipients_phone_groups_modify_phone_group.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 339: Line 608:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Enable TCP dump</td>
+
      <td>Group name</td>
        <td>off | on; default: <b>off</b></td>
+
      <td>string; default: <b>none</b></td>
        <td>Turns TCP dump packet capture on or off.</td>
+
      <td>Name of this phone numbers group.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Select interface</td>
+
      <td>Phone number</td>
        <td>network interface; default: '''br-lan'''</td>
+
      <td>string; default: <b>none</b></td>
        <td>Only captures packets that move through the specified network interface.</td>
+
      <td>A phone number entry for this group. Numbers that consist of <i>0-9*+#</i> characters are accepted. Click the plus symbol to add more entries.</td>
 
     </tr>
 
     </tr>
 +
</table>
 +
 +
===Email Users===
 +
----
 +
When email related services{{#ifeq:{{{events_reporting}}}|0|&nbsp;|&nbsp;(such as [[{{{name}}} Events Reporting|Events Reporting]])&nbsp;}}are used, the device logs in to the specified email account and reads the inbox (e.g., Email to SMS) or sends out a message (e.g., SMS to Email) depending on the configured service. In this context, an <b>Email Account</b> is an configuration instance that contains the necessary data required in order to log into an email account.
 +
 +
The email accounts list is empty by default thus, you must first add at least one new account before you can configure it. To create and begin editing an email account, follow these steps:
 +
 +
<ol>
 +
    <li>Enter a custom name for the email account into the 'Name' field.</li>
 +
    <li>Click the 'Add' button.</li>
 +
</ol>
 +
 +
[[File:Networking_rutos_manual_administration_recipients_email_accounts_groups_add_button_v1.png|border|class=tlt-border]]
 +
 +
After clicking 'Add' you should be redirected to that email account's settings page where you can start configuring the account.
 +
 +
[[File:Networking_rutos_manual_administration_recipients_email_accounts_modify_email_account_v3.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <td>Select protocol filter</td>
+
         <th>Field</th>
        <td>all | icmp | tcp | udp | arp; default: <b>All</b></td>
+
      <th>Value</th>
        <td>Only captures packets that match the specified protocol.</td>
+
      <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Select packets direction</td>
+
      <td>Secure connection</td>
        <td>Incoming/Outgoing | Incoming | Outgoing; default: <b>Incoming/Outgoing</b></td>
+
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Only captures packets coming from the specified direction.</td>
+
      <td>Use if your SMTP server supports TLS or SSL encryption.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Host</td>
+
      <td>SMTP server</td>
        <td>ip | host; default: <b>none</b></td>
+
      <td>string; default: <b>none</b></td>
        <td>Only captures packets related to the specified host.</td>
+
      <td>Name of the email service provider's SMTP server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Port</td>
+
      <td>SMTP server port</td>
        <td>integer [0..65335]; default: <b>none</b></td>
+
      <td>integer [0..65535]; default: <b>none</b></td>
        <td>Only captures packets related to the specified communication port.</td>
+
      <td>Port of the email service provider's SMTP server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Credentials</td>
 +
      <td>off {{!}} <span style="color: blue;">on</span>; default: <b>off</b></td>
 +
      <td>This options allows you to set username and password of email account.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Select storage</td>
+
      <td><span style="color: blue;">Username</span></td>
        <td>Internal storage | / ; default: <b>Internal storage</b></td>
+
      <td>string; default: <b>none</b></td>
        <td>Specifies where the TCP dump file will be stored.</td>
+
      <td>Username for authentication on SMTP (Simple Mail Transfer Protocol) server. All characters are allowed except `' and space.</td>
 
     </tr>
 
     </tr>
</table>
 
 
===Diagnostics===
 
----
 
The <b>Diagnostics</b> section is used to execute simple network diagnostic tests, including <i>ping</i>, <i>traceroute</i> and <i>nslookup</i>.
 
 
[[File:Networking_rutx_manual_administration_diagnostics_v3.png|border|class=tlt-border]]
 
 
<table class="nd-mantable">
 
 
     <tr>
 
     <tr>
        <th>Field</th>
+
      <td><span style="color: blue;">Password</span></td>
       <th>Value</th>
+
       <td>string; default: <b>none</b></td>
       <th>Description</th>
+
       <td>Password for authentication on SMTP (Simple Mail Transfer Protocol) server. All characters are allowed except `' and space.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Method</td>
+
       <td>Sender's email address</td>
       <td>Ping | Traceroute | Nslookup; default: <b>Ping</b></td>
+
       <td>string; default: <b>none</b></td>
       <td>Selects diagnostic method.
+
       <td>An address that will be used to send your email from. Allowed characters (a-zA-Z0-9._%+-@).</td>
            <ul>
 
                <li><b>Ping</b> - sends ICMP requests to the specified address.</li>
 
                <li><b>Traceroute</b> - displays the path that packets have to take in order to reach the specified address.</li>
 
                <li><b>Nslookup</b> - obtains domain name address and IP address mapping information.</li>
 
            </ul>
 
        </td>
 
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Protocol</td>
+
       <td>Do not verify authenticity</td>
       <td>IPv4 | IPv6; default: <b>IPv4</b></td>
+
       <td><span style="color: red;">off</span> {{!}} on; default: <b>off</b></td>
       <td>Selects IP address family for diagnostic test.</td>
+
       <td>When enabled peer's certificate authenticity will not be verified.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Address</td>
+
       <td><span style="color: red;">Server's CA file</span></td>
       <td>ip | host; default: <b>none</b></td>
+
       <td> - (interactive button)</td>
       <td>IP address or hostname on which the diagnostic test will be performed.</td>
+
       <td>Upload server's CA file.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
        <td>Perform</td>
+
      <td>Send test email</td>
       <td>-(interactive button)</td>
+
       <td> - (interactive button)</td>
       <td>Performs diagnostic test when clicked.</td>
+
       <td> Sends an email based on the current configuration. This is used to test whether the configuration works as intended.</td>
 
     </tr>
 
     </tr>
</table>
+
</table>}}}}
 
 
==Overview setup==
 
 
 
The <b>Overview setup</b> section is used to select which widgets will be shown in the [[{{{name}}}_Overview]] window.
 
{{#switch:{{{series}}}
 
| RUTX = {{#switch:{{{name}}}
 
        | RUTX10 = [[File:Networking_rutx10_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
        | RUTX08 = [[File:Networking_rutx10_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
        | [[File:Networking_rutx11_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
        }}
 
| TRB2XX = [[File:Networking_trb2_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
| TRB14X = [[File:Networking_trb1_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
|
 
}}
 
  
 +
{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 
==Certificates==
 
==Certificates==
  
The <b>Certificates</b> page is used for convenient TLS certificate and key generation and management. Generated files can be exported and used on other machines or locally on this device with functions that use TLS/SSL, such as [[{{{name}}} MQTT|MQTT]], [[{{{name}}} VPN#OpenVPN|OpenVPN]], [[{{{name}}} VPN#IPsec|IPsec]] and others.
+
The <b>Certificates</b> page is used for convenient TLS certificate and key generation and management. Generated files can be exported and used on other machines or locally on this device with functions that use TLS/SSL, such as {{#ifeq:{{{mqtt}}}|0||[[{{{name}}} MQTT|MQTT]],&nbsp;}}[[{{{name}}} VPN#OpenVPN|OpenVPN]], [[{{{name}}} VPN#IPsec|IPsec]] and others.
  
 
===Certificate Generation===
 
===Certificate Generation===
Line 456: Line 722:
 
====Generation Parameters====
 
====Generation Parameters====
 
----
 
----
Generating each type of file (excluding 'Simple') requires setting some parameters. This section provides an overview for parameters used in TLS certificate generation.
+
Generating each type of file requires setting some parameters. This section provides an overview for parameters used in Simple and TLS certificate generation.
 
----
 
----
<b>Core parameters</b> or simply parameters that apply to each file type are the size and common name of the generated file(s).
+
<b>Simple file parameters</b>
 +
 
 +
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_simple_parameters.png|border|class=tlt-border]]
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>Hosts</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Appends hostnames to certificates.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>IP addresses</td>
 +
      <td>IPv4 address; default: <b>none</b></td>
 +
      <td>Appends IPv4 addresses to certificates.</td>
 +
    </tr>
 +
</table>
 +
----
 +
<b>TLS parameters</b> or simply parameters that apply to each (CA, Server, Client, DH) file type are the size and common name of the generated file(s).
  
 
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_core_parameters_v1.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_core_parameters_v1.png|border|class=tlt-border]]
Line 511: Line 799:
 
     <tr>
 
     <tr>
 
       <td>Delete Signing Request</td>
 
       <td>Delete Signing Request</td>
       <td>off | on; default: <b>off</b></td>
+
       <td>off {{!}} on; default: <b>off</b></td>
 
       <td>Generation creates additional 'signing request' files (which appear under the [[#Certificate_Manager|Certificate Manager]] tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.</td>
 
       <td>Generation creates additional 'signing request' files (which appear under the [[#Certificate_Manager|Certificate Manager]] tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.</td>
 
     </tr>
 
     </tr>
Line 520: Line 808:
 
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_private_key_decryption_password_v1.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_private_key_decryption_password_v1.png|border|class=tlt-border]]
  
===Certificate Signing===
+
====Certificate Signing====
 
----
 
----
 
The <b>Certificate Signing</b> section is used to validate (sign) unsigned certificates.
 
The <b>Certificate Signing</b> section is used to validate (sign) unsigned certificates.
  
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_certificate_signing_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_administartion_certificates_certificates_generation_certificate_signing_v3.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 534: Line 822:
 
     <tr>
 
     <tr>
 
       <td>Signed Certificate Name</td>
 
       <td>Signed Certificate Name</td>
       <td>string; default: <b>cert</b></td>
+
       <td>string; default: <b>none</b></td>
 
       <td>Name of the signed certificate.</td>
 
       <td>Name of the signed certificate.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Type of Certificate to Sign</td>
 
       <td>Type of Certificate to Sign</td>
       <td>Certificate Authority | Client Certificate | Server Certificate; default: <b>Certificate Authority</b></td>
+
       <td>Certificate Authority {{!}} Client Certificate {{!}} Server Certificate; default: <b>Certificate Authority</b></td>
 
       <td>Specifies what type of file will be signed.</td>
 
       <td>Specifies what type of file will be signed.</td>
 
     </tr>
 
     </tr>
Line 549: Line 837:
 
     <tr>
 
     <tr>
 
       <td>Days Valid</td>
 
       <td>Days Valid</td>
       <td>integer; default: <b>3650</b></td>
+
       <td>integer; default: <b>none</b></td>
 
       <td>Length of the signature's validity.</td>
 
       <td>Length of the signature's validity.</td>
 
     </tr>
 
     </tr>
Line 564: Line 852:
 
     <tr>
 
     <tr>
 
       <td>Delete Signing Request</td>
 
       <td>Delete Signing Request</td>
       <td>off | on; default: <b>off</b></td>
+
       <td>off {{!}} on; default: <b>off</b></td>
 
       <td>Generation creates additional 'signing request' files (which appear under the [[#Certificate_Manager|Certificate Manager]] tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.</td>
 
       <td>Generation creates additional 'signing request' files (which appear under the [[#Certificate_Manager|Certificate Manager]] tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Hosts</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Appends hostnames to certificates.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>IP addresses</td>
 +
      <td>IPv4 address; default: <b>none</b></td>
 +
      <td>Appends IPv4 addresses to certificates.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 580: Line 878:
 
====Certificate Import====
 
====Certificate Import====
 
----
 
----
The <b>Certificate Import</b> section provides the possibility to import certificates and files generated on another machine. To upload such a file simply click 'Browse', locate the file on your computer and click 'Import'
+
The <b>Certificate Import</b> section provides the possibility to import certificates and files generated on another machine. To upload such a file simply click 'Browse' and locate the file on your computer, it should then start uploading automatically.
  
[[File:Networking_rutos_manual_administartion_certificates_certificates_manager_certificate_import_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_administartion_certificates_certificates_manager_certificate_import_v3.png|border|class=tlt-border]]
  
 
====Certificates, Keys & Requests====
 
====Certificates, Keys & Requests====
 
----
 
----
The <b>Certificates</b>, <b>Keys</b> and </b>Requests</b> section display files generated on or imported to the device along with the most important information related to them.  
+
The <b>Certificates</b>, <b>Keys</b> and <b>Requests</b> section display files generated on or imported to the device along with the most important information related to them.  
  
 
By default, the lists are empty. A set certificates generated using 'Simple' file type would look something like this:
 
By default, the lists are empty. A set certificates generated using 'Simple' file type would look something like this:
  
[[File:Networking_rutos_manual_administartion_certificates_certificates_manager_certificate_list_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_administartion_certificates_certificates_manager_certificate_list_v2.png|border|class=tlt-border]]
  
 
The 'Export' buttons are used to download the files from the device onto your local machine. The 'X' buttons located to the right of each entry are used to delete related files.
 
The 'Export' buttons are used to download the files from the device onto your local machine. The 'X' buttons located to the right of each entry are used to delete related files.
  
==Root CA==
+
===Root CA===
 +
----
 +
The <b>Root CA</b> section is used to add a root CA certificate file to the device. There is a default file already preloaded on the device which will be overwritten by any uploaded file. The certificates must be in .pem format, maximum file size is 300 KB. These certificates are only needed if you want to use HTTPS for your services and the default file should be sufficient in most cases.
 +
 
 +
[[File:Networking_rutos_manual_administration_access_control_root_ca_v1.png|border|class=tlt-border]]}}
 +
 
 +
==Profiles==
 +
 
 +
{{Template: Networking_rutos_manual_profiles | series = {{{series}}} | name = {{{name}}}}}
 +
 
 +
{{#switch:{{{series}}}|TAP100|TAP200=|#default=
 +
==Storage Memory Expansion==
  
The <b>Root CA</b> section is used to add a root CA certificate file to the device. There is a default file already preloaded on the device which will be overwritten by any uploaded file. The certificates must be in .pem format, maximum file size is 300 KB. These certificates are only needed if you want to use HTTPS for your services and the default file should be sufficient in most cases.
+
{{#ifeq:{{{usb}}}| 1 |
 +
===USB===
 +
----
 +
The <b>Storage Memory Expansion</b> function provides the possibility to expand the device's flash memory with a USB mass storage device.
 +
 
 +
====Memory Expansion====
 +
----
 +
You can <b>expand the flash memory</b> of this device with a USB Mass Storage Device (MSD) and use the extra memory to install additional software packages. This section provides instruction on how to do just that. However, there are a few prerequisites and warnings to take note of before using memory expansion.
 +
 
 +
To be eligible for memory expansion, the USB MSD must meet the following restrictions.
 +
 
 +
<ul>
 +
    <li>The MSD must be the last one (chronologically) inserted.</li>
 +
    <li>If you are using a USB hub, the target MSD must be the last one attached to the hub.</li>
 +
    <li><b>No important data on the MSD as it will be wiped during expansion setup!</b></li>
 +
</ul>
 +
 
 +
When expansion is enabled, <b>do not detach the USB device as this will delete the data stored on it</b>. Changes made to the device configuration while expansion was enabled will disappear after it is disabled.
 +
 
 +
====Enabling memory expansion====
 +
----
 +
To successfully expand the flash memory of your device follow the steps described below.
 +
 
 +
<ol>
 +
    <li>Attach a USB Mass Storage Device (MSD) to the USB connector on the device and go to the Services → Storage Memory Expansion page.</li>
 +
    <li>Set the 'Enable storage expansion' slider to 'on' and click 'Save & Apply'.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_1.png|border|class=tlt-border]]</li>
 +
    <li>You will see a pop-up asking for confirmation. Take note that <u>if you continue from this point on:</u>
 +
        <ul>
 +
            <li>your <b>USB device's memory will be wiped</b> and formatted to ext2 format;</li>
 +
            <li>your device's <b>current configuration will be backed up</b> and restored to this point if the USB drive is removed or memory expansion is disabled;</li>
 +
            <li>the entire procedure <b>may take a very long time</b> and includes a reboot at the end; exact time will vary depending on the size of the MSD (larger size will take longer; for example, using a 128 GB drive will take about 2 hours to fully set up, while a 16 GB will only take about 5 minutes).</li>
 +
        </ul>Click 'Continue' to proceed.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_2.png|border|class=tlt-border]]
 +
    </li>
 +
    <li>If all is in order you should see a 'Formatting MSD...' message on the screen. This indicates that the MSD is being formatted and integrated with the system. This procedure can take a long time and ends with a reboot of the device.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_3.png]]</li>
 +
    <li>Your device's flash memory will be expanded once the reboot has finished. In order to check, log in to the WebUI and look to the 'System' widget in the 'Overview' page. Hover your mouse cursor over the 'FLASH' memory indicator; you should see an increase to the device's flash memory.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_4.png|border|class=tlt-border]]</li>
 +
</ol>
  
[[File:Networking_rutx_manual_administration_root_ca_v2.png|border|class=tlt-border]]
+
====Disabling memory expansion====
 +
----
 +
To successfully disable memory expansion follow the steps described below.
  
==Logging==
+
<ol>
 +
    <li>Go to the Services → Storage Memory Expansion page.</li>
 +
    <li>Set the 'Enable storage expansion' slider to 'off' and click 'Save & Apply'.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_1.png|border|class=tlt-border]]</li>
 +
    <li>You will see a pop-up asking for confirmation. Take note that <u>if you continue from this point on:</u>
 +
        <ul>
 +
            <li>your <b>USB device's memory will be wiped</b> and formatted to NTFS format;</li>
 +
            <li>your <b>device's configuration will be restored</b> to the point it was before memory expansion;</li>
 +
            <li>the entire procedure <b>will take up to 2 minutes</b> including a reboot.</li>
 +
        </ul>Click 'Continue' to proceed.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_2.png|border|class=tlt-border]]
 +
    </li>
 +
    <li>If all is in order you should see a 'Formatting MSD...' message on the screen. This indicates that the MSD is being formatted and detached from the system. This procedure can take up to a couple of minutes and ends with a reboot of the device.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_3.png]]</li>
 +
    <li>Your device's flash memory will be restored to normal once the reboot has finished. In order to check, log in to the WebUI and look to the 'System' widget in the 'Overview' page. Hover your mouse cursor over the 'FLASH' memory indicator; you should see your device's flash memory return to its regular size.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_4.png|border|class=tlt-border]]</li>
 +
</ol>|}}
  
The <b>Logging</b> section is used to configure how and where the device stores system log data. The system log is a file that contains information on various system related events and is useful to engineers for troubleshooting the device.
+
===SSHFS===
 +
----
 +
<b>SSHFS</b> is a tool, which allows you to mount a remote filesystem (in remote SSH server) to your {{{name}}} device using SSH.  
 +
This service is safe to use as it authenticates connections and encrypts them.
  
Refer to the figure and table below for information on the device Logging page.
+
<b>SSHFS</b> configuration consists of setting up authentication, port and mount information parameters. Below is an example oh the SSHFS configuration page.
  
[[File:Networking_rutx_manual_administration_logging_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_sshfs_v3.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 615: Line 976:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>System log buffer size</td>
+
       <td>Enable</td>
       <td>integer; default: <b>128</b></td>
+
       <td>off {{!}} on; default: <b>off</b></td>
       <td>System log buffer size in kibibytes (KiB).</td>
+
       <td>Turns the SSHFS service on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>External system log server</td>
+
       <td>Hostname</td>
       <td>ip; default: <b>none</b></td>
+
       <td>string; default: <b>none</b></td>
       <td>IP address of an external server that will be used to store device logs.</td>
+
       <td>Hostname of the remote SSH server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>External system log server port</td>
+
       <td>Port</td>
 
       <td>integer [0..65535]; default: <b>none</b></td>
 
       <td>integer [0..65535]; default: <b>none</b></td>
       <td>TCP/UDP port number of the external log server.</td>
+
       <td>Port of the remote SSH server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>External system log server protocol</td>
+
       <td>Username</td>
       <td>UDP | TCP; default: <b>UDP</b></td>
+
       <td>string; default: <b>none</b></td>
       <td>Communication protocol used by the external log server.</td>
+
       <td>Username of the remote SSH server.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
       <td>Save log in</td>
+
       <td>Password</td>
       <td>RAM memory | Flash memory; default: <b>RAM memory</b></td>
+
       <td>string; default: <b>none</b></td>
       <td>Specifies which type of memory to use for storing system logs.</td>
+
       <td>Password of the remote SSH server.</td>
     </tr></table>
+
     </tr>
 
+
    <tr>
==Unsaved changes==
+
      <td>Mount Point</td>
 
+
      <td>filepath; default: <b>/sshmount</b></td>
The <b>Unsaved changes</b> section is used to see and apply or revert all unsaved changes.
+
      <td>Mount point of remote file system <b>in the {{{name}}}</b>. Remote file system has to be mounted at root <b>/</b> level.
 
+
          By default the remote file system will be mounted on <b>/sshmount</b>, directory will be automatically created if does not exist yet.</td>
[[File:Networking_rutx_manual_administration_unsaved_changes_v1.png|border|class=tlt-border]]
+
    </tr>
 +
    <tr>
 +
      <td>Mount Path</td>
 +
      <td>filepath; default: <b>/home/</b></td>
 +
      <td>Mount path <b>in the remote SSH server</b>. For example, if SSH server is hosted on Ubuntu operating system, the Mount Path could look like this (depending on your needs): <b>/home/username/</b></td>
 +
    </tr>
 +
</table>}}
  
 
[[Category:{{{name}}} System section]]
 
[[Category:{{{name}}} System section]]

Latest revision as of 13:08, 18 April 2024

The information in this page is updated in accordance with firmware version .


Summary

This page is an overview of the Administration section of {{{name}}} devices.

General

The General section is used to set up some of device managerial parameters, such as changing device name. For more information on the General section, refer to figure and table below. Networking rutos manual administration general rut v2.png

Field Value Description
General Settings
Language English | Turkish* | Spanish* | Portuguese* | German* | Japanese*; default: English Changes the router's WebUI language.
Configuration Mode Basic | Advanced; default: Basic Mode determines what options and configurations are shown. In Basic mode only the essential configurations are shown. In Advanced mode there is greater freedom to configure and access more options.
Device name and hostname
Device name string; default: {{{name}}} Device model name.
Hostname string; default: Teltonika-{{{name}}}.com Device hostname. This can be used for communication with other LAN hosts.
LED Indication
Enable off | on; default: on Manages signal strength, LAN and connection status indication LEDs.
Reset Button Configuration
Min time integer [0..60]; default: none Minimum time (in seconds) the button needs to be held to perform an action.
Max time integer [1..60]; default: none Maximum time (in seconds) the button can be held to perform an action, after which no action will be performed.

* Different language packages can be downloaded separately from the System → [[{{{name}}} Package Manager|Package Manager]] page.

Date & Time

Summary


Network Time Protocol (NTP) is a networking protocol for clock synchronization between computer systems over packet-switched, variable-latency data networks. This chapter is an overview of the NTP section for {{{name}}} devices.

General


The Time Synchronization section lets you select time zone and synchronize the time.

The figure below is an example of the Time Synchronization section and the table below provides information about the fields contained in that section:

[[File:Networking_rutos_ntp_general_gps_{{{gps}}}.png|border|class=tlt-border]]

Field Value Description
Current system time time; default: none Current local time of the device.
Sync with browser -(interactive button) Click to synchronize device time and time zone to browsers, if your device time or time zone is not correct.
Time zone time zone; default: UTC The device will sync time in accordance with the selected time zone.

NTP


This section is used to configure NTP client, server and time servers.

Time Synchronization


This section is used to configure the device's time settings.

[[File:Networking_rutos_ntp_ntp_time_synchronization_{{{mobile}}}.png|border|class=tlt-border]]

Field Value Description
Enable NTP Client off | on; default: on Turns NTP on or off.
Save time to flash off | on; default: off Saves last synchronized time to flash memory.
Force Servers off | on; default: off Forces unreliable NTP servers.
Update interval (in seconds) integer; default: 86400 How often the device will update the time.
Offset frequency integer; default: 0 Adjusts the minor drift of the clock so that it will run more accurately.
Count of time synchronizations integer; default: none The amount of times the device will perform time synchronizations. Leave empty in order to set to infinite.

Time Servers


This section is used to specify which time servers the device will use for time synchronization. To add more time servers to the list, click the 'Add' button.

Networking rutos ntp ntp time servers v2.png

Field Value Description
Hostname ip | url; default: 0.openwrt.pool.ntp.org NTP servers that this device uses to sync time.

NTP Server


The device can also act as an NTP Server, providing clock synchronization to other devices in the network. From this section you can turn this feature on or off:

Networking rutos ntp ntp server.png

NTPD


The NTPD program is an operating system daemon that synchronizes the system clock to remote NTP time servers or local reference clocks. NTPD includes the ability to use this to keep your clock in sync and will run more accurately than a clock on a device not running NTPD. NTPD will also use several servers to improve accuracy. It is a complete implementation of NTP version 4 defined by RFC-5905, but also retains compatible with version 3 defined by RFC-1305 and versions 1 and 2, defined by RFC-1059 and RFC-1119, respectively.

Note: NTPD is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page. Networking rutos ntp ntpd v2.png

Field Value Description
Enable NTPD off | on; default: off Turns NTPD on or off.
Enable NTP config from file off | on; default: off Run NTPD with uploaded configuration file.
NTP configuration file .conf file; default: none Upload a custom configuration file.
Server ip | url; default: 0.openwrt.pool.ntp.org NTP servers that this device uses to sync time.
Enable Server off | on; default: off Enables NTPD server to make the router act as an NTP server so that it can provide time synchronization services for other network devices.

User Settings

Change Password


The User settings section is used to change the password of the current user.

Networking rutos users change password v2.png

System Users

Summary


The System Users page is used to add new user accounts that can access the device with different user credentials than the default ones. The newly added users can be assigned to one of two groups, either of which can be modified to limit WebUI read/write access rights for users belonging to each specific group.

This page is unrelated to SSH users. By default, there is one SSH user named "root" and it shares the same password as the default WebUI user named "admin".

This manual page provides an overview of the Users page in {{{name}}} devices.

If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Advanced" button, located at the top of the WebUI.

Networking rutos manual webui basic advanced mode 75.gif

Groups


The Groups section lists available user groups of which there are three:

Networking rutos users groups v2.png


  • root - highest level of authority. Key elements that define this group:
    • has unlimited read/write access;
    • additional users cannot be added to this group;
    • access rights for this group cannot be modified.

    Networking rutos manual users root visualization.png

  • admin - second highest level of authority. Key elements that define this group:
    • limited read access; by default, users belonging to this group cannot view these pages:
      • System → [[{{{name}}}_Administration#System_Users|Users]].
    • unlimited write access by default;
    • access rights can be modified.

    Networking rutos manual users admin visualization.png

  • user - lowest level of authority. Key elements that define this group:
    • no write access;
    • limited read access; by default, users belonging to this group cannot view these pages:
      • Services → Mobile Utilities → Messages → [[{{{name}}} Mobile_Utilities#Send_Messages|Send Messages]];
      • System → [[{{{name}}}_Administration#System_Users|Users]];
      • System → [[{{{name}}} Firmware|Firmware]];
      • System → [[{{{name}}} Reboot|Reboot]].
    • access rights can be modified.

    Networking rutos manual users user visualization.png

Additional note: you can view and/or edit settings for each group by clicking the 'Edit' button next to them. More on information on how to edit group access settings is located in the following section of this manual page.

Group Settings (edit group)

A group's parameters can be set in its Group Settings page. To access the Groups Settings page, click the 'Edit' button next to the group's name. Below is an example of the Group Settings section:

Networking rutos users groups group settings v1.png

Field Value Description
Write action Allow | Deny; default: Allow Specifies whether to allow or deny write actions for users in the group. Write actions consist of changing configurations and performing certain actions (such as clicking buttons).
This field directly correlates with the "Write access" field below it, because the selected write action will apply to pages specified in that field.
Write access path(s) to page(s); default:
  • system/multiusers/change_password
Path(s) to the page(s) to which the selected "Write action" will be applied. Click the plus symbol to add multiple entries.
Read action Allow | Deny; default: Deny Specifies whether to allow or deny read actions for users in the group. Read actions consist of viewing pages on the WebUI.
This field directly correlates with the "Read access" field below it, because the selected read action will apply to pages specified in that field.
Read access path(s) to page(s); default:
  • services/mobile_utilities/sms/send
  • services/packages
  • system/multiusers/
  • system/flashops/
  • system/backup
  • system/admin/access_control
  • system/cli
  • system/uscripts
  • system/wizard
  • services/packages/upload
  • network/
Path(s) to the page(s) to which the selected "Read action" will be applied. Click the plus symbol to add more entries.
Examples

The easiest way to master the syntax is to navigate to page that you want to generate a path for and the copy the path from the URL of that page.

For example, to specify the path to the Network → Mobile page, navigate to the page, copy the page's URL address starting from the symbol "#" and paste it into one of the access fields:

Networking rutos users groups example url bar v1.png


However, the VPN window contains links to many different types of VPN pages. If you want to specify only one of them, you can do it as well. For example, to to specify the path to the IPsec page, add "/ipsec" to the path string:

services/vpn/ipsec

An asterisk (*) in the path string means that the every page from that point on is included in that path. For example, to generate a path that includes pages in the Services menu tab:

services/*

Or to simply include everything in the entire WebUI (if this path is combined with Read action: Deny, users from that group will not be able to login to the WebUI):

*

Users


The Users section lists all created users and provides the possibility to change their passwords and the group they belong to (with the exception of the default user "admin" which always belongs to the root group).

By default, there is only one user called "admin":

Networking rutos users users v3.png

User Settings (edit user)

Each user's password and group parameters can be set in their User Settings pages. To access the User Settings page, click the 'Edit' button next to the user's name.

However, you may want to add a new user at first. This can be done from the [[{{{name}}}_Users#Add_New_User|Add New User]] section below:

Networking rutos users add new user example v2.png

  1. create a username;
  2. create a password for the user (must contain at least 8 characters, including at least one upper case letter and one digit);
  3. click the 'Add' button;
  4. click the 'Edit' next to newly added user.

Below is an example of a newly added user's settings page:

Networking rutos users user settings v2.png

Field Value Description
Username string; default: none Displays the user's name.
New password string; default: none Create a new password for the user. The password must contain at least 8 characters, including at least one upper case letter and one digit.
Confirm new password string; default: none Repeat the new password.
Group admin | user; default: user The group to which the user belongs.
Enable SSH access off | on; default: off Enables SSH access to user.

Add New User


The Add New User section is used to create additional users that can access the WebUI. After a new user is added, it will appear in the [[{{{name}}} Users#Users|Users]] section.

Networking rutos users add new user v2.png

Field Value Description
Username string; default: none A custom name for the new user.
Password string; default: none A password for the new user. The password must contain at least 8 characters, including at least one upper case letter and one digit.

Access Control

General


The Access Control page is used to manage remote and local access to device.

Important: turning on remote access leaves your device vulnerable to external attackers. Make sure you use a strong password.

SSH


Networking rutos manual administration access control general ssh v1.png

Field Value Description
Enable SSH access off | on; default: on Turns SSH access from the local network (LAN) on or off.
Remote SSH access off | on; default: off Turns SSH access from remote networks (WAN) on or off.
Port integer [0..65535]; default: 22 Selects which port to use for SSH access.
Enable key-based authentication off | on; default: off Use public keys for authentication.


WebUI


Networking rutos manual administration access control general webui v1.png

Field Value Description
Enable HTTP access off | on; default: on Turns HTTP access from the local network (LAN) to the device WebUI on or off.
Enable HTTPS access off | on; default: on Turns HTTPS access from the local network (LAN) to the device WebUI on or off.
Redirect to HTTPS off | on; default: off Redirects connection attempts from HTTP to HTTPS.
Enable remote HTTP access off | on; default: off Turns HTTP access from remote networks (WAN) to the device WebUI on or off.
Port integer [0..65535]; default: 80 Selects which port to use for HTTP access.
Enable remote HTTPS access off | on; default: off Turns HTTPS access from remote networks (WAN) to the device WebUI on or off.
Port integer [0..65535]; default: 443 Selects which port to use for HTTPS access.
Ignore private IPs on public interface off | on; default: on Prevent access from private (RFC1918) IPs on an interface if it has an public IP address.
Certificate files from device off | on; default: on Choose this option if you want to select certificate files from device. Certificate files can be generated in [[{{{name}}} Administration#Certificates|Certificates]] section.
Server certificate .crt; default: uhttpd.crt Server certificate file.
Server key .key; default: uhttpd.key Server key file.


CLI


Networking rutos manual administration access control general cli.png

Field Value Description
Enable CLI off | on; default: on Turns CLI access from the local network (LAN) on or off.
Enable remote CLI off | on; default: off Turns CLI access from remote networks (WAN) on or off.
Port range range of integers [0..65534]-[1..65535]; default: 4200-4220 Selects which ports to use for CLI access.
Shell limit integer [1..10]; default: 5 Maximum number of active CLI connections.


Telnet


Networking rutos manual administration access control general telnet.png

Field Value Description
Enable Telnet access off | on; default: on Turns Telnet access from the local network (LAN) on or off.
Enable remote Telnet access off | on; default: off Turns Telnet access from remote networks (WAN) on or off.
Port range integer [0..65535]; default: 23 Selects which port to use for Telnet access.

PAM


Note: PAM is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

Networking rutos manual administration access control pam v2.png

Modify PAM Auth


Networking rutos manual administration access control pam modify pam auth v1.png

Field Value Description
Enable off | on; default: on Turns the PAM auth on or off.
Module TACACS+ | Radius | Local; default: Local Specifies the PAM module that implements the service.
Type Required | Requisite | Sufficient | Optional; default: Required Determines the continuation or failure behavior for the module
TACACS+/Radius: Server ip4 | ip6; default: none The IP address of the RADIUS server
TACACS+/Radius: Secret string; default: none RADIUS shared secret
TACACS+/Radius: Port integer [0..65535]; default: 49/1812 RADIUS server authentication port
Radius: Timeout integer [3..10]; default: 3 Timeout in seconds waiting for RADIUS server reply.

Security


The Security tab provides the possibility to enable/disable blocking IP's service and delete blocked devices from the list.

IP Block Settings


Networking rutos manual administration access control security v4.png

Field Value Description
Enable off | on; default: on Enable or disable blocking IP's if they have reached the set amount of failed times.
Type Timed blocking | Permanent blocking; default: Timed blocking You can choose an option of a blocking type.
Fail count integer [1..1000]; default: 10 An amount of times IP address can try to access SSH or WebUI before being blocked.
Clean after reboot off | on; default: off If enabled, blocked loging attempts list will be cleared on device reboot.

Login Attempts


Networking rutos manual administration access control security login v2.png

Field Value Description
Source IP address Shows the IP address from which the connection failed.
Destination IP address Shows yours device IP adress
Port (protocol) Port number Shows the port number from which the connection failed.
Status Attempt count | Blocked Shows the number of failed attempts to connect to device. Indicates whether the source address is blocked or not.
Reset Check box Allows you to select multiple IP addresses.
Actions -(interactive button) Allows you to select multiple IP addresses.
Unblock all -(interactive button) Deletes instance.
Unblock selected -(interactive button) Unblocks selected source adresses from the list.


Recipients

The Recipients section is used to configure phone groups and email users, which can later be used along with SMS or email related services, such as [[{{{name}}} Events Reporting|Events Reporting]].

Phone Groups


A Phone Group is a collection of phone numbers that can be used as the recipient in SMS & call related services instead of specifying every number individually. The phone group list is empty by default thus, you must first add at least one new group before you can add phone numbers to it. To create and begin editing a phone group, follow these steps:

  1. Enter a custom name for the phone group into the 'Name' field.
  2. Click the 'Add' button.

Networking rutos manual administration recipients phone groups add button.png

After clicking 'Edit' you should be redirected to that phone group's configuration page where you can start adding phone numbers to it.

Networking rutos manual administration recipients phone groups modify phone group.png

Field Value Description
Group name string; default: none Name of this phone numbers group.
Phone number string; default: none A phone number entry for this group. Numbers that consist of 0-9*+# characters are accepted. Click the plus symbol to add more entries.

Email Users


When email related services (such as [[{{{name}}} Events Reporting|Events Reporting]]) are used, the device logs in to the specified email account and reads the inbox (e.g., Email to SMS) or sends out a message (e.g., SMS to Email) depending on the configured service. In this context, an Email Account is an configuration instance that contains the necessary data required in order to log into an email account.

The email accounts list is empty by default thus, you must first add at least one new account before you can configure it. To create and begin editing an email account, follow these steps:

  1. Enter a custom name for the email account into the 'Name' field.
  2. Click the 'Add' button.

Networking rutos manual administration recipients email accounts groups add button v1.png

After clicking 'Add' you should be redirected to that email account's settings page where you can start configuring the account.

Networking rutos manual administration recipients email accounts modify email account v3.png

Field Value Description
Secure connection off | on; default: off Use if your SMTP server supports TLS or SSL encryption.
SMTP server string; default: none Name of the email service provider's SMTP server.
SMTP server port integer [0..65535]; default: none Port of the email service provider's SMTP server.
Credentials off | on; default: off This options allows you to set username and password of email account.
Username string; default: none Username for authentication on SMTP (Simple Mail Transfer Protocol) server. All characters are allowed except `' and space.
Password string; default: none Password for authentication on SMTP (Simple Mail Transfer Protocol) server. All characters are allowed except `' and space.
Sender's email address string; default: none An address that will be used to send your email from. Allowed characters (a-zA-Z0-9._%+-@).
Do not verify authenticity off | on; default: off When enabled peer's certificate authenticity will not be verified.
Server's CA file - (interactive button) Upload server's CA file.
Send test email - (interactive button) Sends an email based on the current configuration. This is used to test whether the configuration works as intended.

Certificates

The Certificates page is used for convenient TLS certificate and key generation and management. Generated files can be exported and used on other machines or locally on this device with functions that use TLS/SSL, such as [[{{{name}}} MQTT|MQTT]], [[{{{name}}} VPN#OpenVPN|OpenVPN]], [[{{{name}}} VPN#IPsec|IPsec]] and others.

Certificate Generation


The Certificate Generation tab provides the possibility to generate TLS certificates required for secure authentication and communication encryption used by some of the devices services.

There are five distinct generation methods (denoted by the selected 'File Type').

  1. Simple - generates and signs a set of 2048 bit certificate and key files that include:
    • Certificate Authority (CA)
    • Server certificate & key
    • Client certificate & key
    • DH Parameters
    The CA file generated with this option automatically signs the certificates. In short, this option is used for convenience as it doesn't let the user set any additional parameters for the certificate files. Therefore, it should be used only when no other specific requirements are expected.
  2. CA - generates a Certificate Authority (CA) file. A CA is a type of certificate file that certifies the ownership of a public key by the named subject of the certificate. In other words, it assures clients that they are connecting to a trusted server and vice versa.
  3. Server - generates a server certificate and key. A server certificate validates a server's identity to connecting clients, while a key is responsible for encryption.
  4. Client - generates a client certificate and key. A client certificate validates a client's identity to the server that it's connecting to, while a key is responsible for encryption.
  5. DH Parameters - generates a Diffie-Hellman (DH) parameters file. DH parameters are used in symmetric encryption to protect and define how OpenSSL key exchange is performed.

Generation Parameters


Generating each type of file requires setting some parameters. This section provides an overview for parameters used in Simple and TLS certificate generation.


Simple file parameters

Networking rutos manual administartion certificates certificates generation simple parameters.png

Field Value Description
Hosts string; default: none Appends hostnames to certificates.
IP addresses IPv4 address; default: none Appends IPv4 addresses to certificates.

TLS parameters or simply parameters that apply to each (CA, Server, Client, DH) file type are the size and common name of the generated file(s).

Networking rutos manual administartion certificates certificates generation core parameters v1.png

Field Value Description
Key Size integer; default: 2048 Generated key size in bits. Larger keys provide more security but take longer to generate. A 2048 bit is the preferred option.
Name (CN) string; default: cert Common Name (CN), aka Fully Qualified Domain Name (FQDN) is a parameter that defines the name of the certificate. It should be chosen with care as it is not only used for easier management. For example, the Common Name should typically hostname of the server. It may also be used to differentiate clients in order to apply client-specific settings.

Subject information is not mandatory but can be used as user-friendly way to identify the ownership of certificate files by including such information as the owner's location and company name.

Networking rutos manual administartion certificates certificates generation subject information v1.png


The Sign the certificate slider control whether the certificate will be signed automatically or manually after the generation is complete.

Networking rutos manual administartion certificates certificates generation sign the certificate v1.png

Field Value Description
Days Valid integer; default: 3650 Length of the signature's validity.
CA File Name filename; default: none Selects which CA file will be used to sign the generated certificate.
CA key filename; default: none Selects which CA key file will be used to sign the generated certificate.
Delete Signing Request off | on; default: off Generation creates additional 'signing request' files (which appear under the Certificate Manager tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.

A Private Key Decryption Password is a parameter used to decrypt private keys protected by a password.

Networking rutos manual administartion certificates certificates generation private key decryption password v1.png

Certificate Signing


The Certificate Signing section is used to validate (sign) unsigned certificates.

Networking rutos manual administartion certificates certificates generation certificate signing v3.png

Field Value Description
Signed Certificate Name string; default: none Name of the signed certificate.
Type of Certificate to Sign Certificate Authority | Client Certificate | Server Certificate; default: Certificate Authority Specifies what type of file will be signed.
Certificate Request File file; default: none Specifies the signing request file linked to the certificate.
Days Valid integer; default: none Length of the signature's validity.
Certificate Authority File filename; default: none Selects which CA file will be used to sign the generated certificate.
Certificate Authority Key filename; default: none Selects which CA key file will be used to sign the generated certificate.
Delete Signing Request off | on; default: off Generation creates additional 'signing request' files (which appear under the Certificate Manager tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.
Hosts string; default: none Appends hostnames to certificates.
IP addresses IPv4 address; default: none Appends IPv4 addresses to certificates.
Sign - (interactive button) Signs the certificate on click.

Certificate Manager


The Certificate Manager page displays information on all certificate and key files stored on the device and provides the possibility export these files for use on another machine or import files generated elsewhere.

Certificate Import


The Certificate Import section provides the possibility to import certificates and files generated on another machine. To upload such a file simply click 'Browse' and locate the file on your computer, it should then start uploading automatically.

Networking rutos manual administartion certificates certificates manager certificate import v3.png

Certificates, Keys & Requests


The Certificates, Keys and Requests section display files generated on or imported to the device along with the most important information related to them.

By default, the lists are empty. A set certificates generated using 'Simple' file type would look something like this:

Networking rutos manual administartion certificates certificates manager certificate list v2.png

The 'Export' buttons are used to download the files from the device onto your local machine. The 'X' buttons located to the right of each entry are used to delete related files.

Root CA


The Root CA section is used to add a root CA certificate file to the device. There is a default file already preloaded on the device which will be overwritten by any uploaded file. The certificates must be in .pem format, maximum file size is 300 KB. These certificates are only needed if you want to use HTTPS for your services and the default file should be sufficient in most cases.

Networking rutos manual administration access control root ca v1.png

Profiles

Summary

Configuration profiles provide a way to create multiple distinct device configuration sets and apply them to the device based on current user requirements. This chapter is an overview of the Profiles page in {{{name}}} devices.

Configuration Profiles

This section displays user defined configuration profiles:

Networking rutos manual profiles configuration profiles v2.png


To create a new profile, configure the device in accordance with your needs, go to this page, enter a custom name for the profile and click the 'Add' button. You can also choose to create a profile without any previous configurations. A new profile with the given name will appear in the "configuration profiles" list:

Networking rutos manual profiles configuration profiles add new profile v2.png

The 'Apply' button applies the adjacent configuration on the device.

Scheduler

The Profile Scheduler provides a possibility to set up a schedule of when the device should use one profile configuration or another.

Check Profile Scheduler Instance Example to get a better understanding at how Profile Scheduler Instances works.

General Configuration


The General Configuration section is used to enable the Scheduler itself. Created instances won't work unless this option is turned on.

Networking rutos manual profiles scheduler general configuration.png

Profile Scheduler Instances


The Profile Scheduler Instances section allows you to create profile Instances to be enabled during specific time intervals. To add a new Instance click Add button.

Note: new Instance can only be created if there is at least one custom profile created.

Networking rutos manual profiles scheduler profile scheduler instances.png

Profile Scheduler Instance Configuration

This page is used to configure profile, time and day of selected scheduler instance. Refer to the figure and table below for information on the Profile Scheduler Instance Configuration fields:

Networking rutos manual profiles scheduler profile scheduler instance configuration v2.png

Field Value Description
Enable off | on; default: off Enable selected instance for scheduler.
Profile profiles; default: none Select profile which will be applied during specified time interval.
Interval Type Weekdays | Month Days; default: Weekdays Depending on your needs select whether you want to configure weekdays or specific month days.
Start Time time; default: 12:00 Enter time of the start of interval in which scheduler will switch profiles.
End Time time; default: 12:00 Enter time of the end of interval in which scheduler will switch profiles back.
Interval Type: Weekdays
Start Day Weekday [Monday..Sunday]; default: Sunday Select a day of the start of interval in which scheduler will switch profiles.
End Day Weekday [Monday..Sunday]; default: Sunday Select a day of the end of interval in which scheduler will switch profiles back.
Interval Type: Month Days
Start Day Day of month [1..31]; default: 1 Select a day of the start of interval in which scheduler will switch profiles.
End Day Day of month [1..31]; default: 1 Select a day of the end of interval in which scheduler will switch profiles back.
Force last day off | on; default: off Force intervals to accept last day of month as valid option if selected day doesn't exist in ongoing month.
Profile Scheduler Instance Example

Scheduler will use profile instance if it is enabled and it's time interval matches device's [[{{{name}}}_Administration#General_2|date]], otherwise default profile will be used.

Example - we have 3 profiles in total:

  • default
  • Profile A
  • Profile B

We create profile instances for Profiles A and B:

  • Profile A: 08:00 - 11:00
  • Profile B: 13:00 - 20:00

During 11:00 - 13:00 and 20:00 - 08:00 default profile will be used.

Storage Memory Expansion

SSHFS


SSHFS is a tool, which allows you to mount a remote filesystem (in remote SSH server) to your {{{name}}} device using SSH. This service is safe to use as it authenticates connections and encrypts them.

SSHFS configuration consists of setting up authentication, port and mount information parameters. Below is an example oh the SSHFS configuration page.

Networking rutos manual sshfs v3.png

Field Value Description
Enable off | on; default: off Turns the SSHFS service on or off.
Hostname string; default: none Hostname of the remote SSH server.
Port integer [0..65535]; default: none Port of the remote SSH server.
Username string; default: none Username of the remote SSH server.
Password string; default: none Password of the remote SSH server.
Mount Point filepath; default: /sshmount Mount point of remote file system in the {{{name}}}. Remote file system has to be mounted at root / level. By default the remote file system will be mounted on /sshmount, directory will be automatically created if does not exist yet.
Mount Path filepath; default: /home/ Mount path in the remote SSH server. For example, if SSH server is hosted on Ubuntu operating system, the Mount Path could look like this (depending on your needs): /home/username/

[[Category:{{{name}}} System section]]