Skip to content

Commit 9fcdb72

Browse files
ChristophWurstbackportbot[bot]
authored andcommitted
fix(adminmanual): Document data retention and possible issues
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
1 parent a114f1e commit 9fcdb72

3 files changed

Lines changed: 45 additions & 0 deletions

File tree

admin_manual/groupware/calendar.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,3 +206,24 @@ To replace the built-in default event with a custom one:
206206

207207
It is also possible to revert to the default built-in event by pressing the "Reset to default"
208208
button next to the import button.
209+
210+
.. _caldav-data-retention:
211+
212+
Data retention
213+
--------------
214+
215+
.. versionadded:: 26.0.0
216+
217+
You can configure how long Nextcloud keeps some of the calendar sync tokens.
218+
219+
Sync tokens
220+
~~~~~~~~~~~
221+
222+
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::
223+
224+
sudo -E -u www-data php occ config:app:set totalNumberOfSyncTokensToKeep --value=30000
225+
226+
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.
227+
228+
229+
.. 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
@@ -100,3 +100,23 @@ If you want to set a specific contact that should be created.
100100

101101
Switching back to the default example contact provided by nextcloud is possible by pressing the
102102
"Reset to default" button next to the import button.
103+
104+
.. _carddav-data-retention:
105+
106+
Data retention
107+
--------------
108+
109+
.. versionadded:: 26.0.0
110+
111+
You can configure how long Nextcloud keeps some of the contacts sync tokens.
112+
113+
Sync tokens
114+
^^^^^^^^^^^
115+
116+
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::
117+
118+
sudo -E -u www-data php occ config:app:set totalNumberOfSyncTokensToKeep --value=30000
119+
120+
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.
121+
122+
.. 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 sync tokens retention
25+
-------------------------
26+
27+
A mechanism to clean up old CalDAV and CardDAV sync tokens 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)