Skip to content

Commit 1181982

Browse files
mmerklingermmerklinger
authored
Describe update of the HMDM server and app (#461)
* Describe update of the HMDM server Signed-off-by: Markus Merklinger <markus@nitrokey.com> * Describe update of the HMDM launcher --------- Signed-off-by: Markus Merklinger <markus@nitrokey.com>
1 parent f3e4aa5 commit 1181982

File tree

3 files changed

+144
-0
lines changed

3 files changed

+144
-0
lines changed

‎source/components/nitrophone/headwind-mdm/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,7 @@ The software consists of a central interface (web panel) on a server and an app
1111
:glob:
1212

1313
Server Installation <server-installation>
14+
Server Update <server-update>
1415
Launcher App Installation <launcher-app-installation>
16+
Launcher App Update <launcher-app-update>
1517

‎source/components/nitrophone/headwind-mdm/launcher-app-update.rst

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
Launcher App Update
2+
-------------------
3+
4+
This document describes the update of the Headwind MDM (HMDM) launcher app on the mobile devices.
5+
6+
.. note::
7+
I you use the HMDM installation hosted by Nitrokey, you can skip to the chapter `Test the new launcher <#test-the-new-launcher>`__.
8+
9+
Prerequisits
10+
============
11+
12+
- Launcher installation files, provided by Nitrokey.
13+
- Administrative access to the web panel.
14+
15+
Update Launcher on the Web Panel
16+
================================
17+
18+
1. Log in to the web panel with the administrative user.
19+
2. Change to the "Applications" view.
20+
3. Search for the Package ID ``com.hmdm.launcher``.
21+
In the column **Actions**, click the **Versions** button.
22+
4. Click the **Add** button.
23+
5. In the field **Version** enter the version number, mentioned in the file name of the new launcher installation file.
24+
In the field **File** upload the launcher installation file.
25+
6. Click the **Save** button to persist the new version to the server.
26+
27+
Test the new Launcher
28+
=====================
29+
30+
1. Log in to the web panel with the administrative user.
31+
2. Change to the "Configurations" view.
32+
3. Search for the configuration you use for your production devices.
33+
In the column **Actions**, click the **Copy** button.
34+
4. Enter a name and description to indicate the test configuration.
35+
5. Click the **Save** button to persist the new configuration to the server.
36+
6. Search for the just created configuration.
37+
In the column **Actions**, click the **Edit** button.
38+
Change to the view "Applications".
39+
Search the row for the "Headwind MDM" ``com.hmdm.launcher``.
40+
In the column **Version** click on the version number.
41+
Select the latest version and click the **Apply** button.
42+
Click on the **Save and close** button.
43+
7. Change to the "Devices" view.
44+
8. Search for a device you want to test the new configuration with.
45+
In the column **Actions**, click the **Edit** button.
46+
9. In the field "Configuration", select the just created test configuration.
47+
10. Click the **Save** button to persist the new device configuration to the server.
48+
11. Renew the configuration on the device.
49+
Check that the launcher has been updated and started, and the device is up and running.
50+
12. Perform your testing.
51+
13. After the test, assign the test device to its original configuration again and delete the test configuration.
52+
53+
Push the Launcher to Mobile Devices
54+
===================================
55+
56+
1. Log in to the web panel with the administrative user.
57+
2. Change to the "Configurations" view.
58+
3. Search for the configuration you use for your production devices.
59+
In the column **Actions**, click the **Edit** button.
60+
Change to the view "Applications".
61+
Search the row for the "Headwind MDM" ``com.hmdm.launcher``.
62+
In the column **Version** click on the version number.
63+
Select the latest version and click the **Apply** button.
64+
Click on the **Save and close** button.
65+
4. The mobile devices will now automatically update the HMDM launcher.
66+
67+
Verify Update on Mobile Devices
68+
===============================
69+
70+
After a launcher app update has been pushed it should be verified that the mobile devices install the new version.
71+
The following instructions are helpful to get an overview of the versions installed on the mobile devices.
72+
This is especially helpful during a server update.
73+
74+
1. Log in to the web panel with the administrative user.
75+
2. Change to the "Devices" view.
76+
77+
Filter for Mobile Devices with a Version Number
78+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79+
80+
1. Click on **More parameters**.
81+
2. In the field **Launcher Version** enter the version number of the old launcher version.
82+
3. Click the **Search** button.
83+
4. The list of devices will now only show the devices which have the respective version installed.
84+
85+
Verify for Individual Mobile Devices
86+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87+
88+
1. Search for the device you want to get the installed launcher version for.
89+
In the column **Actions**, click the **More...** button and click **Detailed information**.
90+
2. You can see the installed launcher version for a device in the table **Installation status**.
91+
Search for the Package ID ``com.hmdm.launcher``, the column **Installed version** shows the currently installed version.
92+

‎source/components/nitrophone/headwind-mdm/server-update.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Server Update
2+
-------------
3+
4+
This document describes the update of an Headwind MDM (HMDM) server installation.
5+
Before you perform the update on the server, make sure your mobile devices run a compatible version of the HMDM launcher app.
6+
7+
.. important::
8+
An incompatible launcher app version can cause a loose of communication between the server and the mobile devices.
9+
To prevent this, update the launcher app on the mobile devices first.
10+
Please refer to chapter `Verify Update on Mobile Devices <launcher-app-update#Verify Update on Mobile Devices>`__ to learn more.
11+
12+
The installation files you can request from our support team.
13+
In case of an update only the WAR file for the application server is required.
14+
15+
1. Log on to the console of the HMDM server.
16+
17+
2. Create a directory for backups of the HMDM server configuration and application.
18+
19+
.. code-block::
20+
21+
mkdir /root/hmdm_backup_$(date --iso-8601)
22+
23+
.. important::
24+
You can use any directory to backup the files, just make sure to not use the configuration or application directories of the application server, e.g. ``/var/lib/tomcat9/*``.
25+
26+
3. Create a backup of the HMDM database.
27+
28+
.. code-block::
29+
30+
pg_dump -h 127.0.0.1 -U hmdm -W hmdm > /root/hmdm_backup_$(date --iso-8601)/db.sql
31+
32+
4. Create a backup of the HMDM server configuration.
33+
34+
.. code-block::
35+
36+
cp /var/lib/tomcat9/conf/Catalina/localhost/ROOT.xml /root/hmdm_backup_$(date --iso-8601)/ROOT.xml
37+
38+
5. Create a backup of the HMDM application.
39+
40+
.. code-block::
41+
42+
cp /var/lib/tomcat9/webapps/ROOT.war /root/hmdm_backup_$(date --iso-8601)/ROOT.war
43+
44+
6. Copy the received application archive to the the application server's webapps directory ``/var/lib/tomcat9/webapps/ROOT.war``.
45+
46+
7. Restart the application server with ``systemctl restart tomcat9.service``.
47+
48+
8. Check the web panel of the HMDM server for full functionality.
49+
If you encounter an HTTP error 404, restore the HMDM configuration file from the backup and restart the application server again.
50+

0 commit comments

Comments
 (0)