====== v3.3 Gateway Software Release ======

<note important> This version is designed to connect Kerlink products except the Wirnet Station to **WMC server 3.2 or greater** \\
They are not intended to be used with WMC servers 2.3, 3.0 or 3.1.</note>

\\
===== Download =====

^  Product                                                ^  Package                                                 ^   md5sum      ^                         
|  **All products except Wirnet Station**                   |   {{ :wiki3:WMC_embedded_keros_v3.3.5.tar.gz |}}         |  0696a403d25d2a1739c263cea0ecc875 |
| **Wirnet Station** | {{ :wiki3:fwupgrade_wirmav2_wirnet_v3.6_wmc_v3.1.6.tar.gz | fwupgrade_wirmav2_wirnet_v3.6_wmc_v3.1.6.tar.gz}}  | b74737609413bb65b5f68716568da150 |
\\
For the **Wirnet Station**, the 3.1 Software release must be used to connect a Wirnet Station to the WMC server v3.x. 
\\
\\
The content of this package is listed below:

For **all products except the Wirnet Station**:
^Component ^Version ^	
| **keros**	| 4.2.2    |
| **bscc**	| 3.3.3    |
| **lorasnmp**  | 3.3.2    |
| **lorad**	| 1.2.2-2  |
| **lorafwd**	| 1.1.2-1  |
| **OpenVPN** | 4.3 |


For the **Wirnet Station**:
^Component ^Version ^	
| **keros**	| 3.6    |	
| **bscc**	| 3.1.6    |	
| **lorasnmp**  | 3.1.4    |	
| **lorad**	| 1.0.5-2  |	
| **lorafwd**	| 1.0.7-2  |
| **OpenVPN**	| 3.1  |
	
\\
There are 3 ways to update your gateway's software:
  * by using the [[.magic_link|Magic link]]
  * by using an [[.gateway_sw_3.3#software_update_over_usb|USB stick]]
  * by using an [[.gateway_sw_3.3#software_update_over_ethernet|Ethernet connection (SSH)]]
  * over WMC dashboard, by using the [[wiki:wiki3:install_upgrade#wmc_drag_n_drop_feature|Drag and drop feature]]
\\
\\
===== Software update over ethernet =====
\\
This procedure can be used to **UPGRADE from a KerOS 4.x system** on a **single** gateway. \\

To update your gateway, apply the following procedure:
  - Request your VPN package(s) to the Kerlink Support team: [[support@kerlink.fr]] (optional: in case of a First Install or Migration)
  - Transfer package(s) in this directory: <code bash>
# From a computer:
scp WMC_embedded_keros_v3.3.5.tar.gz openvpn-*.ipk root@<ip_address>:/user/.updates/
</code>
  - Deflate archive and ensure file is correctly written: <code bash># On the gateway:
cd /user/.updates
tar -xzf *.tar.gz
rm -f WMC*.tar.gz
sync </code>
  - Trigger Update for next reboot: <code bash>kerosd -u </code>
  - Restart: <code bash>reboot</code>

\\
Refer to [[http://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:sw_updates#software_update_over_network|software update procedure]] for further details.

\\
===== Software update over USB ===== 
\\
==== For all products except the Wirnet Station ====
\\
This procedure used for automatic deployment can be used to **UPGRADE from a KerOS 4.x system** (embedded software 3.1.x) on a **single** or a **group of gateways**. \\
If you want to install this sotfware from a KerOS 3.x, you need to install a KerOS 4.0 before upgrading your system. 


**You need to use 1 or 2 USB sticks depending on your FW version **. \\ \\
 **If your KerOS version is lower than 4.0 then you will need to create 2 USB sticks.** \\


^                   ^     FW 3.1        ^    FW 3.4     ^    FW 4.0  ^    FW 4.1   ^ 
| Nb of USB sticks    |     2     |     2        |    1        |    1    |    

When using 2 USB sticks: \\
 
  * The **first USB stick** will upgrade the firmware to **KerOS 4.2**. 
  * The **second USB stick** will **install all others packages** with the required release: BSCC, SNMP, Common Packet Forwarder (CPF) and OpenVPN packages.

When using a single USB Stick: \\

  * Put the file .tar.gz on your USB stick and decompress all the stuff in the root directory.

To update your system from a KerOS 4.x system, use the following software:

^description                 ^file        ^md5sum      ^
|**USB stick ** | {{ wiki3:auto_deploy_3.3.5_keros_usb_stick.tar.gz | AUTO_DEPLOY_3.3.5_KEROS_USB_STICK.tar.gz }} |  b1a144d2cf9ec866b4c6fd97f44a2c7c  |
The same USB stick can be used twice.

**The .tar.gz file provided below is "ready-to-use"**. 
You only need to copy your OpenVPN packages on the USB stick: your OpenVPN secrets files in //vpn_packages// directory and your OpenVPN config file in the //COMMON// directory to be able to connect properly to your WMC server.

\\
To update your gateway, apply the following procedure :

> 1. Deflate twice the tar.gz file to get .ipk files and put them on your USB stick in the root directory
> 2. Copy all files located in the folder AUTO_DEPLOY_3.2.5_KEROS_USB_STICK in the root directory
> 3. Request your VPN package(s) to the Kerlink Support team: [[support@kerlink.fr]] (optional: in case of a First Install or Migration)
> 4. Put your VPN config packages in the //COMMON// directory to connect to YOUR WMC server (optional: in case of a First Install or Migration)
> 5. Put your VPN secrets packages of your KerOS products in the //vpn_packages// directory (optional: in case of a First Install)
> 6. Plug the USB stick in the gateway USB slot (device must be powered on)
> 7. Wait the end of the update 
> 8. Plug the second USB stick in the gateway USB slot (if needed)
> 9. Wait the end of the update (if needed)

Refer to the specific wiki to get more details about software update over USB: \\ 
**Wirnet Product Line (iBTS, iFemtocell, iStation)**: [[http://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:keros_custo:sw_updates#software_update_over_usb]] \\
\\
\\
==== For the Wirnet Station ====

The update procedure uses 2 USB sticks: \\
 
  * The **first USB stick** will upgrade the firmware to **KerOS 3.6.** 
  * The **second USB stick** will install **all others packages** with the required software release: BSCC, SNMP, Common Packet Forwarder (CPF) and OpenVPN packages.

^description                 ^file        ^md5sum      ^
|**USB stick number 1** | {{:wiki3:auto_deploy_3.1.6_usb_stick_1.tar.gz | AUTO_DEPLOY_3.1.6_USB_STICK_1.tar.gz}} | 6c31bebc9f2942bb852adecd74a57284 |
|**USB stick number 2** | {{:wiki3:auto_deploy_3.1.6_usb_stick_2_bis.tar.gz | AUTO_DEPLOY_3.1.6_USB_STICK_2.tar.gz}} | 458c2c2c8684e732e3fb9023d3e4fa43 |

> 1. Deflate twice the tar.gz file on each USB stick in the root directory
> 2. Copy files located in the folder AUTO_DEPLOY_3.1.6_USB_STICK_x in the root directory
> 3. Add your OpenVPN packages in AUTO_DEPLOY_3.1.6_USB_STICK_2 before plugging the stick into the system.
> 4. Plug the first USB stick in the gateway USB slot
> 5. Wait the end of the update
> 6. Plug the second USB stick in the gateway USB slot
> 7. Wait the end of the update



Refer to the specific wikis to get more details (ex led management) about software update via USB sticks: \\ \\
Wirnet Station: [[http://wikikerlink.fr/lora-station/doku.php?id=wiki:updates#usb_update_recommended]]
\\
\\

==== USB stick content ====

The USB tree should contains the following files/folders:

<code>
/               
├── COMMON                                                # KerOS products packages folder (iBTS, iFemtoCell, iStation)
│   ├── keros_***_klkgw.ipk                               # Keros firmware package for Wirnet iBTS
│   ├── bscc_***_klkgw.ipk                                # WMC BSCC package for Wirnet iBTS
│   ├── lorasnmp_***_klkgw.ipk                            # WMC SNMP package for Wirnet iBTS
│   ├── lorad_***_klkgw.ipk                               # HAL package for Wirnet iBTSpk
│   ├── lorafwd_***_klkgw.ipk                             # Packet Forwarder package for Wirnet iBTS
│   └── openvpn_config_wmcbeta.wanesy.com_3.1.ipk         # sample file: the WMC server to connect to
├── README.txt                                            # This file
├── usb.autorun                                           # executed by KerOs products when plugging the USB stick
├── usbkey.txt                                            # USB key protection: must contain the device passwords (all of them)
└── vpn_packages                                          # WMC OpenVPN packages folder
    ├── openvpn_secrets_***_wmcbeta.wanesy.com_***.ipk            # OpenVPN package for one KerOS product to connect to a WMC platform (here wmcbeta)
    ├── openvpn_secrets_***_wmcbeta.wanesy.com_***.ipk            # another package for one KerOS product to connect to a WMC platform (here wmcbeta)
    ├── openvpn_secrets***_wmcbeta.wanesy.com_***.ipk             # ...
    ├── openvpn_secrets_***_wmcbeta.wanesy.com_***.ipk            # ...
    ├── openvpn_secrets_***_wmcbeta.wanesy.com_***.ipk            # ...
    ├── openvpn_secrets_***_wmcbeta.wanesy.com_***.ipk            # ...
    └── openvpn_secrets_***_wmcbeta.wanesy.com_***.ipk            # ...

</code>
\\
\\
\\


===== Changelog =====

Main changes regards to the 3.2 embedded software release are listed below:

  * iFemtocell-Evolution gateway support
  * Backhaul configuration improvement
  * Spectral scan improvement on iStation and iFemtocell-Evolution
  * Power management improvement
  * Allow Internet access while connected to WMC

 
Please note that, if gateways use public IP, it also makes your gateway accessible from Internet on open SSH or HTTP ports (protected by passwords). Kerlink so recommends to change passwords as described in [[https://wikikerlink.fr/wirnet-productline/doku.php?id=wiki:systeme_mana:connection_credentials|Connection, login and credentials]]
\\
\\
===== Warranty =====

<note important>
**CAUTION ABOUT WARRANTY:** \\
**Kerlink is not responsible for damages resulting from failure to follow these instructions relating to the Kerlink Product’s use.**
</note>