Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(adminmanual): Document data retention and possible issues #11626

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions admin_manual/groupware/calendar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,24 @@ or::

# Allow users to create calendars/subscriptions without restriction
php occ config:app:set calendar maximumCalendarsSubscriptions --type=integer --value=-1

.. _caldav-data-retention:

Data retention
--------------

.. versionadded:: 26.0.0

You can configure how long Nextcloud keeps some of the calendar data.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can configure how long Nextcloud keeps some of the calendar data.
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::

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<carddav-data-retention>`.
20 changes: 20 additions & 0 deletions admin_manual/groupware/contacts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,23 @@ Shared items
.. versionadded:: 5.5.0

For this feature, the shipped `related resources app <https://apps.nextcloud.com/apps/related_resources>`_ needs to be enabled.

.. _carddav-data-retention:

Data retention
--------------

.. versionadded:: 26.0.0

You can configure how long Nextcloud keeps some of the contacts data.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can configure how long Nextcloud keeps some of the contacts data.
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::

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<caldav-data-retention>`.
4 changes: 4 additions & 0 deletions admin_manual/release_notes/upgrade_to_26.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ A brief overview of changes:

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

DAV data retention
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
DAV data retention
DAV sync tokens retention

------------------

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.


Web server configuration
------------------------
Expand Down
Loading