How to reinstall zimlets in zimbra?

How to Reinstall Zimlets in Zimbra

Zimlets are a core component of Zimbra, extending functionality and integrating third-party services into the web client. In some situations — such as Zimlet corruption, upgrade issues, or missing features — you may need to reinstall all Zimlets on a Zimbra server.

This article walks through a safe and systematic procedure to undeploy and redeploy Zimlets using the Zimbra command line.

Prerequisites

Before proceeding, ensure the following:

• You have SSH access to the Zimbra server
• You are running commands as the **zimbra user**
• Zimbra services are installed under /opt/zimbra
• You understand that this operation affects Zimlet availability for all users

Step 0: Switch to the Zimbra User

All Zimbra administrative commands must be executed as the zimbra user.

su - zimbra
cd /opt/zimbra

Step 1: Undeploy All Currently Deployed Zimlets

This step removes all deployed Zimlets from the system. It loops through the zimlets-deployed directory and undeploys each Zimlet one by one.

for zimlet in `ls -1 /opt/zimbra/zimlets-deployed`; do
    echo "Undeploying $zimlet..."
    zmzimletctl undeploy $zimlet
done

What this does:

• Cleans up existing Zimlet deployments
• Helps resolve conflicts caused by broken or partially deployed Zimlets
• Prepares the environment for a clean redeployment

Step 2: Deploy Core Zimlets

Core Zimlets are stored in /opt/zimbra/zimlets. This step redeploys all standard Zimlets except click2call and ucconfig, which are often environment-specific.

for zimlet in `ls -1 /opt/zimbra/zimlets | grep -v click2call | grep -v ucconfig`; do
    echo "Deploying $zimlet..."
    zmzimletctl deploy /opt/zimbra/zimlets/$zimlet
done

Why exclude some Zimlets?

• click2call and ucconfig may require additional configuration
• Excluding them avoids deployment failures in environments where they are not used

Step 3: Deploy Network Edition Zimlets

If you are running Zimbra Network Edition, additional Zimlets are located in /opt/zimbra/zimlets-network. This step deploys them, again excluding click2call and ucconfig.

for zimlet in `ls -1 /opt/zimbra/zimlets-network | grep -v click2call | grep -v ucconfig`; do
    echo "Deploying $zimlet..."
    zmzimletctl deploy /opt/zimbra/zimlets-network/$zimlet
done

Step 4: Restart the Mailbox Service

After redeploying all Zimlets, restart the mailbox service to apply the changes.

zmmailboxdctl restart

Verification

To confirm Zimlets are deployed correctly:

zmzimletctl listZimlets

You can also verify from the Zimbra Web Admin UI:

• Navigate to Configuration → Zimlets
• Ensure required Zimlets are enabled and deployed

Conclusion

Reinstalling Zimlets in Zimbra is a straightforward process when done methodically. By undeploying all existing Zimlets, redeploying core and network Zimlets, and restarting services, you can resolve many common Zimlet-related issues after upgrades or configuration changes.

This approach ensures a clean and consistent Zimlet environment across your Zimbra deployment.