...
- To run the Sync Tool, open a terminal or command prompt and navigate to the directory where the Sync Tool is located
To display the help for the Sync Tool, run
Code Block java -jar synctool-{version}-driver.jarWhen running the Sync Tool for the first time, you will need to use these options:
Short Option
Long Option
Argument Expected
Required
Description
Default Value (if optional)
-h
--host
Yes
Yes
The host address of the DuraCloud DuraStore application
-r
--port
Yes
No
The port of the DuraCloud DuraStore application
443
-i
--store-id
Yes
No
The Store ID for the DuraCloud storage provider
The primary storage provider is used
-s
--space-id
Yes
Yes
The ID of the DuraCloud space where content will be stored
-u
--username
Yes
Yes
The username necessary to perform writes to DuraStore
-p
--password
Yes
Yes
The password necessary to perform writes to DuraStore
-c
--content-dirs
Yes
Yes
A list of the directory paths to monitor and sync with DuraCloud. If multiple directories are included in this list, they should be separated by a space.
-w
--work-dir
Yes
Yes
The state of the sync tool is persisted to this directory
-f
--poll-frequency
Yes
No
The time (in ms) to wait between each poll of the sync-dirs
10000 (10 seconds)
-t
--threads
Yes
No
The number of threads in the pool used to manage file transfers
3
-m
--max-file-size
Yes
No
The maximum size of a stored file in GB (value must be between 1 and 5), larger files will be split into pieces
1
-d
--sync-deletes
No
No
Indicates that deletes performed on files within the content directories should also be performed on those files in DuraCloud; if this option is not included all deletes are ignored
Not set
-x
--exit-on-completion
No
No
Indicates that the sync tool should exit once it has completed a scan of the content directories and synced all files; if this option is included, the sync tool will not continue to
monitor the content dirsNot set
-l
--clean-start
No
No
Indicates that the sync tool should perform a clean start, ensuring that all files in all content directories are checked against DuraCloud, even if those files have not changed locally since the last run of the sync tool
Not set
-e --exclude Yes No The full path to a file which specifies a set of exclusion rules. The purpose of the exclusion rules is to indicate that certain files or directories should not be transferred to DuraCloud. The rules must be listed one per line in the file. The rules will match only on the name of a file or directory, not an entire path, so path separators should not be included in rules. Rules are not case sensitive (so a rule "test.log" will match a file "test.LOG"). The rules may include wildcard characters ? and *. The ? matches a single character, while * matches 0 or more characters.
Examples of valid rules:
test.txt : Will match a file named "test.txt"
test : Will match a file or directory named "test"
test.* : Will match files like "test.jpg", "test.txt", "test.doc", etc
*.log : Will match files named "test.log" or "daily-01-01-2050.log" as well as a directory named ".log"
backup-19?? : Will match a directory named "backup-1999" but not "backup-190000" or "backup-2000"Not set
When the Sync Tool runs, it creates a backup of your configuration in the work directory that you specify. When running the tool again, you can make use of this file to keep from having to re-enter all of the options specified on the initial run. In this case you need only a single option:
Short Option
Long Option
Argument Expected
Required
Description
-g
--config-file
Yes
Yes
Read configuration from this file (a file containing the most recently used configuration can be found in the work-dir, named synctool.config)
An example for running the Sync Tool
Code Block java -jar synctool-{version}-driver.jar -w C:\tools\synctool\backup -c C:\files\important -f 2000 -h test.duracloud.org -s important-dir-backup -t 5 -u myname -p mypassword
...