uppy/packages/@uppy/aws-s3
2021-10-27 17:53:11 +02:00
..
src Fix AWS S3 upload on React Native (#3064) 2021-10-04 14:34:05 +01:00
types tools: enable linter for TypeScript (#2997) 2021-07-13 14:28:14 +02:00
LICENSE Move AwsS3 to @uppy/aws-s3 2018-06-17 21:52:17 -04:00
package.json meta: use workspace:^ instead of workspace:* (#3278) 2021-10-27 17:53:11 +02:00
README.md Add retext to markdown linter (#3024) 2021-10-14 16:10:45 +02:00

@uppy/aws-s3

Uppy logo: a superman puppy in a pink suit

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

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 Transloadits 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.