We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.
We will continue to maintain our API documentation on this server.
There are significant changes to Horde's behavior between cPanel & WHM version 11.48 to 11.50. Click the tab below that corresponds with your version of cPanel & WHM.
In cPanel & WHM version 11.42, we upgraded the cPanel-provided version of the Horde webmail application to Horde Groupware Webmail Edition 5.1.1. We will package and distribute this and all future updates to Horde as RPMs to ensure consistent installation and updates.
As a result, the way in which Horde data behaves on a cPanel & WHM server has undergone several changes. This guide details the changes that the system makes when you upgrade from Horde Webmail 1.2, as well as the new behavior after you upgrade.
The upgrade from Horde 1.2 to Horde 5.1.1 performs various actions in addition to RPM installation. Your server's webmail application settings determine which steps the upgrade takes.
If you enabled Horde on your cPanel & WHM version 11.40 server, the upgrade will perform the following actions:
.rpmorig file in the
/usr/local/cpanel/base/horde directory, so that they are accessible by the Horde RPMs.
Horde 1.2 customizations may be lost in the upgrade process and are not supported in later Horde installations.
Latin 1) to
/usr/local/cpanel/bin/update_horde_configscript runs the database schema migration scripts for all Horde applications and components.
If you had disabled Horde on your cPanel & WHM version 11.40 server, the upgrade will perform the following actions:
If Horde data exists in a centralized database, we recommend that you perform the following steps to upgrade that database:
The upgrade process removes the following Horde scripts and symlinks:
update_horde_config script detects the need for a schema update, it will first back up the Horde MySQL database to the
/var/cpanel/horde/directory are available.
The following example lists the
horde.backup files that you may see in the
Do not alter these values. If you do, the
update_horde_config script will overwrite them the next time it runs.
The following table lists the configuration values that the
update_horde_config script modifies:
|The MySQL® database password.|
|The MySQL database hostname.|
|The MySQL database name|
The Horde administrators' usernames.
The system takes this value from, and updates this value in, the
|The path to the third-party binary for the spellchecker.|
When you upgrade from Horde 1.2, the system backs up and stores your Horde configurations as a tarball in the
Although the system backs up the configuration in this file, Horde 1.2 themes and customizations are not supported in later installations.
To customize Horde 5.1.1 or later, system administrators must build a custom RPM. For more information, read the How to Build and Install Custom RPMs documentation.
The cPanel-provided installation of Horde includes the following plugin components:
horde— Horde Application Framework.
content— A tag application.
imp— A web-based webmail system.
ingo— An email filter rules manager.
kronolith— A web-based calendar.
mnemo— A web-based notes manager.
nag— A web-based task list manager.
timeobjects— The Horde timeobjects application.
trean— A web-based bookmark application.
turba— A web-based address book.
webmail— Horde Groupware Webmail Edition.
Due to the complexities of shared hosting, the cPanel-provided installation of Horde does not include the
Additional Horde modules, and information about customization, are available from the Horde project.
In cPanel & WHM version 11.40 and earlier, the deletion of a cPanel user account or email address did not remove the associated Horde data.
However, in cPanel & WHM version 11.42 and later, the following statements are true:
As of cPanel & WHM version 11.42, Horde uses InnoDB tables, which we cannot repair. You cannot restore Horde accounts that you did not back up without third-party assistance. We strongly recommend that you back up your Horde account data.
All cPanel & WHM backup systems now use the
/horde directory in the backup tarball to store Horde account backups. The
/mysql/horde.sql file no longer exists.
The following Horde data tables are not part of users' account data and, for this reason, the system does not back them up in conjunction with Horde accounts:
kronolith_resources— Resources and Resource Groups are global on the server. Only Horde administrators can access them.
*_schema_infotables — The system saves the version in a meta file.
horde_cache— A temporary Horde cache file.
horde_groups_members— The Horde user system.
horde_histories_modseq— The global internal settings for history retention.
horde_imap_client_data— A temporary Horde cache file.
horde_imap_client_message— A temporary Horde cache file.
horde_imap_client_metadata— A temporary Horde cache file.
horde_locks— Horde's internal lock mechanism.
horde_perms— Horde's internal permissions mechanism.
horde_sessionhandler— Horde's current sessions.
imp_sentmail— A temporary Horde cache file.
For more information, read the Backup Tarball Contents documentation.
You can restore data from accounts in Horde 5.1.1 or later in the same manner as other account data when you use the Restricted Restore system.
Because of changes to Horde's MySQL database, you cannot restore Horde data from cPanel & WHM version 11.42 or later to a server that runs cPanel & WHM version 11.40 or earlier.
In cPanel & WHM version 11.50, we moved the Horde user data storage from a single server-wide MySQL database to an individual SQLite database for each cPanel account. We also activated new features of Horde that were previously disabled.
This document explains the methods that the system uses to manage Horde data in cPanel & WHM version 11.50 and later.
When servers upgrade from 11.48 to 11.50, the system performs a one-time conversion operation during the post-sync cleanup phase of the upgrade. script. This moves the Horde user data from the Horde MySQL database to a set of SQLite databases, one for each cPanel account.
The original Horde database backs up to the
/var/cpanel/horde/horde.backup.sql.final file before the system performs this operation. If the backup and the conversion are both successful, the system removes the original Horde MySQL database.
You cannot downgrade Horde data from cPanel & WHM version 11.50 and later.
For new installations of cPanel & WHM version 11.50 and later, the system stores Horde user data into the new location from the installation. There is not a conversion step.
This change impacts backups, restores, and transfers in the following ways:
|cPanel & WHM Version||Description|
|11.50 and later||Each cPanel account possesses its own Horde SQLite database.|
|11.48 > 11.50||The system transfers your Horde data from a single MySQL database to per-account SQLite databases. After the upgrade, each cPanel account possesses its own Horde SQLite database.|
|11.50 > 11.48|
You cannot downgrade Horde data from cPanel & WHM version 11.50.
|11.50 > 11.52||The system uses the present Horde SQLite databases and upgrades them to work with the latest Horde components.|
|11.52 > 11.50|
You cannot downgrade Horde data from cPanel & WHM version 11.52.
As part of the switch to SQLite, the system no longer uses the
cpanelhorde user to manage access to the Horde database. The cpanelhorde user was necessary so that individual users could have limited access to the MySQL Horde database. In cPanel & WHM version 11.50 and later, each cPanel account possesses its own Horde SQLite database. Horde webmail and CalDAV/CardDAV services execute as the cPanel account user.
cPanel & WHM version 11.50 upgrades several components which installs several bug fixes from the upstream maintainers. The new version upgrades the Kronolith application from version 4.1.3 to 4.2.5. The change in version required a minor schema change to the applications tables. cPanel account users should not see any difference in behavior as a result of this change.
cPanel & WHM version 11.52 also upgrades many components which installs numerous bug fixes and features from the upstream maintainers. These upgrades include, but are not limited to, the following modules:
In cPanel & WHM version 11.48 and earlier, the
You can access the additional functions of this script if you perform the
This script installs with cPanel & WHM version 11.50 and later.
You can read the output of this script in the
We removed this script in cPanel & WHM 11.50.
In cPanel & WHM version 11.50 and later, each cPanel account possesses its own
.cphorde directory under the accounts home directory. The
.cphorde directory contains the following items:
|SQLite database||This database contains the cPanel accounts Horde data.|
|Directory||The backup service uses this directory to create the Horde database backups.|
In cPanel & WHM version 11.50 and later, the following changes were made to the
cPanel account users must have permissions to this file.
You can use the following table to troubleshoot problems for each cPanel account's Horde SQLite database.
If you delete a cPanel account's Horde SQLite database, you will lose all of that account's calendar and contact information.
|I want to...||cPanel & WHM 11.50 and later|
|Reset horde database password.||You can no longer perform this action in cPanel & WHM version 11.50. The SQLite database relies on filesystem permissions for access control, not a password.|
|Create a missing database for cPanel user |
|Create missing databases for all cPanel users on the system.|
|Upgrade tables or create missing tables in an existing database for cPanel user |
Upgrade tables or create missing tables in the existing databases for all users on the system.
This operation may require significant time to execute on systems with many accounts.
Move and re-create a new horde database for the cPanel user
There is no content with the specified labels
There is no content with the specified labels
There is no content with the specified labels