Compare commits

...

9 Commits

Author SHA1 Message Date
gilbertchen
8cb6635ba6 Update GUIDE.md 2017-03-22 10:06:23 -04:00
gilbertchen
ee56652c90 Update README.md 2017-03-20 23:03:10 -04:00
gilbertchen
cd7f18f284 Update GUIDE.md 2017-03-02 12:50:43 -05:00
gilbertchen
18766c86dc Merge pull request #42 from danthelion/patch-1
Fix include/exclude pattern description in GUIDE.md
2017-02-24 10:28:28 -05:00
Daniel Palma
f8d2671038 Fix include/exclude pattern description in GUIDE.md
Include/Exclude pattern prefixes have been switched up in the documentation. It could cause some confusion. :)
2017-02-24 10:45:03 +01:00
gilbertchen
1d12fa3dd8 Update GUIDE.md 2017-01-29 10:42:42 -05:00
gilbertchen
6c793f25ee Update README.md 2016-11-14 21:48:06 -05:00
gilbertchen
901605ca68 Update README.md 2016-11-14 21:47:41 -05:00
gilbertchen
1f83a6e793 Update DESIGN.md 2016-11-12 23:14:28 -05:00
3 changed files with 28 additions and 6 deletions

View File

@@ -210,6 +210,6 @@ Chunk content is encrypted by AES-GCM, with an encryption key that is the HMAC-S
The snapshot is encrypted by AES-GCM too, using an encrypt key that is the HMAC-SHA256 of the file path with the *File Key* as the secret key. The snapshot is encrypted by AES-GCM too, using an encrypt key that is the HMAC-SHA256 of the file path with the *File Key* as the secret key.
These four random keys are saved in a file named 'config' in the file storage, encrypted with a master key derived from the PBKDF2 function on These four random keys are saved in a file named 'config' in the storage, encrypted with a master key derived from the PBKDF2 function on
the storage password chosen by the user. the storage password chosen by the user.

View File

@@ -51,6 +51,8 @@ OPTIONS:
-hash detect file differences by hash (rather than size and timestamp) -hash detect file differences by hash (rather than size and timestamp)
-t <tag> assign a tag to the backup -t <tag> assign a tag to the backup
-stats show statistics during and after backup -stats show statistics during and after backup
-threads <n> number of uploading threads (Backblaze only)
-limit-rate <kB/s> the maximum upload rate (in kilobytes/sec)
-vss enable the Volume Shadow Copy service (Windows only) -vss enable the Volume Shadow Copy service (Windows only)
-storage <storage name> backup to the specified storage instead of the default one -storage <storage name> backup to the specified storage instead of the default one
``` ```
@@ -61,9 +63,13 @@ Otherwise, every file is scanned to detect changes.
You can assign a tag to the snapshot so that later you can refer to it by tag in other commands. You can assign a tag to the snapshot so that later you can refer to it by tag in other commands.
If the -stats option is specified, statistical information such as transfer speed, number of chunks will be displayed If the -stats option is specified, statistical information such as transfer speed, the number of chunks will be displayed
throughout the backup procedure. throughout the backup procedure.
The -threads option can be used to specify more than one thread to upload chunks. Currently this option is available only when the Backblaze B2 storage is selected.
The -limit-rate option sets a cape on the maximum upload rate.
The -vss option works on Windows only to turn on the Volume Shadow Copy service such that files opened by other The -vss option works on Windows only to turn on the Volume Shadow Copy service such that files opened by other
processes with exclusive locks can be read as usual. processes with exclusive locks can be read as usual.
@@ -86,6 +92,7 @@ OPTIONS:
-overwrite overwrite existing files in the repository -overwrite overwrite existing files in the repository
-delete delete files not in the snapshot -delete delete files not in the snapshot
-stats show statistics during and after restore -stats show statistics during and after restore
-limit-rate <kB/s> the maximum download rate (in kilobytes/sec)
-storage <storage name> restore from the specified storage instead of the default one -storage <storage name> restore from the specified storage instead of the default one
``` ```
@@ -99,6 +106,8 @@ The -delete option indicates that files not in the snapshot will be removed.
If the -stats option is specified, statistical information such as transfer speed, number of chunks will be displayed If the -stats option is specified, statistical information such as transfer speed, number of chunks will be displayed
throughout the restore procedure. throughout the restore procedure.
The -limit-rate option sets a cape on the maximum upload rate.
When the repository can have multiple storages (added by the *add* command), you can select the storage to restore from by specifying the storage name. When the repository can have multiple storages (added by the *add* command), you can select the storage to restore from by specifying the storage name.
Unlike the *backup* procedure that reading the include/exclude patterns from a file, the *restore* procedure reads them Unlike the *backup* procedure that reading the include/exclude patterns from a file, the *restore* procedure reads them
@@ -444,16 +453,25 @@ destination storage and is required.
## Include/Exclude Patterns ## Include/Exclude Patterns
An include pattern starts with -, and an exclude pattern starts with +. Patterns may contain wildcard characters such as * and ? with their normal meaning. An include pattern starts with +, and an exclude pattern starts with -. Patterns may contain wildcard characters such as * and ? with their normal meaning.
When matching a path against a list of patterns, the path is compared with the part after + or -, one pattern at a time. Therefore, the order of the patterns is significant. If a match with an include pattern is found, the path is said to be included without further comparisons. If a match with an exclude pattern is found, the path is said to be excluded without further comparison. If a match is not found, the path will be excluded if all patterns are include patterns, but included otherwise. When matching a path against a list of patterns, the path is compared with the part after + or -, one pattern at a time. Therefore, the order of the patterns is significant. If a match with an include pattern is found, the path is said to be included without further comparisons. If a match with an exclude pattern is found, the path is said to be excluded without further comparison. If a match is not found, the path will be excluded if all patterns are include patterns, but included otherwise.
Note that the path in Duplicacy for a directory always ends with a /, even on Windows. The path of a file does not end with a /. This can be used to exclude directories only. Patterns ending with a / apply to directories only, and patterns not ending with a / apply to files only. When a directory is excluded, all files and subdirectires under it will also be excluded. Note that the path separator is always /, even on Windows.
The following pattern list includes only files under the directory foo/ but not files under the subdirectory foo/bar:
```
-foo/bar/
+foo/*
-*
```
For the *backup* command, the include/exclude patterns are read from a file named *filters* under the *.duplicacy* directory. For the *backup* command, the include/exclude patterns are read from a file named *filters* under the *.duplicacy* directory.
For the *restore* command, the include/exclude patterns are specified as the command line arguments. For the *restore* command, the include/exclude patterns are specified as the command line arguments.
## Managing Passwords ## Managing Passwords
Duplicacy will attempt to retrieve in three ways the storage password and the storage-specific access tokens/keys. Duplicacy will attempt to retrieve in three ways the storage password and the storage-specific access tokens/keys.
@@ -466,6 +484,7 @@ Duplicacy will attempt to retrieve in three ways the storage password and the st
|:----------------:|:----------------:|:----------------:|:----------------:| |:----------------:|:----------------:|:----------------:|:----------------:|
| storage password | DUPLICACY_PASSWORD | DUPLICACY_&lt;STORAGENAME&gt;_PASSWORD | password | | storage password | DUPLICACY_PASSWORD | DUPLICACY_&lt;STORAGENAME&gt;_PASSWORD | password |
| sftp password | DUPLICACY_SSH_PASSWORD | DUPLICACY_&lt;STORAGENAME&gt;_SSH_PASSWORD | ssh_password | | sftp password | DUPLICACY_SSH_PASSWORD | DUPLICACY_&lt;STORAGENAME&gt;_SSH_PASSWORD | ssh_password |
| sftp key file | DUPLICACY_SSH_KEY_FILE | DUPLICACY_&lt;STORAGENAME&gt;_SSH_KEY_FILE | ssh_keyfile |
| Dropbox Token | DUPLICACY_DROPBOX_TOKEN | DUPLICACY_&lt;STORAGENAME>&gt;_DROPBOX_TOKEN | dropbox_token | | Dropbox Token | DUPLICACY_DROPBOX_TOKEN | DUPLICACY_&lt;STORAGENAME>&gt;_DROPBOX_TOKEN | dropbox_token |
| S3 Access ID | DUPLICACY_S3_ID | DUPLICACY_&lt;STORAGENAME&gt;_S3_ID | s3_id | | S3 Access ID | DUPLICACY_S3_ID | DUPLICACY_&lt;STORAGENAME&gt;_S3_ID | s3_id |
| S3 Secret Key | DUPLICACY_S3_SECRET | DUPLICACY_&lt;STORAGENAME&gt;_S3_SECRET | s3_secret | | S3 Secret Key | DUPLICACY_S3_SECRET | DUPLICACY_&lt;STORAGENAME&gt;_S3_SECRET | s3_secret |

View File

@@ -231,6 +231,9 @@ The following table compares the feature lists of all these backup tools:
| Snapshot Migration | No | No | No | No | No | **Yes** | | Snapshot Migration | No | No | No | No | No | **Yes** |
##License
Duplicacy is free for personal use but any commercial use must be accompanied by a valid [subscription](https://duplicacy.com/buy.html). This applies to both the CLI and GUI versions. ## License
Duplicacy CLI is free for personal use without restrictions.
For commercial use, a valid [commercial license](https://duplicacy.com/buy.html) is required for each computer on which backups will be created. There are no restrictions if Duplicacy CLI is used to restore files from backups or check the integrity of backups.