feat(docs): extend backup docu to mention command

Signed-off-by: jkoberg <jkoberg@owncloud.com>
owncloud · Jun 6, 2024 · e046768 · e046768
1 parent 1525f7e
commit e046768
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/ocis/backup.md b/docs/ocis/backup.md
@@ -217,3 +217,12 @@ BACKUP RECOMMENDED/OMITABLE. This folder contains custom web assets. Can be spec
 
 When using an external idp/idm/nats or blobstore, its data needs to be backed up separately. Refer to your idp/idm/nats/blobstore documentation for backup details.
 
+## Backup Consistency command
+
+Infinite Scale now allows checking an existing backup for consistency. Use command
+```bash
+ocis backup consistency -p "<path-to-base-folder>"
+```
+
+`path-to-base-folder` needs to be replaced with the path to the storage providers base path. For example: "/var/lib/ocis/storage/users" or "$HOME/storage/users".
+Use the `-b s3ng` when using an external (s3) blobstore. Note: When using this flag the blobstore must be configured via envvars or yaml file the same as in ocis. Consistency checks for other blobstores than `ocis` and `s3ng` are not supported at the moment.