doc/admin/collection-versioning.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: Configuring collection versioning
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 This page describes how to enable and configure the collection versioning feature on the API server.
  14
  15 h3. API Server configuration
  16
  17 There are 2 configuration settings that control this feature, both go on the @application.yml@ file.
  18
  19 h4. Setting: @collection_versioning@ (Boolean. Default: false)
  20
  21 If @true@, collection versioning is enabled, meaning that new version records can be created. Note that if you set @collection_versioning@ to @false@ after being enabled, old versions will still be accessible, but further changes will not be versioned.
  22
  23 h4. Setting: @preserve_version_if_idle@ (Numeric. Default: -1)
  24
  25 This setting control the auto-save aspect of collection versioning, and can be set to:
  26 * @-1@: Never auto-save versions. Only save versions when the client ask for it by setting @preserve_version@ to @true@ on any given collection.
  27 * @0@: Preserve all versions every time a collection gets a versionable update.
  28 * @N@ (being N > 0): Preserve version when a collection gets a versionable update after a period of at least N seconds since the last time it was modified.
  29
  30 h3. Using collection versioning
  31
  32 "Discussed in the user guide":{{site.baseurl}}/user/topics/collection-versioning.html