Zimbra Collaboration Administrator Guide

Zimlets

Undeploying a Zimlet

When a Zimlet is undeployed, it is removed from all COSs and then removed from the LDAP.

Admin Console:

Configure > Zimlets

; select the Zimlet to undeploy.

1.

From the Gear icon menu select

Undeploy

.

2.

Click

Yes

to confirm.

Adding Proxy-Allowed Domains to a Zimlet

Proxy Allowed Domains lets you configure which external domains can be accessed through a Zimlet. For the Zimlets that are included in ZCS, proxy allowed domains are already configured. If you download and deploy other

Zimlets, you can add additional proxy domain names.

Admin Console:

Configure > Class of Service

; select the COS to edit.

1.

In the Advanced page, scroll down to the

Proxy Allowed Domains

section.

2.

Click

Add Domain

to add domains.

3.

Click

Save

.

Upgrading a Zimlet

Use the same steps as deploying a new Zimlet to upgrade a customized

Zimlet. The new Zimlet zip file should have the same name as the existing

Zimlet zip file.

Admin Console:

Configure > Zimlets; from the

Gear icon menu select

Deploy

.

1.

Check

Flush Zimlet cache,

so that the upgraded zimlet will be used.

2.

Browse to the Zimlet you want to upgrade, then click

Deploy

.

3.

Click Finish.

Managing Zimlets from the Command Line Interface

The following Zimlet management tasks are available from the command line interface.

Deploying Zimlets

When a Zimlet is deployed, it is available immediately to everyone in the default COS. If a Zimlet is not deployed to another COS directly, the COS displays the Zimlets but they are not enabled.

Deploy a Zimlet using the CLI, including modifying the COS before deploying.

1.

Select a Zimlet and copy the Zimlet zip file to

/tmp

folder on your Zimbra server.

Zimbra Collaboration Network Edition 311

Administrator Guide

2.

Login as the zimbra user su - zimbra

3.

Deploy the Zimlet zmzimletctl deploy /tmp/<zimlet>.zip

Adding Proxy Allowed Domains to a Zimlet

When deploying a Zimlet, the COS attributes,

zimbraProxyAllowedDomains

,

must be set for the domain address that the Zimlet might call to get information

CLI:

To set the zimbraProxyAllowedDomains attribute, type: zmprov mc <COSname> +zimbraProxyAllowedDomains

<*.domain.com>

The * must be added before the domain.com.

This must be applied to all COSs that have your Zimlet enabled.

Deploying a Zimlet and Granting Access to a COS

CLI:

Use steps in this section to deploy a Zimlet to one or more COSs other than the default:

1.

Login as zimbra user:

su – zimbra

2.

Copy the Zimlet file from Gallery to

/tmp

folder.

3.

Install the Zimlet to the default COS: run zmzimletctl deploy

<path-tozimlet.zip>

.

For example: zmzimletctl deploy /tmp/<zimlet>.zip

4.

To deploy the zimlet to additional COSs, run: zmzimletctl acl <zimletname> <cosname1> grant

This will grant permission to cosname1. You can also grant access to more than one COS on the same command line: zmzimletctl acl <zimletname> <cosname1> grant <cosname2> grant

5.

To allow this zimlet to use the allowed proxy domains, run the following on each COS and add the allowed domains. zmprov mc <COSname1> +zimbraProxyAllowedDomains <*. domain.com> zmprov mc <COSname2> +zimbraProxyAllowedDomains <*. domain.com>

312 Network Edition Zimbra Collaboration

Zimlets

Viewing Installed Zimlets

CLI:

Use the zmzimletctl

command to view currently installed zimlets: zmzimletctl listZimlets all

The output from this command displays the Zimlets installed on the server, installed in LDAP, and those available by COS,

Changing Zimlet Configurations

Some Zimlets may require additional configuration after they are deployed.

The Zimlet configuration template allows you to make changes on the configuration template and then install the new configuration file on the Zimbra server.

CLI:

Use steps in this section to change a Zimlet configuration:

1.

Extract the configuration template: zmzimletctl getConfigTemplate <zimlet.zip>

2.

Make the required changes in the template, taking care to change only the required areas, then save the file.

Note: If you have more than one custom Zimlet, rename the config_template.xml file before updating the configuration in LDAP so that files are not overwritten.

3.

Use the zmzimletctl

command to update the configuration in the LDAP.

If you changed the name of the configuration template, replace config_template.xml

with the new name.

zmzimletctl configure config_template.xml

Upgrading a Zimlet

Upgrading a customized Zimlet is performed by using the same steps as those used to deploy a new Zimlet.

Note: The new Zimlet zip file should be named identically to the existing

Zimlet zip file.

CLI:

Use steps in this section upgrade a zimlet:

1.

Copy the Zimlet zip file to the

/opt/zimbra/zimlets-extra

directory, replacing the older version.

2.

Deploy the Zimlet zmzimletctl deploy <zimlet.zip file name>

Zimbra Collaboration Network Edition 313

Administrator Guide

The Zimlet is copied to the

/opt/zimbra/zimlets-deployed

directory. If your Zimlet includes a .jsp file, the .jsp file is also copied to the

/opt/ zimbra/jetty/webapps/zimlet/<zimletnamefolder>

.

3.

To ensure availability of the newer version, flush the cache: zmprov flushCache zimlet.

Using the Zimbra Gallery

You can download and deploy Zimlets from the Zimlet Gallery located on the

Zimbra web site. Go to www.zimbra.com/downloads and scroll through the

Extensions from the Zimbra Gallery section or select View More to access the

Zimbra Gallery.

Developing Customized Zimlets

To develop your own custom Zimlets, see the Zimlet Developers Guide on the

Zimbra Wiki at http://wiki.zimbra.com/index.php?title=Main_Page.

314 Network Edition Zimbra Collaboration