How to edit the Roundcube configuration file

Question

How can I make global changes to Roundcube settings without them being overwritten on cPanel update?

Answer

Settings written directly to the Roundcube include file will be automatically overwritten on cPanel updates, but creating an "include file" within Roundcube's includes directory will help changes persist.

1. Access your server using SSH as the root user

2. Examine the current contents of the Roundcube includes folder:

   # ls -al /usr/local/cpanel/base/3rdparty/roundcube/config/inc.d/
   total 8
   drwxr-xr-x 2 root root 67 Dec 18 22:43 .
   drwxr-xr-x 3 root root 131 Mar 29 17:46 ..
   -rw-r--r-- 1 root root 898 Dec 5 19:35 99-cpanel_config.inc.php
   -rw-r--r-- 1 root root 163 Dec 1 21:25 999-analytics.inc.php

3. Create a new file in the Roundcube includes folder:

   CONFIG_TEXT: touch /usr/local/cpanel/base/3rdparty/roundcube/config/inc.d/new-include.inc.php

   CPANEL_INFO: The names of these include files are important for controlling the load order of the settings inside them. To ensure that your file is loaded last, preface the name with a number larger than the highest numbered file, for example: 9999-yourinclude.inc.php

4. Using your desired text editor, add the settings you need into the new include file and save the changes.
5. Relaunch Roundcube