Page tree
Skip to end of metadata
Go to start of metadata

Overview

Warnings:

  • When you upgrade to cPanel & WHM version 58, you will lose all of your prior Roundcube customizations.
  • The instructions in this document only apply to cPanel & WHM versions 11.46 through 56. Customizations that use this method will not function in cPanel & WHM version 58 and later, because these versions ship Roundcube as an RPM. To customize Roundcube for cPanel & WHM version 58 and later, read our How to Build and Install Custom RPMs documentation.
  • Customization of Roundcube gives you full control over the end user experience. However, cPanel, Inc. does not support these customizations.

This document explains how to update the Roundcube webmail application, and how you can customize your Roundcube installation.

Roundcube updates

Warning:

Because the /usr/local/cpanel/bin/update-roundcube script only retains the last four backups, continuous execution of the /usr/local/cpanel/bin/update-roundcube script may cause data loss. We strongly recommend that you maintain external backups and avoid continuous backups of non-operational Roundcube installations. 

The method that cPanel & WHM uses to update Roundcube affects your customizations. cPanel & WHM uses the following process to update Roundcube:

  1. The system runs the /scripts/upcp script to update cPanel & WHM.
  2. The /scripts/upcp script runs the /usr/local/cpanel/install/webmail script.
  3. The /usr/local/cpanel/install/webmail script executes the /usr/local/cpanel/bin/update-roundcube script.
  4. The /usr/local/cpanel/bin/update-roundcube script runs the following command to remove the current Roundcube installation:

    rm -rf /usr/local/cpanel/base/3rdparty/roundcube
  5. The /usr/local/cpanel/bin/update-roundcube script extracts the appropriate source tarball to the /usr/local/cpanel/base/3rdparty/ directory.

    Note:

    During this step, the  /usr/local/cpanel/bin/update-roundcube  script checks for the existence of the /var/cpanel/roundcube/install file.

    • If that file exists and is executable, the /usr/local/cpanel/bin/update-roundcube script executes it and terminates. 
      • This bypasses cPanel & WHM's manipulation of the Roundcube configuration files.
      • If the file successfully executes, steps 5 through 9 of the installation procedure do not occur.
    • If the /var/cpanel/roundcube/install file exists but is not executable, the file contents print to STDOUT and the normal cPanel & WHM configuration of Roundcube continues with the installation procedure.
  6. The /usr/local/cpanel/bin/update-roundcube script changes the ownership of the Roundcube installation to the root user and the wheel group.
  7. The /usr/local/cpanel/bin/update-roundcube script checks for the existance of the /var/cpanel/roundcube/install file.

  8. The /usr/local/cpanel/bin/update-roundcube script extracts MySQL® configuration values from the system settings.
  9. The /usr/local/cpanel/bin/update-roundcube script backs up Roundcube's MySQL database to the  /var/cpanel/roundcube/roundcube.backup.sql.currenttimestamp file, where currenttimestamp represents the time at which the script ran.

    Note:

    The /var/cpanel/roundcube/ directory only retains the four most recent copies of the Roundcube database backup.

  10. The /usr/local/cpanel/bin/update-roundcube script drops the Roundcube database from MySQL.
  11. The /usr/local/cpanel/bin/update-roundcube script updates Roundcube's configuration files and MySQL files with the server's settings.
  12. The /usr/local/cpanel/bin/update-roundcube script recreates Roundcube's database from the MySQL files.
  13. The /usr/local/cpanel/bin/update-roundcube script reloads the previous Roundcube database backup and finishes the update.

Install a customized instance of Roundcube

You may customize Roundcube in a number of ways. For example, you can make simple configuration changes or completely replace the Roundcube tarball. For instructions on how to customize Roundcube, read the Roundcube wiki.

Where to save a custom Roundcube tarball

During step 2 of the installation procedure, the /usr/local/cpanel/bin/update-roundcube script checks for custom Roundcube tarballs. If any of these tarball files exist, cPanel & WHM uses them instead of the cPanel-provided tarball. 

If the script locates multiple tarballs, it uses them in the following order:

DirectoryDescription
/var/cpanel/roundcube/roundcube-$RCUBE_VERSION-local.tar.gz
Use this location for a compressed tarball that you want to apply to a specific Roundcube version.

/var/cpanel/roundcube/roundcube-$RCUBE_VERSION-local.tar

Use this location for an uncompressed tarball that you want to apply to a specific Roundcube version.
/var/cpanel/roundcube/roundcube-local.tar.gz
Use this location for a compressed tarball that you want to apply to Roundcube regardless of version.
/var/cpanel/roundcube/roundcube-local.tar
Use this location for an uncompressed tarball that you want to apply to Roundcube regardless of version.

For example, cPanel & WHM uses the /var/cpanel/roundcube/roundcube-0.4-local.tar.gz file if the following statements are true:

  • The /var/cpanel/roundcube/roundcube-local.tar and /var/cpanel/roundcube/roundcube-0.4-local.tar.gz files exist.
  • The /var/cpanel/roundcube/roundcube-0.4-local.tar.gz file matches the version number that the /usr/local/cpanel/bin/update-roundcube script specifies.

 

Important:

  • The value that $RCUBE_VERSION represents in these locations must match the $RCUBE_VERSION variable that the /usr/local/cpanel/bin/update-roundcube script defines. 
  • For example, if the $RCUBE_VERSION parameter is set to the 0.4 version in the /usr/local/cpanel/bin/update-roundcube script, save your custom tarball as the roundcube-0.4-local.tar.gz file.
  • These tarballs must extract to the /usr/local/cpanel/base/3rdparty/roundcube/ directory.

Where to store a custom overlay file

The overlay tarball allows you to customize specific aspects of Roundcube. For example, you can use an overlay to change graphics, themes, or plugins. It can also contain one image file.

The overlay does not need to contain a complete Roundcube distribution. It only needs to contain the components that you wish to modify, because cPanel & WHM will overlay it onto the Roundcube installation. The overlay does, however, need to contain a directory structure that matches the structure of the /usr/local/cpanel/base/3rdparty/roundcube directory and starts with roundcube.

After you determine which tarball to use for the source install and extract it, the  /usr/local/cpanel/bin/update-roundcube  script checks for the directories listed in the table below:

DirectoryDescription
/var/cpanel/roundcube/overlay.$RCUBE_VERSION.tar.gz
Use this location for a compressed overlay you want to apply to a specific Roundcube version.
/var/cpanel/roundcube/overlay.$RCUBE_VERSION.tar
Use this location for an uncompressed overlay you want to apply to a specific Roundcube version.
/var/cpanel/roundcube/overlay.tar.gz
Use this location for a compressed overlay you want to apply to Roundcube regardless of version.
/var/cpanel/roundcube/overlay.tar
Use this location for an uncompressed overlay you want to apply to Roundcube regardless of version.

Important:

  • If the script locates multiple tarballs, it uses them in this order.
  • The value of the $RCUBE_VERSION variable must match the version number that the /usr/local/cpanel/bin/update-roundcube script specifies.

Additional documentation