Skip to content

Commit bb03c7f

Browse files
fix(adminmanual): Document data retention and possible issues
Signed-off-by: Christoph Wurst <[email protected]>
1 parent 845fb9a commit bb03c7f

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

admin_manual/groupware/calendar.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,24 @@ or::
160160

161161
# Allow users to create calendars/subscriptions without restriction
162162
php occ config:app:set calendar maximumCalendarsSubscriptions --type=integer --value=-1
163+
164+
.. _caldav-data-retention:
165+
166+
Data retention
167+
--------------
168+
169+
.. versionadded:: 26.0.0
170+
171+
You can configure how long Nextcloud keeps some of the calendar data.
172+
173+
Sync tokens
174+
~~~~~~~~~~~
175+
176+
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::
177+
178+
php occ config:app:set totalNumberOfSyncTokensToKeep --value=30000
179+
180+
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.
181+
182+
183+
.. warning:: This setting will also influence :ref:`CardDAV data retention<carddav-data-retention>`.

admin_manual/groupware/contacts.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,23 @@ Shared items
4949
.. versionadded:: 5.5.0
5050

5151
For this feature, the shipped `related resources app <https://apps.nextcloud.com/apps/related_resources>`_ needs to be enabled.
52+
53+
.. _carddav-data-retention:
54+
55+
Data retention
56+
--------------
57+
58+
.. versionadded:: 26.0.0
59+
60+
You can configure how long Nextcloud keeps some of the contacts data.
61+
62+
Sync tokens
63+
^^^^^^^^^^^
64+
65+
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::
66+
67+
php occ config:app:set totalNumberOfSyncTokensToKeep --value=30000
68+
69+
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.
70+
71+
.. warning:: This setting will also influence :ref:`CalDAV data retention<caldav-data-retention>`.

admin_manual/release_notes/upgrade_to_26.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ A brief overview of changes:
2121

2222
See for more information: :ref:`email-smtp-config`.
2323

24+
DAV data retention
25+
------------------
26+
27+
A mechanism to clean up old CalDAV and CardDAV data has been added. See :ref:`CalDAV retention <caldav-data-retention>` and :ref:`CardDAV retention <carddav-data-retention>` and make sure it fits your installation size.
2428

2529
Web server configuration
2630
------------------------

0 commit comments

Comments
 (0)