cpdavd Service Replaces CCS Plugin


Last modified: April 4, 2024

Overview

In cPanel & WHM version 120, we deprecated and removed the Calendar and Contacts Server (CCS) plugin. We also added support for CalDAV (calendars) and CardDAV (contacts) to the cpdavd service.

In cPanel & WHM version 120 and later, the cpdavd service allows your users to manage their calendars and contacts accounts on your cPanel & WHM server. Users can share their calendars and contacts (known as collections) with other webmail users, create event invitations, and access collections in CalDAV or CardDAV applications.

Migration process

When the server updates to cPanel & WHM version 120, the system removes the CCS plugin and automatically migrates all CCS data to a format compatible with the cpdavd service. The system creates the /var/cpanel/migrate_ccs_to_cpdavd.done touch file once the migration is complete.

Important:
  • If your server previously ran CCS, your users must reconfigure their calendars and contacts applications. This is so they can access their CalDAV and CardDAV data in the new format. To reconfigure their applications, they must delete, then re-add, the accounts in the applications. For more information, read our How to Set Up Calendars and Contacts documentation.
  • We do not recommend that you transfer accounts with calendars or contacts data from a server that runs cPanel & WHM version 120 or later to a server that runs cPanel & WHM version 118 or earlier. If you do this, you will need to manually copy and import the accounts’ calendars and contacts data once the transfer has completed.

Notification email

After the system updates to cPanel & WHM version 120, the Feature Showcase will show the option to send a notification email to all email accounts with CCS data. This email will tell them to reconfigure their calendars and contacts applications.

If you want to send the email at a different time that you choose, decline the option, then run the /usr/local/cpanel/bin/servers_queue script for the reconfigure_calendars_notification task. For example:

/usr/local/cpanel/bin/servers_queue schedule 10800 reconfigure_calendars_notification

For more information, read our The servers_queue Script documentation.

Data locations

The migration process converts your server’s CCS data from a PostgreSQL database format into .ics files for calendar data and .vcf files for contacts data. The system stores these files for each user in the /home/user/.caldav/webmail_user/collection directory. It also creates the /home/user/.caldav/webmail_user/.metadata file, which contains the information on each collection, including the display name, description, and type of collection.

Note:
  • In the above file path examples, user is the cPanel username, webmail_user is the webmail user, and collection is the calendar or address book.
  • During the migration process, if the system cannot map a record to an existing user, it saves the data in the /var/cpanel/saved_dav directory.

Additional components

The cpdavd service includes the following additional components:

Service subdomains and autodiscover

The cpdavd service works best with service subdomains and autodiscover enabled. When your server upgrades to cPanel & WHM version 120, the Feature Showcase will show the option to enable the Service Subdomains and Thunderbird and Outlook autodiscover and autoconfig support in WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings). We strongly recommend that you enable these settings.

Access collections in CalDAV or CardDAV applications

Your users can access their collections in Roundcube or other CalDAV or CardDAV applications. For more information, read our How to Set Up Calendars and Contacts documentation.

If your users create local collections in Roundcube or other CalDAV or CardDAV applications, they may experience issues with synchronizing their data. We strongly recommend that your users only add or delete collections in one of the following interfaces:

  • cPanel’s Calendars and Contacts Management interface (cPanel » Home » Email » Calendars and Contacts Management)
  • Webmail’s Calendars and Contacts Management interface (Webmail » Calendars and Contacts Management)

Additional Documentation