Difference between revisions of "Template:Networking rut manual package manager"

From Teltonika Networks Wiki
(61 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Template: Networking_rutxxx_manual_fw_disclosure
 
| fw_version = {{#switch: {{{series}}}
 
  | RUT2XX = {{{series}}}_R_00.01.14.3
 
  | RUT9XX = {{{series}}}_R_00.06.08.2}}
 
}}
 
 
__TOC__
 
__TOC__
 
==Summary==
 
==Summary==
  
The <b>Package Manager</b> is a service used to install additional software on the the device. This page is an overview of the Package Manager section in {{{name}}} routers.
+
This page is an overview of the Packages section of {{{name}}} routers.
  
==Packages==
+
{{Template: Networking_rutxxx_manual_fw_disclosure
 +
| fw_version = {{{fw_version}}}
 +
}}
  
The <b>Packages</b> section provides the possibility to install additional software packages that are available for download from the FOTA server. To install a new service, locate the necessary package in the list and click the 'Install' button adjacent to it.
+
==Package Manager==
  
[[File:{{{file_packages}}}]]
+
The <b>Package Manager</b> is a service used to install, upgrade or remove additional software.
  
===Available packages===
+
===Installed===
 
----
 
----
Available additional software packages for {{{name}}} routers are listed below.
+
The <b>Installed</b> section displays the names version numbers of software packages currently installed on the router. To remove an installed package click the 'Remove' button located next to it.
  
<ul>
+
Below is an example of the Installed section with the <i>zerotier</i> package installed.
    <li><b>Azure IoThub</b> - an open and flexible cloud platform that supports open-source SDKs and multiple protocols. <br>After installation, this service becomes available and can be configured from the <b>Services →  IoT Platforms → Azure IoThub</b> page.</li>
 
    <li><b>Cloud of Things</b> - a cloud platform for the Internet of Things. It allows you to remotely monitor, manage and control your connected devices and machines. <br>After installation, this service becomes available and can be configured from the <b>Services →  IoT Platforms → Cloud of Things</b> page.</li>
 
    <li><b>Cumulocity</b> - an independent device and application management Internet of Things (IoT) platform. <br>After installation, this service becomes available and can be configured from the <b>Services → IoT Platforms → Cumulocity</b> page.</li>
 
    <li><b>SNMP</b> - Simple Network Management Protocol (SNMP) is a network management protocol used to collect information from network devices. <br>After installation, this service becomes available and can be configured from the <b>Services → [[{{{name}}} SNMP|SNMP]]</b> page.</li>
 
    <li><b>ThingWorx</b> -an industrial innovation platform designed to rapidly deliver IoT applications. <br>After installation, this service becomes available and can be configured from the <b>Services → IoT Platforms → ThingWorx</b> page.</li>
 
    <li><b>TR-069</b> - Technical Report 069 (TR-069) client, an application layer protocol designed for management of equipment connected to a remote network. <br>After installation, this service becomes available and can be configured from the <b>Services → TR-069</b> page.</li>
 
    <li><b>UPNP</b> - UPNP (Universal Plug and Play) is a set of network protocols that allows devices in a network to discover one another automatically.br>After installation, this service becomes available and can be configured from the <b>Services → [[{{{name}}} UPNP|UPNP]]</b> page.</li>
 
    <li><b>WireGuard</b> - a fast, modern, simple and secure VPN tunnel. <br>After installation, this VPN becomes available and can be configured from the <b>Services → VPN → WireGuard</b> page.</li>
 
    <li><b>ZeroTier</b> - an open source software product which establishes Peer to Peer VPN (P2PVPN) connection between laptops, desktops, phones, embedded devices, cloud resources, and apps.<br>After installation, this service becomes available and can be configured from the <b>Services → VPN → [[{{{name}}} VPN#ZeroTier|ZeroTier]]</b> page.</li>
 
</ul>
 
  
==Upload==
+
[[File:{{{file_installed}}}]]
  
The <b>Upload</b> section provides the possibility for offline package installation.  
+
===Upgradable===
Only packages that are intended for this specific router and firmware version can be uploaded.
+
----
The list of available packages for {{{name}}} routers is provided in the <strong>[[{{{name}}} Package Downloads|Package Downloads]]</strong> page.  
+
The <b>Upgradable</b> section displays available upgrades for installed packages. Based on the availability of additional software in the current firmware version ({{{fw_version}}}), all packages in the [[{{{name}}}_Packages#Available|Available]] section are their latest version. Therefore, the Upgradable section currently displays an empty list:
  
[[File:{{{file_upload}}}]]
+
[[File:{{{file_upgradable}}}]]
  
 +
===Available===
 
----
 
----
To install a package click the 'Choose File...' button and locate the package
+
The <b>Available</b> section displays packages that are available to be downloaded from the FOTA server. Currently available packages are:
file on your computer. Then click 'Install package' and you will be redirected
 
to Verification page. If you proceed with installation and successfully install
 
the package, you should see a message of success:
 
  
[[File:{{{file_success}}}]]
+
<ul>
 +
    <li><b>zerotier</b> - ZeroTier One is an open source software product which establishes Peer to Peer VPN (P2PVPN) connection between laptops, desktops, phones, embedded devices, cloud resources, and apps.<br>After installation, this service becomes available and can be configured from the <b>Services → VPN → [[{{{name}}} VPN#ZeroTier|ZeroTier]]</b> page.</li>
 +
    <li><b>snmpd</b> - Simple Network Management Protocol (SNMP) is a network management protocol used to collect information from network devices.<br>After installation, this service becomes available and can be configured from the <b>Services → [[{{{name}}} SNMP|SNMP]]</b> page.</li>
 +
    {{#ifeq:{{{samba}}}|1|<li><b>samba36-server</b> - Samba is a software solution for using the Server Message Block (SMB) networking protocol, which provides shared file access between nodes on a computer network.<br>After installation, this service becomes available and can be configured from the <b>Services → [[{{{name}}} USB_Tools|USB Tools]]</b> page.</li>|}}
 +
    <li><b>miniupnpd</b> - UPnP (Universal Plug and Play) is a set of network protocols that allows devices in a network to discover one another automatically.br>After installation, this service becomes available and can be configured from the <b>Services → [[{{{name}}} UPNP|UPNP]]</b> page.</li>
 +
    <li><b>easycwmp</b> - installs TR-069 (Technical Report 069) client, an application layer protocol designed for management of equipment connected to a remote network.<br>After installation, this service becomes available and can be configured from the <b>Services → [[{{{name}}} TR-069|TR-069]]</b> page.</li>
 +
    <li><b>azure_iothub</b> - Azure IoT Hub is an open and flexible cloud platform that supports open-source SDKs and multiple protocols.<br>After installation, this service becomes available and can be configured from the <b>System → Administration → [[{{{name}}} _Administration#Azure_IoThub|Azure IoThub]]</b> page.</li>
 +
</ul>
 +
----
 +
To install an additional software package, click the 'Install' button located next to it:
  
Click 'Install package' and you will be redirected to package verification page.
+
[[File:{{{file_available}}}]]
  
==Verification==
+
If the installation was successful, you should see a green rounded rectangle containing a message of success appear above the package list:
  
When trying to install a package by either downloading it in Packages page or
+
[[File:{{{file_success}}}]]
uploading it in Upload page you will be informed whether this package is
 
Authorized - digitaly signed by Teltonika Networks, or Unauthorized - without
 
digital signature. After that you will be able to proceed with installation or cancel it.
 
  
Below are pictures representing Authorized and Unauthorized packages respectively.
+
===Pending===
 
+
----
[[File:Networking_rut9_manual_package_manager_authorized_package.png|border|class=tlt-border]]
+
The <b>Pending</b> section displays software packages that are still awaiting installation.
 
+
[[File:Networking_rut9_manual_package_manager_unauthorized_package.png|border|class=tlt-border]]
+
[[File:{{{file_pending}}}]]
  
==Custom package upload==
+
===Upload===
 
 
If you want to use your own packages and '''upload''' them to {{{name}}} via the Package Manager, you need to follow these instructions:
 
 
----
 
----
I. You need to use following name for you package in order to use/upload it via package manager, the name and format should be:
+
The <b>Upload</b> section provides the possibility for offline package installation. Only packages that are intended for this specific router and firmware version can be uploaded.
  
* '''tlt_custom_pkg_<''anyname''>.ipk'''
+
[[File:{{{file_upload}}}]]
 
 
II. You need to add following information to your package before you compile it:
 
 
 
* '''PKG_ROUTER:=<''Router''>'''
 
 
 
* '''PKG_FIRMWARE:=<''Routers firmware version''>'''
 
 
 
* '''PKG_TLT_NAME:=<''anything, could be name of the package''>'''
 
 
 
* '''PKG_VERSION_PM:=<''anything, could be package version''>'''
 
 
----
 
----
For example:
+
The list of available packages for {{{name}}} is provided below. Click on the links if you wish to download packages to your computer.
  
* ''tlt_custom_pkg_Test.ipk''
+
{{Template: Networking_rutxxx_manual_packages_supported
 
+
| zerotier  = {{{zerotier}}}
* ''PKG_ROUTER:=RUT9''
+
| snmpd    = {{{snmpd}}}
 
+
| samba    = {{{samba}}}
* ''PKG_FIRMWARE:=06.06.0''
+
| miniupnpd = {{{miniupnpd}}}
 
+
| easycwmp  = {{{easycwmp}}}
* ''PKG_TLT_NAME:=Test''
+
| azure    = {{{azure}}}
 
+
}}
* ''PKG_VERSION_PM:=1.0''
 
 
 
After you compile it you should be able to upload the package via package manager.
 
 
 
==FAQ==
 
 
 
<ul>
 
    <li><b>Q:</b> How to keep installed packages after firmware upgrade?</li>
 
    <li><b>A:</b> Before upgrading the device's firmware, make sure the 'Keep all settings' option is checked in the [[{{{name}}} Firmware|Firmware]] page. This ensures that the router will install the necessary packages after FW upgrade and keep user configuration data.<br>[[File:{{{file_keep_settings}}}]]</li>
 
</ul>
 
----
 
<ul>
 
    <li><b>Q:</b> Is there enough space for packages that I want to install?</li>
 
    <li><b>A:</b> The size of each package is displayed next to its version in the package list. The current state of Free/Total memory usage is displayed in in the top-right corner of the list.<br>[[File:{{{file_memory}}}]]</li>
 
</ul>
 
----
 
<ul>
 
    <li><b>Q:</b> I installed a software package, how do I configure it?</li>
 
    <li><b>A:</b> After the installation of a package, a related configuration page is generated somewhere in the WebUI, depending on the packages purpose. Information on where to find each page can be found in the <b>[[{{{name}}}_Package_Manager#Available_packages|Available packages]]</b> section of this Wiki page and related configuration guides can be found in the <b>[[{{{name}}}_Package_Manager#See_also|See also]]</b> section below.</li>
 
</ul>
 
 
----
 
----
<ul>
+
To install a package click the 'Browse...' button and locate the package file on your computer. Then click 'Install package'. If the installation was successful, you should see a green rounded rectangle containing a message of success appear Package Manager title:
    <li><b>Q:</b> The package that I want isn't on the list. Can I install it anyway?</li>
 
    <li><b>A:</b> Depends on what you need specifically. More packages can be downloaded using the <b>opkg package manager</b>. It is a [[Command line interfaces|command-line]] utility used to download software from special online repositories.<br>Before using <i>opkg</i> you should first update the list of available packages by executing this command: <pre>opkg update</pre>To see a list of available packages, use this command:<pre>opkg list</pre>To install a package, use this syntax: <pre>opkg install <PACKAGE_NAME></pre></li>
 
</ul>
 
  
==See also==
+
[[File:{{{file_success}}}]]
 
 
<ul>
 
    <li><b>Related configuration examples</b>
 
        <ul>
 
            <li>[[Azure_IoT_Hub_cloud_connection|Azure IoThub]]</li>
 
            <li>[[Cumulocity]]</li>
 
            <li>[[ThingWorx]]</li>
 
            <li>[[ZeroTier_One_VPN_configuration|ZeroTier]]</li>
 
        </ul>
 
    </li>
 
</ul>
 
  
[[Category:{{{name}}} System section]]
+
[[Category:{{{name}}} WebUI]]

Revision as of 10:13, 19 July 2019

Summary

This page is an overview of the Packages section of {{{name}}} routers.

The information in this page is updated in accordance with the [[Media:{{{fw_version}}}_WEBUI.bin|{{{fw_version}}}]] firmware version.

Package Manager

The Package Manager is a service used to install, upgrade or remove additional software.

Installed


The Installed section displays the names version numbers of software packages currently installed on the router. To remove an installed package click the 'Remove' button located next to it.

Below is an example of the Installed section with the zerotier package installed.

[[File:{{{file_installed}}}]]

Upgradable


The Upgradable section displays available upgrades for installed packages. Based on the availability of additional software in the current firmware version ({{{fw_version}}}), all packages in the [[{{{name}}}_Packages#Available|Available]] section are their latest version. Therefore, the Upgradable section currently displays an empty list:

[[File:{{{file_upgradable}}}]]

Available


The Available section displays packages that are available to be downloaded from the FOTA server. Currently available packages are:

  • zerotier - ZeroTier One is an open source software product which establishes Peer to Peer VPN (P2PVPN) connection between laptops, desktops, phones, embedded devices, cloud resources, and apps.
    After installation, this service becomes available and can be configured from the Services → VPN → [[{{{name}}} VPN#ZeroTier|ZeroTier]] page.
  • snmpd - Simple Network Management Protocol (SNMP) is a network management protocol used to collect information from network devices.
    After installation, this service becomes available and can be configured from the Services → [[{{{name}}} SNMP|SNMP]] page.
  • miniupnpd - UPnP (Universal Plug and Play) is a set of network protocols that allows devices in a network to discover one another automatically.br>After installation, this service becomes available and can be configured from the Services → [[{{{name}}} UPNP|UPNP]] page.
  • easycwmp - installs TR-069 (Technical Report 069) client, an application layer protocol designed for management of equipment connected to a remote network.
    After installation, this service becomes available and can be configured from the Services → [[{{{name}}} TR-069|TR-069]] page.
  • azure_iothub - Azure IoT Hub is an open and flexible cloud platform that supports open-source SDKs and multiple protocols.
    After installation, this service becomes available and can be configured from the System → Administration → [[{{{name}}} _Administration#Azure_IoThub|Azure IoThub]] page.

To install an additional software package, click the 'Install' button located next to it:

[[File:{{{file_available}}}]]

If the installation was successful, you should see a green rounded rectangle containing a message of success appear above the package list:

[[File:{{{file_success}}}]]

Pending


The Pending section displays software packages that are still awaiting installation.

[[File:{{{file_pending}}}]]

Upload


The Upload section provides the possibility for offline package installation. Only packages that are intended for this specific router and firmware version can be uploaded.

[[File:{{{file_upload}}}]]


The list of available packages for {{{name}}} is provided below. Click on the links if you wish to download packages to your computer.


To install a package click the 'Browse...' button and locate the package file on your computer. Then click 'Install package'. If the installation was successful, you should see a green rounded rectangle containing a message of success appear Package Manager title:

[[File:{{{file_success}}}]]

[[Category:{{{name}}} WebUI]]