Artifacts documentation: Add section for summary file updates

1 files changed, 17 insertions, 0 deletions

diff --git a/doc/source/artifacts.rst b/doc/source/artifacts.rst
index add9d19c7..1f801c080 100644
--- a/doc/source/artifacts.rst
+++ b/doc/source/artifacts.rst
@@ -117,6 +117,23 @@ For this you will want something like the following in your ``/etc/ssh/sshd_conf
         ForceCommand bst-artifact-receive --verbose artifacts
 
 
+Summary file updates
+--------------------
+BuildStream uses the OSTree summary file to determine what artifacts are
+available in the remote artifact cache. ``ostree summary -u`` updates
+the summary file. This command cannot be run concurrently and thus it
+cannot be executed by ``bst-artifact-receive``, it has to be triggered
+externally.
+
+A simple way to configure this is to set up a cron job that triggers the
+summary file update every 5 minutes.
+E.g., create ``/etc/cron.d/artifacts`` with the following content:
+
+.. code::
+
+   */5 * * * * artifacts ostree --repo=/home/artifacts/artifacts summary -u
+
+
 User Configuration
 ------------------
 The user configuration for artifacts is documented with the rest