@flaconi/serverless-s3-sync

@flaconi/serverless-s3-sync

A plugin to sync local directories and S3 prefixes for Serverless Framework ⚡

🚀 AWS SDK v3 Ready! This is a modernized fork of the original serverless-s3-sync that has been updated to use AWS SDK v3, eliminating the deprecated AWS SDK v2 dependency that reached end-of-life in September 2024.

🆕 What's New in v4.0

• ✅ AWS SDK v3 - Modern, secure, and supported AWS SDK
• ✅ No deprecated dependencies - Removed @auth0/s3 dependency
• ✅ Better performance - Improved upload speeds and memory usage
• ✅ Tree-shaking support - Smaller bundle sizes
• ✅ TypeScript ready - Better IDE support and type safety
• ✅ Node.js 16+ - Modern Node.js support
• ✅ Backward compatible - Drop-in replacement for the original

🔄 Migration from serverless-s3-sync

Simply replace in your package.json:

- "serverless-s3-sync": "^3.4.0"
+ "@flaconi/serverless-s3-sync": "^4.0.0"

And in your serverless.yml:

plugins:
- - serverless-s3-sync
+ - "@flaconi/serverless-s3-sync"

No configuration changes needed! All existing configurations work exactly the same.

📦 Installation

npm install --save @flaconi/serverless-s3-sync

🚀 Usage

Add the plugin to your serverless.yml:

plugins:
  - "@flaconi/serverless-s3-sync"

Configure your S3 sync settings:

custom:
  s3Sync:
    - bucketName: my-static-site-assets
      bucketPrefix: assets/
      localDir: dist/assets

📋 Configuration

All original configuration options are supported:

custom:
  s3Sync:
    - bucketName: my-bucket # required
      bucketPrefix: assets/ # optional
      localDir: dist/assets # required
      deleteRemoved: true # optional, defaults to true
      acl: public-read # optional
      followSymlinks: true # optional
      defaultContentType: text/html # optional
      params: # optional
        - index.html:
            CacheControl: 'no-cache'
        - "*.js":
            CacheControl: 'public, max-age=31536000'
      bucketTags: # optional
        tagKey1: tagValue1
        tagKey2: tagValue2
      enabled: true # optional, defaults to true

🔧 Commands

All original commands work:

# Sync after deployment
sls deploy

# Sync manually
sls s3sync

# Deploy without sync
sls deploy --nos3sync

# Remove with cleanup
sls remove

🌐 Offline Support

Works with serverless-offline and serverless-s3-local:

custom:
  s3Sync:
    endpoint: http://localhost:4569 # for local S3
    buckets:
      - bucketName: my-local-bucket
        localDir: dist/assets

�� Differences from Original

• AWS SDK v3 instead of v2 (@auth0/s3)
• Node.js 16+ requirement (was 10+)
• Improved error handling and logging
• Better TypeScript support
• Smaller bundle size due to tree-shaking

🤝 Contributing

This project maintains backward compatibility with the original serverless-s3-sync. We welcome:

• Bug fixes
• Feature enhancements
• Documentation improvements
• Performance optimizations

📈 Why This Fork?

The original serverless-s3-sync plugin depends on @auth0/s3 which uses AWS SDK v2. AWS ended support for SDK v2 in September 2024, creating security and maintenance concerns for projects using it.

This fork:

• ✅ Eliminates security vulnerabilities
• ✅ Ensures long-term support
• ✅ Improves performance
• ✅ Maintains 100% backward compatibility

🏢 About Flaconi

This package is maintained by Flaconi GmbH, a leading beauty e-commerce platform. We're committed to maintaining this package and keeping it up-to-date with the latest AWS SDK versions.

📄 License

MIT - same as the original project

🙏 Credits

Based on the excellent work by k1LoW and contributors of the original serverless-s3-sync project.

🔗 Links

• Original Project
• AWS SDK v3 Migration Guide
• Serverless Framework

Need help? Open an issue or check our documentation.