github-actions[bot] feee2afd63 Release: uppy@3.0.1 (#4068) 2 years ago
..
src e0f17e3753 meta: fix linter warnings (#4039) 2 years ago
types d7180dbb3c @uppy/tus, @uppy/xhr-upload, @uppy/aws-s3: `metaFields` -> `allowedMetaFields` (#4023) 2 years ago
CHANGELOG.md be05bf97df Release: uppy@3.0.0 (#4031) 2 years ago
LICENSE 6219ee77f7 Move `AwsS3` to `@uppy/aws-s3` 6 years ago
README.md 6f9813d9b2 doc: update bundler recommendation (#3763) 2 years ago
package.json feee2afd63 Release: uppy@3.0.1 (#4068) 2 years ago

README.md

@uppy/aws-s3

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

The AwsS3 plugin can be used to upload files directly to an S3 bucket. Uploads can be signed using Companion or a custom signing function.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import AwsS3 from '@uppy/aws-s3'

const uppy = new Uppy()
uppy.use(AwsS3, {
  limit: 2,
  timeout: ms('1 minute'),
  companionUrl: 'https://companion.myapp.com/',
})

Installation

$ npm install @uppy/aws-s3

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.