felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

Create syncthing-versioning(7)

Browse Source
This commit is contained in:
Stefan Tatschner
2015-05-29 16:45:03 +02:00
parent e6d0b370d2
commit dada1daded
1 changed files with 44 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
users/versioning.rst
+44 -39
View File
@@ -2,20 +2,33 @@ File Versioning
=============== ===============
.. warning:: .. warning::
This page may be out of date and requires review. This page may be out of date and requires review.
External versioning requires documenting.
There are 3 types of File Versioning. When you select each in the web .. todo::
interface, a short description of each is shown to help you decide. External versioning requires documenting.
Description
-----------
There are 3 types of File Versioning. When you select each in the web interface,
a short description of each is shown to help you decide.
.. todo::
More detail needed here: Can this be a relative path, or must it be
an absolute path?
With "Staggered File Versioning" method (only), you would like to specify where
removed and deleted files are stored as part of the Versioning feature, you can
specify the path in the "Versions Path" input after this method is selected.
No File Versioning No File Versioning
------------------ ------------------
This is the default setting. With no file versioning, files that are This is the default setting. With no file versioning, files that are replaced or
replaced or deleted on one device are deleted on other devices that the deleted on one device are deleted on other devices that the directory is shared
directory is shared with. (Note: If a folder is marked "Master Folder" with. (Note: If a folder is marked "Master Folder" on a device, that device will
on a device, that device will not accept changes to the files in the not accept changes to the files in the folder, and therefore will not have files
folder, and therefore will not have files replaced or deleted.) replaced or deleted.)
Simple File Versioning Simple File Versioning
---------------------- ----------------------
@@ -28,41 +41,33 @@ should keep. For example, if you set this value to 5, if a file is
replaced 5 times on a remote device, you will see 5 time-stamped replaced 5 times on a remote device, you will see 5 time-stamped
versions on that file in the ".stversions" folder on the other devices versions on that file in the ".stversions" folder on the other devices
sharing the same folder. sharing the same folder.
With "Simple File Versioning" files are moved to the ".stversions" folder
(inside your shared folder) when replaced or deleted on a remote device. This
option also takes a value in an input titled "Keep Versions" which tells
Syncthing how many old versions of the file it should keep. For example, if you
set this value to 5, if a file is replaced 5 times on a remote device, you will
see 5 time-stamped versions on that file in the ".stversions" folder on the
other devices sharing the same folder.
Staggered File Versioning Staggered File Versioning
------------------------- -------------------------
With "Staggered File Versioning" files are also moved to the ".stversions" With "Staggered File Versioning" files are also moved to the ".stversions"
folder (inside your shared folder) when replaced or deleted on a remote device folder (inside your shared folder) when replaced or deleted on a remote device
(just like "Simple File Versioning"), however, Version are automatically (just like "Simple File Versioning"), however, Version are automatically deleted
deleted if they are older than the maximum age or exceed the number of files if they are older than the maximum age or exceed the number of files allowed in
allowed in an interval. an interval.
The following intervals are used and they each have a maximum number of The following intervals are used and they each have a maximum number of files
files that will be kept for each. that will be kept for each.
- 1 Hour - For the first hour, the most recent version is kept every 30 1 Hour
seconds. For the first hour, the most recent version is kept every 30 seconds.
- 1 Day - For the first day, the most recent version is kept every 1 Day
hour. For the first day, the most recent version is kept every hour.
- 30 Days - For the first 30 days, the most recent version is kept 30 Days
every day. For the first 30 days, the most recent version is kept every day.
- Until Maximum Age - Until the maximum age, the most recent version is Until Maximum Age
kept every week. The maximum time to keep a version in days. For example, to keep replaced or
deleted files in the ".stversions" folder for an entire year, use 365. If
Maximum Age only or 10 days, use 10. **Note: Set to 0 to keep versions forever.**
~~~~~~~~~~~
The "Maximum Age" input is the maximum time to keep a version in days.
For example, to keep replaced or deleted files in the ".stversions"
folder for an entire year, use 365. If only for 10 days, use 10. **Note:
Set to 0 to keep versions forever.**
Versions Path
~~~~~~~~~~~~~
With "Staggered File Versioning" method (only), if you would like to
specify where removed and deleted files are stored as part of the
Versioning feature, you can specify the path in the "Versions Path"
input after this method is selected. [*More detail needed here: Can this
be a relative path, or must it be an absolute path?*\ ]