Template:Networking rutos manual package manager: Difference between revisions

From Teltonika Networks Wiki
No edit summary
No edit summary
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<!-- Template uses {{{name}}}, {{{series}}},  -->
{{Template: Networking_device_manual_fw_disclosure
{{Template:Networking_rutos_manual_fw_disclosure
| series = {{{series}}}
| fw_version = {{{series}}}_R_00.02.04.3
| name  = {{{name}}}
| series    = {{{series}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
}}
 
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Package Manager (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}}} Package Manager (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==


Line 15: Line 19:


==Packages==
==Packages==
===Package Restore===
----
The <b>Package Restore</b> section `Enable` or `Disable` automatic package installation function after firmware upgrade with keep settings.
[[File:Networking rutos manual package manager faq memory v2.png|border|class=tlt-border]]


The <b>Packages</b> section provides the possibility to install additional software  
===Package Manager===
packages that are available for download from the FOTA server. To install a new service,  
----
locate the necessary package in the list, click  
The <b>Package Manager</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, click the '+' button adjacent to it.
the '+' button adjacent to it and you will be redirected to [[#Verification|Verification]] page.


[[File:Networking_rutx_manual_packages_overview_v1.png|border|class=tlt-border]]
<b>Note</b>: Package Manager in your device might show different available packages, the picture below is just for demonstration:


===Available packages===
[[File:Networking_rutos_manual_package_manager_packages v2.png|border|class=tlt-border]]
----
Available additional software packages for {{{name}}} devices with latest firmware version are listed below.
<ul>
    <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. After installation, this service becomes available and can be configured from the Services → VPN → ZeroTier 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 Services → TR-069 page.</li>
    <li><b>The Cloud of Things</b> is 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 Services → Cloud Solutions → Cloud of Things page.</li>
    <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 Services → Cloud Solutions → Azure IoT Hub 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 Services → Cloud Solutions → Cumulocity 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 Services → Cloud Solutions → ThingWorx page.</li>
    <li><b>NTPD</b> - a program that maintains the system time in synchronization with time servers using the Network Time Protocol.<br>After installation, this service becomes available and can be configured from the Services → NTP → NTPD page.</li>
    <li><b>WireGuard</b> - a free and open source software application that implements virtual private network (VPN) to create a secure point-to-point connections.<br>After installation, this service becomes available and can be configured from the Services → VPN → WireGuard page.</li>
</ul>


==Upload==
==Upload==
Line 43: Line 39:


The list of available packages for {{{name}}} devices with latest firmware version can be found  
The list of available packages for {{{name}}} devices with latest firmware version can be found  
in the [[{{{name}}} Package Downloads|Package Downloads]] page.
in the [[{{{name}}} Package Downloads|Package Downloads]] page. Also it can be found by clicking on <b>''this repository''</b> link.


[[File:Networking_rutXxx_manual_packages_upload_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_package_manager_upload_v3.png|border|class=tlt-border]]


To install a package click the 'Browse' button and locate the package file on your computer.  
To install a package click the 'Browse' button and locate the package file on your computer.  
Then click 'Install package' and you will be redirected to [[#Verification|Verification]] page.  
Package should start uploading and a [[#Verification|Verification]] windows should soon appear.  
If you proceed with installation and successfully install the package, you should  
If you proceed with installation and successfully install the package, you should  
see a blue rounded rectangle containing a message of success in the bottom right of your screen:
see a pop-up containing a message of success in the top side of your screen:


[[File:Networking_rutx_manual_packages_success_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_package_manager_upload_success.png|border|class=tlt-border]]


==Verification==
==Verification==


When trying to install a package by either downloading it in [[#Packages|Packages]] page or uploading it  
When trying to install a package by uploading it  
in [[#Upload|Upload]] page you will be informed whether this package is <b>Authorized</b> - digitaly signed by  
in [[#Upload|Upload]] page you will be informed whether this package is <b>Authorized</b> - digitaly signed by  
Teltonika Networks, or <b>Unauthorized</b> - without digital signature. After that you will be able to proceed  
Teltonika Networks, or <b>Unauthorized</b> - without digital signature. After that you will be able to proceed  
Line 63: Line 59:
Below are pictures representing <b>Authorized</b> and <b>Unauthorized</b> packages respectively.
Below are pictures representing <b>Authorized</b> and <b>Unauthorized</b> packages respectively.


[[File:Networking_rutx_manual_packages_authorized_package_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_package_manager_authorized_package_v3.png|border|class=tlt-border]]


[[File:Networking_rutx_manual_packages_unauthorized_package_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_package_manager_unauthorized_package_v3.png|border|class=tlt-border]]


==FAQ==
==FAQ==
Line 71: Line 67:
<ul>
<ul>
     <li><b>Q:</b> How to keep installed packages after firmware upgrade?</li>
     <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 device will install the necessary packages after FW upgrade and keep user configuration data.</li>
     <li><b>A:</b> Before upgrading the device's firmware, make sure the 'Keep settings' option is checked in the [[{{{name}}} Firmware|Firmware]] page and `Package Restore` function is enabled in the [[{{{name}}} Package_Manager#Packages|Package Manager]]. This ensures that the device will install the necessary packages after FW upgrade and keep user configuration data.</li>
</ul>
</ul>


[[File:Networking_rutx_manual_packages_faq_keep_settings_v3.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_package_manager_faq_keep_settings v2.png|border|class=tlt-border]]


----
----
Line 83: Line 79:
     <li><b>A:</b> The size of each package is displayed next to its version in the package list. The current state of Flash memory is displayed in in the top-right corner of the list. Hover your mouse over it for more information.</li>
     <li><b>A:</b> The size of each package is displayed next to its version in the package list. The current state of Flash memory is displayed in in the top-right corner of the list. Hover your mouse over it for more information.</li>
</ul>
</ul>
[[File:Networking_rutx_manual_packages_faq_memory_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_package_manager_faq_memory v2.png|border|class=tlt-border]]


----
----
Line 90: Line 86:
<ul>
<ul>
     <li><b>Q:</b> I installed a software package, how do I configure it?</li>
     <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.</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. You can find a redirect to the configuration page by locating your package in the [[{{{name}}}_Services|Services]].</li>
</ul>
</ul>


Line 102: Line 98:
</ul>
</ul>


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

Latest revision as of 11:35, 22 July 2024

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


Summary

The Package Manager is a service used to install additional software on the the device. This page is an overview of the Package Manager section 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.

Packages

Package Restore


The Package Restore section `Enable` or `Disable` automatic package installation function after firmware upgrade with keep settings.

Package Manager


The Package Manager 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, click the '+' button adjacent to it.

Note: Package Manager in your device might show different available packages, the picture below is just for demonstration:

Upload

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

The list of available packages for {{{name}}} devices with latest firmware version can be found in the [[{{{name}}} Package Downloads|Package Downloads]] page. Also it can be found by clicking on this repository link.

To install a package click the 'Browse' button and locate the package file on your computer. Package should start uploading and a Verification windows should soon appear. If you proceed with installation and successfully install the package, you should see a pop-up containing a message of success in the top side of your screen:

Verification

When trying to install a package by 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.

FAQ

  • Q: How to keep installed packages after firmware upgrade?
  • A: Before upgrading the device's firmware, make sure the 'Keep settings' option is checked in the [[{{{name}}} Firmware|Firmware]] page and `Package Restore` function is enabled in the [[{{{name}}} Package_Manager#Packages|Package Manager]]. This ensures that the device will install the necessary packages after FW upgrade and keep user configuration data.



  • Q: Is there enough space for packages that I want to install?
  • A: The size of each package is displayed next to its version in the package list. The current state of Flash memory is displayed in in the top-right corner of the list. Hover your mouse over it for more information.



  • Q: I installed a software package, how do I configure it?
  • A: After the installation of a package, a related configuration page is generated somewhere in the WebUI, depending on the packages purpose. You can find a redirect to the configuration page by locating your package in the [[{{{name}}}_Services|Services]].




  • Q: The package that I want isn't on the list. Can I install it anyway?
  • A: Depends on what you need specifically. More packages can be downloaded using the opkg package manager. It is a command-line utility used to download software from special online repositories.
    Before using opkg you should first update the list of available packages by executing this command:
    opkg update
    To see a list of available packages, use this command:
    opkg list
    To install a package, use this syntax:
    opkg install <PACKAGE_NAME>

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