{"id":687,"date":"2021-07-23T12:35:40","date_gmt":"2021-07-23T12:35:40","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/how-to-customize-roundcube-webmail\/"},"modified":"2021-07-23T12:35:40","modified_gmt":"2021-07-23T12:35:40","slug":"how-to-customize-roundcube-webmail","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/how-to-customize-roundcube-webmail\/","title":{"rendered":"How to Customize Roundcube Webmail"},"content":{"rendered":"<\/p>\n
\n
<\/div>\n
\n

Overview<\/h2>\n
\n
Warning:<\/div>\n
\n
    \n
  • This document is only<\/strong> valid for cPanel & WHM version 11.46 through 56. Customizations that use this method will not<\/strong> function in cPanel & WHM version 58 and later, because these versions ship Roundcube as an RPM.<\/li>\n
  • Because cPanel, L.L.C. doesn\u2019t develop Roundcube, cPanel Technical Support can\u2019t help with customization.<\/li>\n
  • To customize Roundcube for cPanel & WHM version 58 and later, read our How to Build and Install Custom RPMs documentation.<\/li>\n
  • cPanel, L.L.C. does not<\/strong> support Roundcube user experience customizations.<\/li>\n<\/ul><\/div>\n<\/div>\n

    You can update and customize the Roundcube webmail application.<\/p>\n

    Path and filenames for the database<\/h2>\n

    The SQLite database uses the following path and filename, where username<\/code> represents a cPanel account username and domain<\/code> represents a domain name:<\/p>\n

    \n
    \/home\/<\/span>username\/etc\/<\/span>domain\/<\/span>username.<\/span>rcube.<\/span>db<\/code><\/pre>\n<\/div>\n
    Additionally, the database applies the following naming conventions, where username represents a cPanel account username:<\/p>\n\n\n\n\n\n\n\n
    Filename<\/th>\nDescription<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
    \/home\/username\/etc\/domain\/username.rcube.db.unixtimestamp<\/code><\/td>\nA backup file with a Unix timestamp.<\/td>\nusername.rcube.db.1495814375<\/code><\/td>\n<\/tr>\n
    \/home\/username\/etc\/domain\/username.rcube.db.latest<\/code><\/td>\nA symlink to the latest Roundcube backup.<\/td>\nusername.rcube.db.latest<\/code><\/td>\n<\/tr>\n
    \/home\/username\/etc\/domain\/username.rcube.db.YYYYMMDDHHMMSS.sqlite2<\/code><\/td>\nA SQLite v2 backup file.<\/td>\nusername.rcube.db.20170523105040.sqlite2<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Roundcube updates<\/h2>\n
    \n
    Warning:<\/div>\n
    \n
    Because the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script only<\/strong> retains the last four backups, continuous execution of the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script may result in data loss. We strongly<\/strong> recommend that you maintain external backups and avoid continuous backups of non-operational Roundcube installations.<\/p>\n<\/p><\/div>\n<\/div>\n
    The method that cPanel & WHM uses to update Roundcube affects your customizations. cPanel & WHM uses the following process to update Roundcube:<\/p>\n
      \n
    1. \n
      The system runs the \/scripts\/upcp<\/code> script to update cPanel & WHM.<\/p>\n<\/li>\n
    2. \n
      The \/scripts\/upcp<\/code> script runs the \/usr\/local\/cpanel\/install\/webmail<\/code> script.<\/p>\n
      \n
      Note:<\/div>\n
      \n
      During this step, the script will check for custom Roundcube tarballs. For more information, read the Where to save a custom Roundcube tarball installation section.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n
    3. \n
      The \/usr\/local\/cpanel\/install\/webmail<\/code> script executes the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script.<\/p>\n<\/li>\n
    4. \n
      The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script runs the following command to remove the current Roundcube installation:\n<\/p>\n
      \n
        rm -<\/span>rf \/usr\/<\/span>local\/cpanel\/<\/span>base\/3rdparty\/<\/span>roundcube\n<\/code><\/pre>\n<\/div>\n<\/li>\n
    5. \n
      The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script extracts the appropriate source tarball to the \/usr\/local\/cpanel\/base\/3rdparty\/<\/code> directory.<\/p>\n
      \n
      Note:<\/div>\n
      \n
      During this step, the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script checks for the existence of the \/var\/cpanel\/roundcube\/install<\/code> file and performs one of the following actions:<\/p>\n
        \n
      • If the \/var\/cpanel\/roundcube\/install<\/code> is not an executable file, the file\u2019s contents print to the STDOUT<\/code> file and Roundcube continues with the installation procedure of the normal cPanel & WHM configuration.<\/li>\n
      • \n
        If the \/var\/cpanel\/roundcube\/install<\/code> is an executable file, the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script executes this file and then terminates the script.<\/p>\n
          \n
        • This bypasses cPanel & WHM\u2019s manipulation of the Roundcube configuration files.<\/li>\n
        • If the file successfully executes, steps 5 through 9 of the installation procedure do not<\/strong> occur.<\/li>\n<\/ul>\n<\/li>\n<\/ul><\/div>\n<\/div>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script changes the ownership of the Roundcube installation to the root<\/code> user and the wheel<\/code> group.<\/p>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script checks for the existence of the \/var\/cpanel\/roundcube<\/code>\/install file.<\/p>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script extracts MySQL\u00ae configuration values from the system settings.<\/p>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script backs up Roundcube\u2019s MySQL database to the \/var\/cpanel\/roundcube\/roundcube.backup.sql.currenttimestamp<\/code> file, where currenttimestamp<\/code> represents the time at which the script ran.<\/p>\n
          \n
          Note:<\/div>\n
          \n
          The \/var\/cpanel\/roundcube\/<\/code> directory only<\/strong> retains the four most recent copies of the Roundcube database backup.<\/p>\n<\/p><\/div>\n<\/div>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script drops the Roundcube database from MySQL.<\/p>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script updates Roundcube\u2019s configuration files and MySQL files with the server\u2019s settings.<\/p>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script recreates Roundcube\u2019s database from the MySQL files.<\/p>\n<\/li>\n
        • \n
          The \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script reloads the previous Roundcube database backup and finishes the update.<\/p>\n<\/li>\n<\/ol>\n
          Install a customized instance of Roundcube<\/h2>\n
          There are many ways that you can customize Roundcube. For example, you can make simple configuration changes or completely replace the Roundcube tarball.<\/p>\n
          For instructions on how to customize Roundcube, read the Roundcube wiki.<\/p>\n
          Where to save a custom Roundcube tarball<\/h3>\n
          During step 2 of the Roundcube update installation procedure, the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script checks for custom Roundcube tarballs. If any<\/strong> of these tarball files exist, cPanel & WHM uses them instead of the cPanel-provided tarball.<\/p>\n
          If the script locates multiple tarballs, it uses them in the following order, where RCUBE_VERSION<\/code> represents the Roundcube version number:<\/p>\n
            \n
          • \/var\/cpanel\/roundcube\/roundcube-RCUBE_VERSION-local.tar.gz<\/code> \u2014 Use this location for a compressed tarball that you want to apply to a specific Roundcube version.<\/li>\n
          • \/var\/cpanel\/roundcube\/roundcube-RCUBE_VERSION-local.tar<\/code> \u2014 Use this location for an uncompressed tarball that you want to apply to a specific Roundcube version.<\/li>\n
          • \/var\/cpanel\/roundcube\/roundcube-local.tar.gz<\/code> \u2014 Use this location for a compressed tarball that you want to apply to Roundcube, regardless of version.<\/li>\n
          • \/var\/cpanel\/roundcube\/roundcube-local.tar<\/code> \u2014 Use this location for an uncompressed tarball that you want to apply to Roundcube, regardless of version.<\/li>\n<\/ul>\n
            Example<\/h4>\n
            For example, cPanel & WHM uses the \/var\/cpanel\/roundcube\/roundcube-0.4-local.tar.gz<\/code> file if the following statements are true:<\/p>\n
              \n
            • The \/var\/cpanel\/roundcube\/roundcube-local.tar<\/code> and \/var\/cpanel\/roundcube\/roundcube-0.4-local.tar.gz<\/code> files exist.<\/li>\n
            • The \/var\/cpanel\/roundcube\/roundcube-0.4-local.tar.gz<\/code> file matches the version number that the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script specifies.<\/li>\n<\/ul>\n
              \n
              Important:<\/div>\n
              \n
                \n
              • The value that RCUBE_VERSION<\/code> represents in these locations must<\/strong> match the RCUBE_VERSION<\/code> variable that the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script defines. For example, if the RCUBE_VERSION<\/code> parameter is version 0.4 in the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script, you must<\/strong> save your custom tarball as the roundcube-0.4-local.tar.gz<\/code> filename.<\/li>\n
              • These tarballs must extract to the \/usr\/local\/cpanel\/base\/3rdparty\/roundcube\/<\/code> directory.<\/li>\n<\/ul><\/div>\n<\/div>\n
                Where to store a custom overlay file<\/h3>\n
                The overlay tarball allows you to customize specific attributes of Roundcube, such as the use of an overlay to change graphics, themes, or plugins. It can also contain one image file.<\/p>\n
                The overlay does not<\/strong> require a complete Roundcube distribution. It only requires the components that you wish to modify, because cPanel & WHM will overlay it onto the Roundcube installation. However, the overlay requires a directory structure that matches the \/usr\/local\/cpanel\/base\/3rdparty\/roundcube<\/code> directory structure and begins with the roundcube<\/code> name.<\/p>\n
                After you determine which tarball to use for the source installation and extract it, the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script checks for the following directories. If the script locates multiple tarballs, it uses them in the following order, where RCUBE_VERSION<\/code> represents a Roundcube version number:<\/p>\n
                  \n
                • \n
                  \/var\/cpanel\/roundcube\/overlay.RCUBE_VERSION.tar.gz<\/code> \u2014 Use this location for a compressed overlay that you want to apply to a specific Roundcube version.<\/p>\n<\/li>\n
                • \n
                  \/var\/cpanel\/roundcube\/overlay.tar.gz<\/code> \u2014 Use this location for a compressed overlay that you want to apply to Roundcube, regardless of version.<\/p>\n<\/li>\n
                • \n
                  \/var\/cpanel\/roundcube\/overlay.RCUBE_VERSION.tar<\/code> \u2014 Use this location for an uncompressed overlay that you want to apply to a specific Roundcube version.<\/p>\n<\/li>\n
                • \n
                  \/var\/cpanel\/roundcube\/overlay.tar<\/code> \u2014 Use this location for an uncompressed overlay that you want to apply to Roundcube, regardless of version.<\/p>\n<\/li>\n<\/ul>\n
                  \n
                  Important:<\/div>\n
                  \n
                  The value of the RCUBE_VERSION<\/code> variable must<\/strong> match the version number that the \/usr\/local\/cpanel\/bin\/update-roundcube<\/code> script specifies.<\/p>\n<\/p><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
                  Overview Warning: This document is only valid for cPanel & WHM version 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. Because cPanel, L.L.C. doesn\u2019t develop Roundcube, cPanel Technical Support can\u2019t help with customization. To customize Roundcube …<\/p>\n","protected":false},"author":1,"featured_media":688,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/687"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=687"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/687\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/688"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=687"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=687"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=687"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}