Product SiteDocumentation Site

6.4. Zarafa Windows Client Updater

ZCP contains a mechanism that allows Zarafa Windows Clients to update themselves to the latest version.

Note

The Zarafa Windows Client Updater is only available to those running the ZCP Professional or Enterprise edition.
Auto-update structure
Figure 6.7. Auto-update structure

Restrictions:

6.4.1. Server-side configuration

The Zarafa Windows Client Updater can be enabled by setting the following setting to yes in the server.cfg of the zarafa-server:
client_update_enabled = yes
When a zarafa-server is upgraded, it will copy the latest updated client installer to the path which is specified in the server configuration file server.cfg, As shown below.
client_update_path = /var/lib/zarafa/client
The updates at the client update folder follow a naming convention. The Zarafa Server will work only with those updates that adhere to this convention:
zarafaclient-<major version>.<minor version>.<update number>-<build number>.msi
For example zarafaclient-6.40.0-19050.msi is a valid name of an update.
Based on this naming convention the Zarafa Windows Client Updater finds out if an update of the client is available. If a suitable version is available for a client, zarafa-server will send the update to the client machine to update itself with the latest client version.
By default clients communicate with the server over HTTP on port 236 (HTTPS on port 237), unless a non-default port is specified in the server.cfg. Clients send a request to download a virtual file, which provides the most current version of the client available on the server.
The client communicates with the server using an encrypted message format. This prevents misuse of this mechanism for any malicious intent.

Note

If the default profile is set to use encryption via port 237, the root CA certificate needs to be installed on the desktop used.

6.4.2. Client-side configuration

The Zarafa Windows Client’s auto-update mechanism consists of an application to start the auto-update process by the name of ZarafaLaunchUpdater.exe and a windows service known as ZarafaUpdaterService.exe.
Auto-update structure
Figure 6.8. Auto-update structure

The Launch Updater application will be launched at Windows' startup. The command to run the application is placed in the registry here:
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Run.
This application will find out client’s current version from the following registry key.
HKEY_LOCAL_MACHINE\Software\Zarafa\Client\Version
This is a new registry key introduced for updater mechanism, it will contain the version of the Zarafa Windows Client installed on the machine.
The Launch Updater application will read default Outlook profile from the registry to gather the credentials needed to connect to the Zarafa Server. It informs the Zarafa Server which version of the Zarafa Windows Client is running, the Zarafa Server responds with a newer Zarafa Windows Client in case that exists.

6.4.2.1. Zarafa Updater Service

The zarafa updater service runs as a local system account. Therefore, it has all the needed privileges to install the Zarafa Windows Client on the desktop.
Services
Figure 6.9. Services

The zarafa updater service will wait on a pipe for Zarafa launch updater application to send it the current version of the client and the details of the Zarafa Server to connect to. If there is a suitable update, the service downloads it to c:\windows\temp\zarafaclient.msi. The zarafa updater service launches this update for installation in a silent mode.
Although, the entire update process is silent, logs can be generated for troubleshooting. To generate logs the updater service startup parameter needs to have -v option, similarly for the launcher the registry key needs to have the variable --v. The Updater service log will be written in the All users\Application data\ directory and the Launch updater log will be written in the <user>\Application data\ directory.

Note

The client will only find updates successfully if the default Outlook profile is configured to work with a Zarafa Server, and if updates are available at that server. Even with the setting to `prompt for the profile to be used' the Zarafa Windows Client Updater will succeed provided the (greyed out) drop-down menu specifies the profile configured for Zarafa. Please refer to the User manual on how to configure Outlook profiles.

6.4.3. MSI Options

If you rather push the zarafa client installation from your Windows Domain server, you probably want the installation not to install the Zarafa Updater Service. The following options can be used to achieve that:
ADDDEFAULT="Client"
This will make the installer only install the Outlook Client part, and not the Updater Service. To install this feature too, add Updater to this option.
APPDIR=D:\Zarafa\Client
To change the default installation path, use the APPDIR variable. Leave this option to normally install in the "Program Files" directory.
/q
Make the installation quiet. No graphical interface will be shown. To show progress of the installation, use the modifier b (for basic gui) or r (for reduced gui). If you show the full gui (f modifier), it will be interactive.
Run msiexec to see a list of other options that can be used. For a typical automated installation, use the following command:
msiexec /i zarafaclient-en.msi ADDDEFAULT=Client /q

Note

For an automated installation, you must use the zarafaclient-en.msi file. This installer contains the English language only, and is specially created for this feature.