Skip to content

Commit 7c05d23

Browse files
mnocondabrt
andcommitted
Added description of the grace period (#2696)
* Added description of the grace period * Fixed "in parallel" usage * Wording * Update docs/administration/configuration/repository_configuration.md * Apply suggestions from code review Co-authored-by: Tomasz Dąbrowski <[email protected]> --------- Co-authored-by: Tomasz Dąbrowski <[email protected]>
1 parent 04e07b3 commit 7c05d23

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/administration/configuration/repository_configuration.md

+20
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,26 @@ This limit is enforced on publishing a new version and only covers archived vers
198198
In Legacy storage engine you can see performance degradation if you store too many versions.
199199
The default value of 5 is the recommended value, but the less content you have overall, the more you can increase this to, for instance, 25 or even 50.
200200

201+
### Grace period for archived versions
202+
203+
After a new version of a content item is published, the previous version, now archived, can still be loaded for a certain period of time, using the same permission set as the published version.
204+
205+
This period is called the grace period and it prevents race conditions that can occur when a new version is published at the same time as someone is accessing the content item.
206+
207+
The duration can be configured using the `grace_period_in_seconds` setting.
208+
After a version has been archived for longer than specified in the configuration, the grace period ends and the version is treated the same as all the other archived versions, including the need of [`content/versionread` policy](policies.md#content) to access it.
209+
210+
``` yaml
211+
ibexa:
212+
repositories:
213+
default:
214+
options:
215+
grace_period_in_seconds: 30
216+
```
217+
218+
`grace_period_in_seconds` uses the [PHP's `max_execution_time`](https://www.php.net/manual/en/info.configuration.php#ini.max-execution-time) value by default.
219+
Set the value to 0 to disable grace period for archived versions.
220+
201221
### Removing versions on publication
202222

203223
With `remove_archived_versions_on_publish` setting, you can control whether versions that exceed the limit are deleted when you publish a new version.

0 commit comments

Comments
 (0)