Jump to content

Template:Networking rutos manual usb tools: Difference between revisions

no edit summary
No edit summary
No edit summary
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.06.1
| series = {{{series}}}
| series     = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
}}
{{#ifeq: {{{legacy}}} | 1 |<br><i><b>Note</b>: <b>[[{{{name}}} USB Tools (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT9XX_R_00.06.08.2 and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} USB Tools (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>|}}
__TOC__
==Summary==
==Summary==


Line 31: Line 34:
The <b>Mounted File Systems</b> list displays USB mass storage devices (MSD) currently attached to this device.
The <b>Mounted File Systems</b> list displays USB mass storage devices (MSD) currently attached to this device.


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


<table class="nd-mantable">
<table class="nd-mantable">
Line 40: Line 43:
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Filesystem</td>
       <td>Device</td>
       <td>filepath; default: <b>/dev/sd*</b></td>
       <td>filepath; default: <b>/dev/sd*</b></td>
       <td>The filesystem of the attached USB MSD.</td>
       <td>The filesystem of the attached USB MSD.</td>
Line 66: Line 69:
</table>
</table>


The '<b>Unmount</b>' button next to each entry in the list is used to unmount an attached USB device. Please make sure to unmount a USB device before physically detaching it from the {{{name}}}.
The <b>Format</b> button can be used to format the attached device, and the <b>Unmount</b> button next to each entry in the list is used to unmount an attached USB device. Please make sure to unmount a USB device before physically detaching it from the {{{name}}}.
 
The <b>Refresh</b> is used to refresh the information in the Mounted File Systems list. If you attach a new USB device and cannot see it in the list, try clicking the 'Refresh' button.
 
'''Note:''' Usb with NTFS partition is supported in read-only mode.


The '<b>Refresh</b>' is used to refresh the information in the Mounted File Systems list. If you attach a new USB device and cannot see it in the list, try clicking the 'Refresh' button.
[[File:Networking_rutos_manual_usb_tools_general_ntfs.png|border|class=tlt-border]]


{{#ifeq:{{{printer}}}|0||
{{#ifeq:{{{printer}}}|0||
Line 106: Line 113:
     </tr>
     </tr>
</table>
</table>
 
{{#ifeq:{{{series}}}|RUTM||For step-by-step instructions on how to use a printer with {{{name}}}, <b>[[How to set up a USB printer (Windows, {{{name}}})|click here]].</b>|}}
For step-by-step instructions on how to use a printer with {{{name}}}, <b>[[How to set up a USB printer (Windows, {{{name}}})|click here]].</b>
}}
}}
{{#ifeq:{{{serial}}}|0||
{{#ifeq:{{{serial}}}|0||
Line 160: Line 166:
             <ul>
             <ul>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
             </ul>
             </ul>
         </td>
         </td>
Line 355: Line 361:
</table>
</table>
}}
}}
==Storage Memory Expansion==


The <b>Storage Memory Expansion</b> function provides the possibility to expand the device's flash memory 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.
===IP Filter===
 
----
To be eligible for memory expansion, the USB MSD must meet the following restrictions.
The <b>IP Filter</b> section is used for configuring which network is allowed to communicate with the device. You may add a new instance by selecting the Interface and pressing Add.
 
<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===
[[File:Networking_rutos_manual_console_ip_filter.png|border|class=tlt-border]]
----
To successfully expand the flash memory of your device follow the steps described below.


<ol>
Then enter the IP address and save.
    <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>


===Disabling memory expansion===
[[File:Networking_rutos_manual_console_ip_filter_instance.png|border|class=tlt-border]]
----
To successfully disable memory expansion follow the steps described below.


<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>
{{#ifeq:{{{shares}}}|0||
{{#ifeq:{{{shares}}}|0||
==Network Shares==
==Network Shares==
Line 412: Line 380:
     <li>FAT</li>
     <li>FAT</li>
     <li>FAT32</li>
     <li>FAT32</li>
    <li>exFAT</li>
     <li>NTFS</li>
     <li>NTFS</li>
    <li>ext2</li>
    <li>ext3</li>
    <li>ext4</li>
</ul>
</ul>
{{#switch:{{{series}}}
|RUTX|RUTM=
|#default=
<u><b>


Note:</b> Network Shares is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.
</u>}}
===General Settings===
===General Settings===
----
----
The <b>General</b> section is used to set up <b>Samba</b> - a software solution for using the Server Message Block (SMB) networking protocol, which provides shared file access between nodes on a computer network. Refer to the figures and table below for more information about Samba configuration.  
The <b>General</b> section is used to set up <b>Samba</b> - a software solution for using the Server Message Block (SMB) networking protocol, which provides shared file access between nodes on a computer network. Refer to the figures and table below for more information about Samba configuration.  


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


<table class="nd-mantable">
<table class="nd-mantable">
Line 451: Line 429:
         <td>off {{!}} on; default: <b>on</b></td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>Allows system users to reach their home directories via network shares.</td>
         <td>Allows system users to reach their home directories via network shares.</td>
    </tr>
    <tr>
        <td>Interfaces</td>
        <td>lan; default: <b>none</b></td>
        <td>Bind samba server to specified interfaces </td>
    </tr>
    <tr>
        <td>Insert custom configuration to config</td>
        <td>string; default: <b>none</b></td>
        <td>Insert custom line to configuration file.</td>
     </tr>
     </tr>
</table>
</table>
===Edit Template===
----
The <b>Edit Template</b> section is used to make modifications to the template that is used for generating the Samba configuration. This is the content of the <i>/etc/samba/smb.conf.template</i> file from which your Samba configuration will be generated. Values enclosed by pipe symbols ('{{!}}') should not be changed. They get their values from the 'General Settings' tab.
[[File:Networking_rutos_manual_usb_tools_network_shares_general_samba_edit_template.png|border|class=tlt-border]]
===Format USB===
----
The <b>Format USB</b> section contains only one button that is used for formatting an attached USB drive.
[[File:Networking_rutos_manual_usb_tools_network_shares_general_samba_format_usb.png|border|class=tlt-border]]


===Shared Directories===
===Shared Directories===
Line 544: Line 520:
[[File:Networking_rutos_manual_usb_tools_network_shares_users_user_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_network_shares_users_user_settings.png|border|class=tlt-border]]
}}
}}
==DLNA==
The <b>Digital Living Network Alliance (DLNA)</b> standard provides the possibility to stream media files from local storage to DLNA-capable devices such as computers, Smart TVs, tablets, etc.
This page is used to configure the DLNA service on the device. When the DLNA service is enabled, the device listens for incoming connections on the specified network interface and port number. Clients connecting to that port number on that interface will be granted access to the media files residing in the specified directories.
DLNA devices use Universal Plug and Play (UPnP) to discover and communicate with each other on a network. To access the DLNA server hosted on this device you will need a DLNA-capable application. If you're using your phone or other mobile device, simply search for DLNA in the device's application store. On Linux and Windows computers you can use applications capable of playing network media streams (such as VLC). Smart TVs and similar devices may have DLNA support built-in by default.
File format types supported by the DLNA service on this device:
<ul>
    <li>Audio - WMA, WAV, MP3, FLAC</li>
    <li>Image - JPEG</li>
    <li>Video - WMV, MTS, MP4, MKV, MOV</li>
</ul>
<u><b>
Note:</b> DLNA is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
===General Settings===
----
[[File:Networking_rutos_manual_dlna_general_settings.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>off</b></td>
      <td>Turns the DLNA service on or off.</td>
    </tr>
    <tr>
      <td>Port</td>
      <td>integer [0..65535]; default: <b>8200</b></td>
      <td>DLNA service listening port.</td>
    </tr>
    <tr>
      <td>Friendly name</td>
      <td>string; default: <b>Teltonika DLNA Server</b></td>
      <td>The name of this server as it will be displayed to clients.</td>
    </tr>
    <tr>
      <td>Root container</td>
      <td>Standard container | Browse directory | Music | Video | Pictures; default: <b>Standard container</b></td>
      <td>Specifies which type of files will be made available in DLNA file sharing.
            <ul>
                <li><b>Standard container</b> - allows browsing the shared media directory but also organizes files by type (music, video, pictures).</li>
                <li><b>Browse directory</b> - allows browsing the shared media directory .</li>
                <li><b>Music, Video, Pictures</b> - only shares the files of the specified type.</li>
            </ul>
        </td>
    </tr>
    <tr>
      <td>Media directories</td>
      <td>filepath(s); default: <b>/mnt</b></td>
      <td>A list of directories that will be scanned by the DLNA service and made available to clients. You can also specify what types of files should be displayed from the directy. Use 'A' for audio, 'V' for video, 'P' for images followed by a comma and the path to the directory. For example:
            <ul>
                <li><i>A,/mnt</i> - share only audio files from the <i>/mnt/sda1</i> directory.</li>
                <li><i>V,/mnt</i> - share only video files from the <i>/mnt/sda1</i> directory.</li>
                <li><i>P,/mnt</i> - share only image files from the <i>/mnt/sda1</i> directory.</li>
            </ul>Click the plus symbol to add more directories.
        </td>
    </tr>
    <tr>
      <td>Album art names</td>
      <td>filename(s); default: <b>Album.jpg</b></td>
      <td>Name of the file(s) to check when searching for album art images. Click the plus symbol to specify more file names.</td>
    </tr>
</table>
===Advanced Settings===
----
[[File:Networking_rutos_manual_dlna_advanced_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Interfaces</td>
      <td>network interface; default: <b>br-lan</b></td>
      <td>Network interface(s) on which this DLNA server will be hosted.</td>
    </tr>
    <tr>
      <td>Database directory</td>
      <td>filepath; default: <b>/var/run/minidlna</b></td>
      <td>The directory where DLNA will store its database and album art cache.</td>
    </tr><!--
    <tr>
      <td>Log directory</td>
      <td>filepath; default: <b>/var/log</b></td>
      <td>The directory where DLNA will store its log file.</td>
    </tr>
--> <tr>
      <td>Enable inotify</td>
      <td>off | on; default: <b>on</b></td>
      <td>Turns inotify on or off. Inotify is a Linux kernel subsystem that notices changes to the filesystem and reports on these changes to applications, in this case, the DLNA service.</td>
    </tr>
    <tr>
      <td>Enable TIVO</td>
      <td>off | on; default: <b>off</b></td>
      <td>Turn support for streaming .jpg and .mp3 files to a TiVo supporting HMO on or off.</td>
    </tr>
    <tr>
      <td>Strict to DLNA standard</td>
      <td>off | on; default: <b>off</b></td>
      <td>Set this to strictly adhere to DLNA standards. Turning this on will allow server-side downscaling of very large JPEG images, which may hurt JPEG serving performance on (at least) Sony DLNA products.</td>
    </tr>
    <tr>
      <td>Notify interval</td>
      <td>integer; default: <b>900</b></td>
      <td>Notify interval in seconds.</td>
    </tr>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]