From 9182e6bab55c87703d11987c19b9fdb463aa6a74 Mon Sep 17 00:00:00 2001
From: DRON-666 <64691982+DRON-666@users.noreply.github.com>
Date: Fri, 6 Nov 2020 06:18:30 +0300
Subject: [PATCH] vss: Update docs and changelog

---
 changelog/unreleased/pull-3067 | 18 ++++++++++++++++++
 doc/040_backup.rst             | 18 ++++++++++++++++++
 2 files changed, 36 insertions(+)
 create mode 100644 changelog/unreleased/pull-3067

diff --git a/changelog/unreleased/pull-3067 b/changelog/unreleased/pull-3067
new file mode 100644
index 000000000..a56c045fa
--- /dev/null
+++ b/changelog/unreleased/pull-3067
@@ -0,0 +1,18 @@
+Enhancement: Add options to configure Windows Shadow Copy Service
+
+Restic always used 120 sec. timeout and unconditionally created VSS snapshots
+for all volume mount points on disk. Now this behavior can be fine-tuned by
+new options, like exclude user specific volumes and mount points or completely
+disable auto snapshotting of volume mount points.
+
+For example:
+
+    restic backup --use-fs-snapshot -o vss.timeout=5m -o vss.excludeallmountpoints=true
+    
+changes timeout to five minutes and disable snapshotting of mount points on all volumes, and
+
+    restic backup --use-fs-snapshot -o vss.excludevolumes="d:\;c:\mnt\;\\?\Volume{e2e0315d-9066-4f97-8343-eb5659b35762}"
+
+excludes drive `D:`, mount point `C:\MNT` and specific volume from VSS snapshotting.
+
+https://github.com/restic/restic/pull/3067
diff --git a/doc/040_backup.rst b/doc/040_backup.rst
index d0bd4b2e2..d1bb39f96 100644
--- a/doc/040_backup.rst
+++ b/doc/040_backup.rst
@@ -56,6 +56,24 @@ snapshot for each volume that contains files to backup. Files are read from the
 VSS snapshot instead of the regular filesystem. This allows to backup files that are
 exclusively locked by another process during the backup.
 
+You can use three additional options to change VSS behaviour:
+
+ * ``-o vss.timeout`` specifies timeout for VSS snapshot creation, the default value is 120 seconds
+ * ``-o vss.excludeallmountpoints`` disable auto snapshotting of all volume mount points
+ * ``-o vss.excludevolumes`` allows excluding specific volumes or volume mount points from snapshotting
+
+E.g., 2.5 minutes timeout with mount points snapshotting disabled can be specified as
+
+.. code-block:: console
+
+    -o vss.timeout=2m30s -o vss.excludeallmountpoints=true
+
+and excluding drive ``D:\``, mount point ``C:\mnt`` and volume ``\\?\Volume{04ce0545-3391-11e0-ba2f-806e6f6e6963}\`` as
+
+.. code-block:: console
+
+    -o vss.excludevolumes="d:;c:\MNT\;\\?\volume{04ce0545-3391-11e0-ba2f-806e6f6e6963}"
+
 By default VSS ignores Outlook OST files. This is not a restriction of restic
 but the default Windows VSS configuration. The files not to snapshot are
 configured in the Windows registry under the following key: