ZCS Administrator's Guide, Open Source Edition, 6.0.8

Managing Zimlets from the Command Line

Viewing Zimlet List

Configuring a Zimlet

The Zimlet zip file should be copied to each Zimbra server where it will be deployed. You should copy your Zimlets to the /opt/zimbra/zimlets-extra directory.

To deploy a Zimlet to the default COS

1.	Copy the Zimlet zip file to the /opt/zimbra/zimlets-extra directory.

2.	To deploy, type the following command

zmzimletctl deploy <zimlet.zip file name>

The Zimlet is copied to the /opt/zimbra/zimlets-deployed directory.

Deploying the Zimlet creates the Zimlet entry in the LDAP server, installs the Zimlet files on the server, grants access to the members of the default COS, and enables the Zimlet. The Zimlet is displayed on the administration console Zimlets page.

Running zmzimletctl deploy is equivalent to running the following four commands.

•	zmzimletctl install

•	zmzimletctl ldapDeploy

•	zmzimletctl acl default grant

•	zmzimletctl enable

To deploy a Zimlet and grant access to a COS other than the default COS

To deploy a Zimlet to one or more COSs other than default, first install the Zimlet, then adjust the ACL on the COSs.

1.	Copy the Zimlet zip file to the /opt/zimbra/zimlets-extra directory.

2.	To deploy, type the following command

zmzimletctl deploy <zimlet.zip file name>

The Zimlet is copied to the /opt/zimbra/zimlets-deployed directory. If your Zimlet included a .jsp file, the .jsp file is coped to the /opt/zimbra/jetty/webapps/zimlet/<zimletnamefolder>.

This deployment creates the Zimlet entry in the LDAP server, installs the Zimlet files on the server, grants access to the members of the default COS, and enables the Zimlet.

3.	To add the Zimlet to other COSs and grant access, type

zmzimletctl acl <zimletname> <cosname1> grant

You can grant access to more than one COS on the same command line. Enter as zmzimletctl acl <zimletname> <cosname1> grant <cosname2> grant

Note: To turn off access to Zimlets in the default COS, type
                zmzimletctl acl <zimletname> default deny

Viewing Zimlet List

To view a list of Zimlets that are on the server and their status type

zmzimletctl listZimlets all

Configuring a Zimlet

Some Zimlets may require additional configuration after they are deployed to configure additional information. Your developer will let you know if this is necessary.

The Zimlet Management Tool provides the means for setting up a special Zimlet configuration. You make the configuration changes on the configuration template and then install the new configuration file on the Zimbra server.

See the Zimlet Development section on the Zimbra Wiki. for general Zimlet development articles. Review the ZimletDevSetup article for details about developing and deploying.

How to Change Zimlet Configurations

1.	To extract the configuration template type

zmzimletctl getConfigTemplate <zimlet.zip>

The config_template.xml is extracted from the Zimlet. zip file.

2.	Make the required changes in the template. Be careful to only change the required areas. Save the file.

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

3.	Type the following 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

ZCS Administrator's Guide, Open Source Edition, 6.0.8