Skip to content

zmpkg manual


The ZCS Package Management Core provides a generic dpkg/apt-based package management facility for deployment extensions within a Zimbra ZCS instance. It also provides a set of utilities for building packages.

Its main components are: Frontends to the Debian package management tools for usage within a zimbra instance common Makefile-includes and helper scripts for building zmpkg-based packages

Installing zmpkg

In order to install any VNC Zimlets, including the VNCtalk zimlet, you need to install and configure zmpkg first. To do so, open this link in your web-browser, download the latest zmpkg installer from there and transfer it to the machine where Zimbra is installed. The latest version of zmpkg is always available at:

You can copy the link or alternatively use wget from the command line to download it directly to your Zimbra mailbox server, for example:


Extract the downloaded file:

tar xfvz zmpkg-installer-latest.tar.gz

Change to the extracted directory and execute the installer as user root. The install script will take care of all needed dependencies and will install these too.

$ cd zmpkg-installer-<version>
$ sudo ./

Please Note: Executing the shellscript, will trigger your system's package manager to initiate an update of your installed packages system along with it!

Now switch to the zimbra user:

$ sudo su - zimbra

and check whether zmpkg is installed or not by using the zmpkg list command.

$ zmpkg list

Please Note: If your system is behind a proxy, you might have to set the $http_proxy environment variable accordingly:

$ export http_proxy=http://<proxy-host>:<proxy-port>/

It may be required to add the http_proxy variable to the zimbra user's .profile or .bashrc files.

Configure zmpkg

Because zmpkg works like apt-get, it is possible to change the repository-URL where the zimlets are installed from. To modify the repository information for zmpkg, you need to log in as user zimbra and edit the apt-sources file located in /opt/zimbra/extensions-extra/zmpkg/etc/apt/sources.list

$ sudo su - zimbra
$ vi /opt/zimbra/extensions-extra/zmpkg/etc/apt/sources.list

In order to install the VNCtalk zimlet, you need to add the commercial repository. Finally the source.list file should look like this:

## automatic entry generated by bootstrap install
## NOTE: you should retain formatting (spaces instead of tabs) for further automatic config upgrades to work
deb judaspriest free restricted commercial
## uncomment this if you want to use commercial VNC products
## NOTE: these products are free for evaluation-only, but charged on usage
please see for more information
# deb judaspriest commercial
## add your own repos here

zmpkg Usage

zmpkg and zm-apt-get can be used like the Debian/Ubuntu dpkg and apt-get procedures:

update, upgrade, install, download, etc.

All these commands must be executed as the zimbra user!

Updating repository

$ zm-apt-get update

Installing zimlets from a given .deb file

Install any zimlet deb package using

$ zmpkg install </path/to/package.deb>

After the installation of a zimlet, restart the mailboxd and flush the cache by using

$ zmmailboxdctl restart
$ zmprov fc all

to make the changes available to the ZCS.

Installing zimlets from a repository

Install any zimlet using zm-apt-get install <package name> command, for example:

$ zm-apt-get install zcs-vnc-talk

After the installation of a zimlet, restart the mailboxd and flush the cache by using

$ zmmailboxdctl restart

to make the changes available to the ZCS.

Listing installed zimlets

To check if a zimlet is installed already or get a list of all the currently installed zimlets and dependencies on the current Zimbra mailbox, execute the command:

$ zmpkg list

Upgrading installed zimlets

To upgrade installed zimlets from the repository, just execute debian like:

$ zm-apt-get update
$ zm-apt-get upgrade

Fix broken zmpkg After Zimbra-Upgrade

On every Zimbra mailboxd, zmpkg, the VNCtalk-Zimlet and all other VNC-Zimlets, that were installed via zmpkg, have to be re-installed in order to work again:

Since zmpkg is not recognized by Zimbra during any upgrade process, zmpkg and the Zimlets must be re-installed on every Zimbra mailboxd, in order to get them running again as before.
This can be done by executing these commands:

Re-install zmpkg

$ cd /tmp
$ wget
$ tar xfvz zmpkg-installer-latest.tar.gz
$ cd zmpkg-installer-zcs-zmpkg-<version>/
$ sudo -s
$ ./

Re-Install the previously installed VNC-zimlets

Next you have to re-install the previously installed Zimlets accordingly:

After zmpkg has been installed successfully, while logged in as user zimbra on the respective Zimbra mailbox server, run the following shell commands to install all previsously installed Zimlets and their dependencies, based on the Zimbra-Mailbox server's operating system:

$ sudo su - zimbra
$ zm-apt-get update
$ zm-apt-get install --reinstall `zmpkg list | grep -v zmpkg | grep "^ii" | awk '{print $2}' | tr '\n' ' '`
$ zmmailboxdctl restart && zmprov fc all