ZeXtras Suite Installation Guide

From ZeXtras Suite Wiki

	Power to your Zimbra
	Latest Version: 1.2.7
	Released on: April 28th, 2012
	Compatibility List

Basic informations

Prerequisites

No additional software beyond what's required by a standard Zimbra deployment is necessary in order to install ZeXtras Suite.

Where to get the ZeXtras Suite package

Go to the download page on www.zextras.com or simply use wget directly from your server:

wget http://www.zextras.com/download/zextras_suite-latest.tgz

(this URL will always point at the latest release of ZeXtras Suite)

Components

ZeXtras Suite is comprised of two major components:

• ZeXtras Suite Core, abbreviated as ZeXtras Core or Core, which is a jar package extending Zimbra
• ZeXtras Suite Administrative Zimlet, abbreviated as ZeXtras Suite Zimlet or just Zimlet, an administrative zimlet which accesses and manages the Core.

The installation script follows the aforementioned structure allowing you three installation targets: core, zimlet and all . The latter is equivalent of installing core and immediately afterwards zimlet .

Below the various combinations are explained in detail.

TL;DR

• Download ZeXtras Suite on your server
• As ROOT, unpack the file you just downloaded inside a directory (we suggest in /root/) in your Zimbra server.
• Enter the directory created by the unpacking of the file.
• Run the install.sh script with the "all" option (so ./install.sh all).

ZeXtras Suite Installation tutorial video

Detailed Installation & Setup informations

Installing ZeXtras Suite on a Multistore Environment

ZeXtras Suite installation in a Multistore environment is no different from a standard installation.

However, you must keep in mind the following rules to install ZeXtras Suite in a Multistore environment:

RULE 1: ZeXtras Suite must be installed in ALL the store servers (the ones with the mailboxd service running).

RULE 2: Install ZeXtras Suite on your servers one by one. Installing on multiple servers at the same time may clog your logs with errors.

RULE 3: If your LDAP Master Server is also a Mailbox server, RULE 2 becomes DOGMA 2. Failing it will cause death, destruction and server crashes.

RULE 4: As usual, take your time :)

General instructions

Before installing ZeXtras Suite one will need to have downloaded the package, as explained in the appropriate section above, and exploded the archive in a directory of one's choice.

$ tar xfz zextras_suite-X.X.X.tgz
$ ls 
zextras_suite-X.X.X.tgz zextras_suite-X.X.X/

Inside the directory zextras_suite-X.X.X one shall find an executable shell script named install.sh.

$ cd zextras_suite-X.X.X
$ ./install.sh -h

./install.sh -h | ./install.sh [ -u ] all|zimlet|core 

-h         This very message
-u         Uninstall the target

The targets available for (un)installation are:
core   -- ZeXtras Core
zimlet -- ZeXtras Suite Zimlet
all    -- ZeXtras Core followed by ZeXtras Suite Zimlet

* In order to use ZeXtras Suite both
* core and zimlet need to be installed.

The output of ./install.sh -h will give the user a concise explanation regarding the usage of the installation script.

In order to successfully perform an installation one shall need to either become the root user or execute the script with root privileges (e.g. using sudo).

Once launched the script will perform a check of your system determining your Zimbra version and checking for any preexistent installation of either ZeXtras Suite or ZeXtras Migration Tool.

Warning! Were any component of ZeXtras Migration Tool detected, you will be prompted to uninstall them (as detailed here) and rerun the ZeXtras Suite installation script afterwards.

Proceeding with the installation requires for the EULA of ZeXtras to be accepted, after which the actual installation shall take place.
For details regarding the ZeXtras Core or ZeXtras Zimlet installation, see the related sections below.

Warning! The ZxBackup Module MUST be Initialized to work properly. No initialization means no Real Time Scanner, no Live Scan Scheduler and no export/import functions. All operations will be ignored.

ZeXtras Suite full Installation

--- RECOMMENDED ---
In order to install ZeXtras Suite you need for both Core and Zimlet to be correctly deployed and functional.
Choosing all as target will install Core and Zimlet, in that order, in one go.
Alternatively you can invoke the install.sh script with either core or zimlet as targets, installing each separately

Warning! Beware: ZeXtras Core and ZeXtras Zimlet MUST match versions, even when installed separately.

Full installation:

./install.sh all

ZeXtras Suite Core Installation

In order to install ZeXtras Core you need for Zimbra services to be stopped beforehand.
You can either stop them before running the script or having them stopped by the script when prompted.
Once that step is cleared the script will perform a series of checks regarding a potential previous installation of ZeXtras Core and eventually install the jar file among the Zimbra extensions.

Core-only installation:

./install.sh core

Deployed the Core, Zimbra will need to be restarted to verify the former's correct operation.
(If you are using the all target to install both Core and Zimlet the script itself will prompt to start Zimbra.)
Once Zimbra is fully started the presence of lines such as the ones below in /opt/zimbra/log/mailbox.log will mark a successful installation.

INFO  [main] [] extensions - Initialized extension ZExtrasExtension: com.zextras.extension.ZExtrasExtension@com.zimbra.cs.extension.ZimbraExtensionClassLoader@7543073a
[...]
INFO  [main] [] extensions - registered handler at /zextras
[...]
INFO  [main] [] extensions - ZExtrasExtension Started

ZeXtras Suite Zimlet Installation

In order to install the ZeXtras Suite Zimlet you need for Zimbra services to be running.
As above, you can either proceed manually beforehand or let the script start them when prompted to do so.
Once Zimbra is active the administrative zimlet will be deployed, provided the core is already installed and both Core and Zimlet versions match.

Zimlet-only installation:

./install.sh zimlet

ZeXtras Suite full Upgrade

In case of a preexistent instance of ZeXtras Suite on your system installing a newer version will automatically perform an upgrade.
See the instructions above for the installation procedure.

ZeXtras Suite full Downgrade

In order to downgrade any components of ZeXtras Suite you need to uninstall them using the installation script from a package of identical or greater version, then install the older versions.

Warning! Downgrading might result in either or both your license and existing backups not being recognized correctly by an earlier version of ZeXtras. It is therefore not recommended nor supported.

ZeXtras Suite full Uninstallation

The removal procedure is mostly similar to the installation one. Placing the -u switch before the target is all is needed.
The script will verify the presence of any ZeXtras Suite components and prompt for their removal.
Called with the all target it shall remove ZeXtras Core and after that the ZeXtras Zimlet.

For example:

./install.sh -u all

Conclusion

If you don't reach a successful conclusion, double check step-by-step this guide, or have a look at the ZeXtras Troubleshooting page!