thorp/README.org

• s3thorp
• Usage
• Creating Native Images
• TO DO

s3thorp

Synchronisation of files with S3 using the hash of the file contents.

Based on Alex Kudlick's JavaScript implementation aws-s3-sync-by-hash.

The normal aws s3 sync ... command only uses the time stamp of files to decide what files need to be copied. This utility looks at the md5 hash of the file contents.

Usage

s3thorp
Usage: S3Thorp [options]

  -s, --source <value>  Source directory to sync to S3
  -b, --bucket <value>  S3 bucket name
  -p, --prefix <value>  Prefix within the S3 Bucket

Creating Native Images

• Download and install GraalVM

  • https://github.com/oracle/graal/releases

• Install native-image using the graal updater

    gu install native-image
  

• Create native image

    native-image -cp `sbt 'export runtime:fullClasspath'|tail -n 1` \
                 -H:Name=s3thorp \
                 -H:Class=net.kemitix.s3thorp.Main \
                 --allow-incomplete-classpath \
                 --force-fallback
  

• Resulting file requires a JDK for execution

TO DO

• [x] Improve test coverage
• Create os-native binaries
• [x] Replace println with real logging
• Add support for logging options
• Add support for exclusion filters
• Bulk fetching of Hash values from S3
• ? When lastModified matches local file, skip calculating local MD5 ?
• Add support for multi-part uploads for large files
• Add support for upload progress - may only be available with multi-part uploads