Update Zimphony Webmail

Before you update

1. Schedule an appropriate maintenance window.
2. Confirm that the current Zimphony deployment is running normally.
3. Obtain the approved Zimphony Webmail release ZIP.
4. Place the ZIP directly under /opt/zimphony-webmail/.
5. Confirm that sufficient disk space is available for the new release directory.
6. Keep the previous release directory and ZIP until the new release has been verified.
7. Read any release-specific notes supplied with the package.

Example release layout

The release ZIP and its extracted directory sit directly under /opt/zimphony-webmail/:

/opt/zimphony-webmail/
├── zimphony-webmail-mail-native-20260813-160000.zip
└── zimphony-webmail-mail-native-20260813-160000/

The filename and directory differ according to the Edition and release timestamp. This is an example release name, not a fixed filename.

Update procedure

1. 01

   Place the new release ZIP on the server

   Place the new release ZIP directly under /opt/zimphony-webmail/:

   /opt/zimphony-webmail/zimphony-webmail-mail-native-20260813-160000.zip

2. 02

   Extract the release

   cd /opt/zimphony-webmail
   
   sudo unzip zimphony-webmail-mail-native-20260813-160000.zip

   After extraction, a new release directory is created, for example /opt/zimphony-webmail/zimphony-webmail-mail-native-20260813-160000.

3. 03

   Run the updater from the new release directory

   cd /opt/zimphony-webmail/zimphony-webmail-mail-native-20260813-160000
   
   sudo ./update.sh ../zimphony-webmail-mail-native-20260813-160000.zip

   Run update.sh from the new release directory and pass the ZIP path from its parent directory.

   The same procedure applies to every Edition. Do not manually select an Edition. The updater reads the Edition from the release ZIP; administrators do not need to specify mail-only, mail-google, or mail-native-zimbra.

   For the general path pattern:

   cd /opt/zimphony-webmail/<new-release-directory>
   
   sudo ./update.sh ../<new-release-file>.zip

Verify the update

After update.sh finishes, run this from the new release directory:

sudo ./verify-update.sh

verify-update.sh checks automatically for every Edition that:

• Backend and frontend are present.
• Backend and frontend are running.
• The backend continues to use the existing backend-data volume.
• backend.env and frontend.env remain present.
• Environment files match the files saved before the update.
• Each check reports PASS or FAIL.
• When a check fails, the script displays a command for viewing logs.

A successful script result is:

VERIFICATION PASSED

A verification pass is not, by itself, a complete functional confirmation. Continue with the browser and feature checks below.

Functional verification

After seeing VERIFICATION PASSED, check the deployment in a browser:

1. Open Zimphony Webmail in a browser.
2. Sign in with a test account.
3. Confirm that the mailbox loads normally.
4. Send a test email.
5. Confirm receipt of the test email.
6. Test the features included with the installed Edition.

All Editions

• Zimbra Mail access
• Zimbra Contacts access
• Normal sign-in and sign-out

Webmail Shared, Native Zimbra, and Google Connect where applicable

• Mail Folder Sharing
• Contact Sharing

Native Zimbra where applicable

• Zimbra Calendar
• Zimbra Tasks
• Zimbra Briefcase
• Included native sharing workflows

Google Connect where applicable

• Google Calendar
• Google Tasks
• Google Drive
• Customer-managed Google collaboration and sharing workflows

Administrative features where configured

• Domain Admin Portal
• Per-domain white-label
• Built-in 2FA

If verification fails

• Do not remove the previous release directory or ZIP.
• Review the failed check shown by verify-update.sh.
• Run the log command displayed by the verification script.
• Record the failing component and relevant log output.
• Contact Zimphony Support before making additional production changes if the cause is unclear.

Need help updating Zimphony?

Zimphony Webmail Implementation is available as an optional assisted service for organizations that prefer help with deployment or updates.