From 6067e438a368d61fe8170c2c7f7ef1a2ea748d06 Mon Sep 17 00:00:00 2001 From: Yamila Moreno Date: Tue, 18 Mar 2025 11:40:58 +0100 Subject: [PATCH] :books: Document auto file snapshot (#6085) --- docs/technical-guide/configuration.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/technical-guide/configuration.md b/docs/technical-guide/configuration.md index 7770c75f20..f944dbd453 100644 --- a/docs/technical-guide/configuration.md +++ b/docs/technical-guide/configuration.md @@ -489,6 +489,26 @@ PENPOT_STORAGE_ASSETS_S3_ENDPOINT: These settings are equally useful if you have a Minio storage system.

+### Autosave + +By default, Penpot stores manually saved versions indefinitely; these can be found in the History tab and can be renamed, restored, deleted, etc. Additionally, the default behavior of on-premise instances is to not keep automatic version history. This automatic behavior can be modified and adapted to each on-premise installation with the corresponding configuration. + +

+You need to be very careful when configuring automatic versioning, as it can significantly impact the size of your database. If you configure automatic versioning, you'll need to monitor this impact; if you're unsure about this management, we recommend leaving the default settings and using manual versioning. +

+ +This is how configuration looks for auto-file-snapshot + +```bash +PENPOT_FLAGS: enable-auto-file-snapshot # Enable automatic version saving + +# Backend +PENPOT_AUTO_FILE_SNAPSHOT_EVERY: 5 # How many save operations trigger the auto-save-version? +PENPOT_AUTO_FILE_SNAPSHOT_TIIMEOUT: "1h" # How often is an automatic save forced even if the `every` trigger is not met? +``` + +Setting custom values for auto-file-snapshot does not change the behaviour for manual versions. + ## Frontend In comparison with backend, frontend only has a small number of runtime configuration