Update GUIDE.md

DESIGN.md

@@ -16,7 +16,7 @@ time the rolling hash window is shifted by one byte, thus significantly reducing
 What is novel about lock-free deduplication is the absence of a centralized indexing database for tracking all existing
 chunks and for determining which chunks are not needed any more.  Instead, to check if a chunk has already been uploaded
 before, one can just perform a file lookup via the file storage API using the file name derived from the hash of the chunk.
-This effectively turn a cloud storage offering only a very limited
+This effectively turns a cloud storage offering only a very limited
 set of basic file operations into a powerful modern backup backend capable of both block-level and file-level deduplication.  More importantly, the absence of a centralized indexing database means that there is no need to implement a distributed locking mechanism on top of the file storage.
 
 By eliminating the chunk indexing database, lock-free duplication not only reduces the code complexity but also makes the deduplication less error-prone.  Each chunk is saved individually in its own file, and once saved there is no need for modification.  Data corruption is therefore less likely to occur because of the immutability of chunk files.  Another benefit that comes naturally from lock-free duplication is that when one client creates a new chunk, other clients that happen to have the same original file will notice that the chunk  already exist and therefore will not upload the same chunk again.  This pushes the deduplication to its highest level -- clients without knowledge of each other can share identical chunks with no extra effort.
@@ -137,7 +137,7 @@ hasn't been found, the next file, if there is one, will be read in and the chunk
 files were packed into a big tar file which is then split into chunks.
 
 The *content* field of a file indicates the indexes of starting and ending chunks and the corresponding offsets. For
-instance, *fiel1* starts at chunk 0 offset 0 while ends at chunk 2 offset 6108, immediately followed by *file2*.
+instance, *file1* starts at chunk 0 offset 0 while ends at chunk 2 offset 6108, immediately followed by *file2*.
 
 The backup procedure can run in one of two modes. In the default quick mode, only modified or new files are scanned. Chunks only
 referenced by old files that have been modified are removed from the chunk sequence, and then chunks referenced by new 
@@ -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.
 
-There 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 file storage, encrypted with a master key derived from the PBKDF2 function on
 the storage password chosen by the user.
 

GUIDE.md

@@ -160,6 +160,7 @@ OPTIONS:
    -fossils                 search fossils if a chunk can't be found
    -resurrect               turn referenced fossils back into chunks
    -files                   verify the integrity of every file
+   -stats 			show deduplication statistics (imply -all and all revisions)
    -storage <storage name>  retrieve snapshots from the specified storage```
 ```
 The *check* command checks, for each specified snapshot, that all referenced chunks exist in the storage.
@@ -457,7 +458,7 @@ For the *restore* command, the include/exclude patterns are specified as the com
 
 Duplicacy will attempt to retrieve in three ways the storage password and the storage-specific access tokens/keys.
 
-* If a secret vault service is available, Duplicacy will store the password input by the user in such a secret vault and later retrieve it when needed.  On Mac OS X it is Keychain, and on Linux it is gnome-keyring.  On Windows the password is encrypted and decrypted by the Data Protection API, and encrypted password is stored in the file *.duplicacy/keyring*.  However, if the -no-save-password option is specified for the storage, then Duplicacy will not save passwords this way
+* If a secret vault service is available, Duplicacy will store passwords/keys entered by the user in such a secret vault and later retrieve them when needed.  On Mac OS X it is Keychain, and on Linux it is gnome-keyring.  On Windows the passwords/keys are encrypted and decrypted by the Data Protection API, and encrypted passwords/keys are stored in the file *.duplicacy/keyring*.  However, if the -no-save-password option is specified for the storage, then Duplicacy will not save passwords this way.
 * If an environment variable for a password is provided, Duplicacy will always take it.  The table below shows the name of the environment variable for each kind of password.  Note that if the storage is not the default one, the storage name will be included in the name of the environment variable.
 * If a matching key and its value are saved to the preference file (.duplicacy/preferences) by the *set* command, the value will be used as the password.  The last column in the table below lists the name of the preference key for each type of password.
 
@@ -467,10 +468,13 @@ Duplicacy will attempt to retrieve in three ways the storage password and the st
 | sftp password | DUPLICACY_SSH_PASSWORD | DUPLICACY_&lt;STORAGENAME&gt;_SSH_PASSWORD | ssh_password |
 | 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 Secret Key | DUPLICACY_S3_KEY | DUPLICACY_&lt;STORAGENAME&gt;_S3_KEY | s3_key |
+| S3 Secret Key | DUPLICACY_S3_SECRET | DUPLICACY_&lt;STORAGENAME&gt;_S3_SECRET | s3_secret |
 | BackBlaze Account ID | DUPLICACY_B2_ID | DUPLICACY_&lt;STORAGENAME&gt;_B2_ID | b2_id |
 | Backblaze Application Key | DUPLICACY_B2_KEY | DUPLICACY_&lt;STORAGENAME&gt;_B2_KEY | b2_key |
 | Azure Access Key | DUPLICACY_AZURE_KEY | DUPLICACY_&lt;STORAGENAME&gt;_AZURE_KEY | azure_key |
+| Google Drive Token File | DUPLICACY_GCD_TOKEN | DUPLICACY_&lt;STORAGENAME&gt;_GCD_TOKEN | gcd_token |
+| Microsoft OneDrive Token File | DUPLICACY_ONE_TOKEN | DUPLICACY_&lt;STORAGENAME&gt;_ONE_TOKEN | one_token |
+| Hubic Token File | DUPLICACY_HUBIC_TOKEN | DUPLICACY_&lt;STORAGENAME&gt;_HUBIC_TOKEN | hubic_token |
 
 Note that the passwords stored in the environment variable and the preference need to be in plaintext and thus are insecure and should be avoided whenever possible.
 

README.md

@@ -1,10 +1,12 @@
-# Duplicacy: A new generation cloud backup tool
+# Duplicacy: A lock-free deduplication cloud backup tool
 
-This repository contains only binary releases and documentation for Duplicacy.  It also serves as an issue tracker for user-developer communication during the beta testing phase.
+Duplicacy is a new generation cross-platform cloud backup tool based on the idea of [Lock-Free Deduplication](https://github.com/gilbertchen/duplicacy-beta/blob/master/DESIGN.md).  It is the only cloud backup tool that allows multiple computers to back up to the same storage simultaneously without using any locks (thus readily amenable to various cloud storage services).
 
-## Overview
+The repository hosts design documents as well as binary releases of the command line version.  There is also a Duplicacy GUI frontend built for Windows and Mac OS X downloadable from https://duplicacy.com.  The source code of the command line version is available to the commercial users of the Duplicacy GUI version upon request.
 
-Duplicacy supports major cloud storage providers (Amazon S3, Google Cloud Storage, Microsoft Azure, Dropbox, and BackBlaze) and offers all essential features of a modern backup tool:
+## Features
+
+Duplicacy currently supports major cloud storage providers (Amazon S3, Google Cloud Storage, Microsoft Azure, Dropbox, Backblaze, Google Drive, Microsoft OneDrive, and Hubic) and offers all essential features of a modern backup tool:
 
 * Incremental backup: only back up what has been changed
 * Full snapshot : although each backup is incremental, it must behave like a full snapshot for easy restore and deletion
@@ -14,7 +16,7 @@ Duplicacy supports major cloud storage providers (Amazon S3, Google Cloud Storag
 * Concurrent access: multiple clients can back up to the same storage at the same time
 * Snapshot migration: all or selected snapshots can be migrated from one storage to another
 
-The key idea behind Duplicacy is a concept called **Lock-Free Deduplication**, which can be summarized as follows:
+The key idea of **Lock-Free Deduplication** can be summarized as follows:
 
 * Use variable-size chunking algorithm to split files into chunks
 * Store each chunk in the storage using a file name derived from its hash, and rely on the file system API to manage chunks without using a centralized indexing database
@@ -153,7 +155,7 @@ Storage URL:  azure://account/container
 
 You'll need to input the access key once prompted.
 
-#### BackBlaze
+#### Backblaze
 
 ```
 Storage URL: b2://bucket
@@ -161,7 +163,37 @@ Storage URL: b2://bucket
 
 You'll need to input the account id and application key.
 
-BackBlaze offers perhaps the least expensive cloud storage at 0.5 cent per GB per month.  Unfortunately their API does not support file renaming, so the -exclusive option is required when pruning old backups.  This means concurrent access and deletion can't be permitted at the same time.
+Backblaze's B2 storage is not only the least expensive (at 0.5 cent per GB per month), but also the fastest.  We have been working closely with their developers to leverage the full potentials provided by the B2 API in order to maximumize the transfer speed.  As a result, the B2 storage is the only one to support the multi-threading option which can easily max out your upload link.
+
+#### Google Drive
+
+```
+Storage URL: gcd://path/to/storage
+```
+
+To use Google Drive as the storage,  you first need to download a token file from https://duplicacy.com/gcd_start by
+authorizing Duplicacy to access your Google Drive, and then enter the path to this token file to Duplicacy when prompted.
+
+#### Microsoft OneDrive
+
+```
+Storage URL: one://path/to/storage
+```
+
+To use Microsoft OneDrive as the storage,  you first need to download a token file from https://duplicacy.com/one_start by
+authorizing Duplicacy to access your OneDrive, and then enter the path to this token file to Duplicacy when prompted.
+
+#### Hubic
+
+```
+Storage URL: hubic://path/to/storage
+```
+
+To use Hubic as the storage,  you first need to download a token file from https://duplicacy.com/hubic_start by
+authorizing Duplicacy to access your Hubic drive, and then enter the path to this token file to Duplicacy when prompted.
+
+Hubic offers the most free space (25GB) of all major cloud providers and there is no bandwidth charge (same as Google Drive and OneDrive), so it may be worth a try.
+
 
 ## Comparison with Other Backup Tools
 
@@ -195,6 +227,10 @@ The following table compares the feature lists of all these backup tools:
 | Encryption         | Yes       | Yes | Yes               | Yes             | Yes               | **Yes**       |
 | Deletion           | No        | No  | Yes               | Yes             | No                | **Yes**       |
 | Concurrent Access  | No        | No  | Exclusive locking | Not recommended | Exclusive locking | **Lock-free** |
-| Cloud Support      | Extensive | No  | No                | No              | S3 only           | **S3, GCS, Azure, Dropbox, BackBlaze**|
+| Cloud Support      | Extensive | No  | No                | No              | S3 only           | **S3, GCS, Azure, Dropbox, Backblaze, Google Drive, OneDrive, and Hubic**|
 | 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.