Skip to content

Deploying a zimlet from the admin console

Zimlet packages (.zip) can also be installed and updated from the admin console, without the command line.

Global administratorAdmin console › Configure › Zimlets

Install

  1. Click Configure › Zimlets in the left tree. User zimlets are listed with their name, display name, version and status.
  2. Open the gear (⚙) menu at the top right and click Deploy.

Zimlets and Deploy in the gear menu

Zimlets and Deploy in the gear menu
  1. In the Upload and deploy the zimlet or extension window, choose the zimlet package with the file button (e.g. com_profelis_quota.zip).
  2. Tick Flush zimlet cache.
  3. Click Deploy. The package is uploaded and distributed to all servers; wait until the status shows success.
  4. Close the window with Finish; the zimlet appears in the list with its version.

The deploy window

The deploy window

Uploading a newer package with the same name updates the existing zimlet; you do not need to remove it first. Admin zimlets are not in this list but under Configure › Admin Extensions; they are deployed the same way.

Enabling for users

User zimlets (the ones shown in webmail) must also be allowed in a class of service (COS):

  1. Under Configure › Class of Service, double-click the COS (for example default).
  2. Click Zimlets in the left tree. On the zimlet's row tick available and choose enabled (the user can turn it off) or mandatory (the user cannot); disabled turns the zimlet off.
  3. Click Save at the top right.

Class of Service › Zimlets tab

Class of Service › Zimlets tab

Admin zimlets (shown in the console) do not need this step.

Afterwards

  • Hard-refresh the browser (Ctrl+Shift+R); users see the new version after signing in again.
  • Compare the version in the zimlet list with the Installed zimlets page.

Modules with a server extension

Some modules (e.g. backup, quota, certificates, SAML) ship a server extension next to the zimlet. Deploying from the console only updates the zimlet part. If the extension changed too, use the installer or the manual update steps.

Rolling back

If something goes wrong, deploy the previous package the same way, or select the zimlet in the list and remove it with Undeploy in the gear menu. Toggle Status enables or disables a zimlet without removing it.