Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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-0.7.0{version}-driver.jar 
  • When 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 dirs

    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-1.0.0{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 -w mypassword

...