From 6443a4126504fad9149d2c9309108f35d6a60378 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Fri, 8 Mar 2024 14:23:55 +0100 Subject: [PATCH] fix(adminmanual): Document data retention and possible issues Signed-off-by: Christoph Wurst --- admin_manual/groupware/calendar.rst | 21 ++++++++++++++++++++ admin_manual/groupware/contacts.rst | 20 +++++++++++++++++++ admin_manual/release_notes/upgrade_to_26.rst | 4 ++++ 3 files changed, 45 insertions(+) diff --git a/admin_manual/groupware/calendar.rst b/admin_manual/groupware/calendar.rst index 92fd53545..0cbd550e7 100644 --- a/admin_manual/groupware/calendar.rst +++ b/admin_manual/groupware/calendar.rst @@ -206,3 +206,24 @@ To replace the built-in default event with a custom one: It is also possible to revert to the default built-in event by pressing the "Reset to default" button next to the import button. + +.. _caldav-data-retention: + +Data retention +-------------- + +.. versionadded:: 26.0.0 + +You can configure how long Nextcloud keeps some of the calendar sync tokens. + +Sync tokens +~~~~~~~~~~~ + +The CalDAV backend keeps track of any modifications of calendars. That is anything added, modified or removed. The data is used for differential synchronization of offline clients like Thunderbird. At a certain point in time, the data can be considered outdated assuming there will be no more client needing it. This can help keep the database table `calendarchanges` small:: + + sudo -E -u www-data php occ config:app:set totalNumberOfSyncTokensToKeep --value=30000 + +The default is keeping 10,000 entries. This option should be set adequate to the number of users. E.g. on an installation with 5000 active synced calendars the system would only keep an average of 10 changes per calendar. This will lead to premature data deletion and synchronization problems. + + +.. warning:: This setting will also influence :ref:`CardDAV data retention`. diff --git a/admin_manual/groupware/contacts.rst b/admin_manual/groupware/contacts.rst index bdc51ec61..b3237ab5a 100644 --- a/admin_manual/groupware/contacts.rst +++ b/admin_manual/groupware/contacts.rst @@ -100,3 +100,23 @@ If you want to set a specific contact that should be created. Switching back to the default example contact provided by nextcloud is possible by pressing the "Reset to default" button next to the import button. + +.. _carddav-data-retention: + +Data retention +-------------- + +.. versionadded:: 26.0.0 + +You can configure how long Nextcloud keeps some of the contacts sync tokens. + +Sync tokens +^^^^^^^^^^^ + +The CardDAV backend keeps track of any modifications of address books. That is anything added, modified or removed. The data is used for differential synchronization of offline clients like Thunderbird. At a certain point in time, the data can be considered outdated assuming there will be no more client needing it. This can help keep the database table `addressbookchanges` small:: + + sudo -E -u www-data php occ config:app:set totalNumberOfSyncTokensToKeep --value=30000 + +The default is keeping 10,000 entries. This option should be set adequate to the number of users. E.g. on an installation with 5000 active synced addressbooks the system would only keep an average of 10 changes per sync. This will lead to premature data deletion and synchronization problems. + +.. warning:: This setting will also influence :ref:`CalDAV data retention`. diff --git a/admin_manual/release_notes/upgrade_to_26.rst b/admin_manual/release_notes/upgrade_to_26.rst index b97804ca2..cbea53c1f 100644 --- a/admin_manual/release_notes/upgrade_to_26.rst +++ b/admin_manual/release_notes/upgrade_to_26.rst @@ -21,6 +21,10 @@ A brief overview of changes: See for more information: :ref:`email-smtp-config`. +DAV sync tokens retention +------------------------- + +A mechanism to clean up old CalDAV and CardDAV sync tokens has been added. See :ref:`CalDAV retention ` and :ref:`CardDAV retention ` and make sure it fits your installation size. Web server configuration ------------------------