https://github.com/sbstjn/serverless-s3bucket-sync

Serverless Plugin to sync local folders with an S3 bucket
https://github.com/sbstjn/serverless-s3bucket-sync

assets aws bucket s3 serverless sync

Last synced: about 1 month ago
JSON representation

Serverless Plugin to sync local folders with an S3 bucket

• Host: GitHub
• URL: https://github.com/sbstjn/serverless-s3bucket-sync
• Owner: sbstjn
• License: mit
• Created: 2017-07-28T11:14:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-28T04:08:27.000Z (almost 5 years ago)
• Last Synced: 2024-10-31T22:03:17.500Z (about 2 months ago)
• Topics: assets, aws, bucket, s3, serverless, sync
• Language: TypeScript
• Size: 83 KB
• Stars: 26
• Watchers: 2
• Forks: 2
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# ⚡️ Serverless Plugin for S3 Sync

[![npm](https://img.shields.io/npm/v/serverless-s3bucket-sync.svg)](https://www.npmjs.com/package/serverless-s3bucket-sync)

[![CircleCI](https://img.shields.io/circleci/project/github/sbstjn/serverless-s3bucket-sync/master.svg)](https://circleci.com/gh/sbstjn/serverless-s3bucket-sync)

[![license](https://img.shields.io/github/license/sbstjn/serverless-s3bucket-sync.svg)](https://github.com/sbstjn/serverless-s3bucket-sync/blob/master/LICENSE.md)

[![Coveralls](https://img.shields.io/coveralls/sbstjn/serverless-s3bucket-sync.svg)](https://coveralls.io/github/sbstjn/serverless-s3bucket-sync)

With this plugin for [serverless](https://serverless.com), you can sync local folders to S3 buckets after your service is deployed.

## Usage

Add the [NPM package](https://www.npmjs.com/package/serverless-s3bucket-sync) to your project:

```bash

# Via yarn

$ yarn add serverless-s3bucket-sync

# Via npm

$ npm install serverless-s3bucket-sync

```

Add the plugin to your `serverless.yml`:

```yaml

plugins:

  - serverless-s3bucket-sync

```

## Configuration

Configure S3 Bucket syncing Auto Scaling in `serverless.yml` with references to your local folder and the name of the S3 bucket.

```yaml

custom:

  s3-sync:

    - folder: relative/folder

      bucket: bucket-name

```

That's it! With the next deployment, [serverless](https://serverless.com) will sync your local folder `relative/folder` with the S3 bucket named `bucket-name`. 

## Sync

You can use `sls sync` to synchornize all buckets without deploying your serverless stack.

## License

Feel free to use the code, it's released using the [MIT license](LICENSE.md).

## Contribution

You are welcome to contribute to this project! 😘 

To make sure you have a pleasant experience, please read the [code of conduct](CODE_OF_CONDUCT.md). It outlines core values and beliefs and will make working together a happier experience.