Skip to content


Switch branches/tags
This branch is 35 commits ahead, 1 commit behind jorgedlcruz:master.

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Rocket Chat

Zimbra RocketChat integration Zimlet for Zimbra 8.8.15 and Zimbra 9.

Zimbra Rocket Zimbra Rocket

This Zimlet will automatically create accounts for your users and will log them on to Rocket Chat automatically. The Zimlet will create accounts in Rocket Chat based on the Zimbra primary email address.

So in Zimbra becomes in Rocket Chat. Once set up, the users can only login via the Zimbra login page including mobile device apps. A welcome email is sent to the user with a fallback password, which can only be used in situations where the integration is disabled.

For easy understanding of the steps, we will refer to following examples throughout the section:

Choose your domain wisely

During 2020, Google and various vendors have been pushing the requirement to set cookies with the SameSite and Secure attributes.

RocketChat sets cookies on the client via JavaScript and does not support configuring the SameSite attribute, which is needed for it to run on a different domain than Zimbra. This means that RocketChat needs to be installed on a subdomain similar to Zimbra. For example, and will work, but and will not work.

Setting up Zimbra

  1. Copy rocket.jar from to /opt/zimbra/lib/ext/rocket/rocket.jar

  2. Create a text file /opt/zimbra/lib/ext/rocket/ with following contents:

    • The adminuser and adminpassword should have been created when you first installed Rocket Chat.

    • The loginurl is the place where we point users to that have not yet authenticated. This can be your SSO login page or the Zimbra login page.

      Do not put a / at the end of rocketurl! Make sure to configure X-Frame-Options/Access-Control-Allow-Origin on the Rocket Chat server side. You must remove these headers in a reverse proxy and add the correct ones for the integration to work. See the proxy-config for a basic example nginx/apache config.

  3. Restart zmmailbox server:

    su - zimbra
    zmmailboxdctl restart

Be careful, as you can easily lock yourself out if something does not work. If you want more details, refer to

Configure and deploy the Zimlet

  1. For Zimbra 8 get (from Github releases) and as Zimbra user:

    zmzimletctl deploy

    To configure the rocketurl in the Zimlet

     zmzimletctl getConfigTemplate /opt/zimbra/zimlets-deployed/com_zimbra_rocket > /tmp/config_template.xml.tmp

    Edit the /tmp/config_template.xml.tmp file according to your needs. Import the new configuration file by the running following command:

     zmzimletctl configure /tmp/config_template.xml.tmp
  2. For Zimbra 9 get (from Github releases at and as Zimbra user:

     zmzimletctl deploy

    Copy and paste the following config template file in /tmp/rocket_config_template.xml and update your rocket URL:

    <zimletConfig name="zimbra-zimlet-rocketchat" version="0.0.1">
       <property name="rocketurl"></property>

    Import the new configuration file by the running following command:

    zmzimletctl configure /tmp/rocket_config_template.xml
  3. Restart zmmailbox server:

     su - zimbra
     zmmailboxdctl restart

Make you Zimbra Admin a Rocket Admin, creation of RocketChat Admins

Once you have enabled iframe-authentication, you will not be able to login directly using the RocketChat login page. In most cases you will not be able to login to the RocketChat administrative account.

To fix this you can promote a regular user account to have an admin role. Log on to Zimbra and go to the RocketChat tab of the account you wish to use as admin and verify the account name. Example becomes in RocketChat. Promote this user on RocketChat server like this:

cd /snap/rocketchat-server/current
./bin/mongo parties --eval 'db.users.update({username:""}, {$set: {'roles' : [ "admin" ]}})'

Separation of tenants

This Zimlet does not separate tenants from Zimbra, so all users on your Zimbra server that have access to the RocketChat Zimlet will have an account on RocketChat and will be able to see and chat with each other. Accounts on RocketChat are created if/when the user logs into Zimbra. To remove a user from RocketChat you have to remove them on RocketChat and de-activate them in Zimbra or disable the RocketChat Zimlet for the user you want to remove from RocketChat.


Zimbra Rocket Chat integration







No packages published


  • Java 87.8%
  • JavaScript 11.6%
  • Other 0.6%