Antoine du Hamel 0f9709bb10 @uppy/aws-s3: refactor to private fields (#3076) 3 years ago
..
src 0f9709bb10 @uppy/aws-s3: refactor to private fields (#3076) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE 6219ee77f7 Move `AwsS3` to `@uppy/aws-s3` 6 years ago
README.md c48064ba56 doc: lint JS code snippets (#2954) 3 years ago
package.json b5411ff78c deps: remove `qs-stringify` from dependencies (#3077) 3 years ago

README.md

@uppy/aws-s3

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

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

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.