Tobias L. Maier e5c854e12a Add cuid dependency to @uppy/aws-s3 (#2236) 5 years ago
..
src 908598c5d8 Fix build locales (#2221) 5 years ago
types ad14a01ae9 aws-s3: fix missing typescript type for `metaFields` option 5 years ago
LICENSE 6219ee77f7 Move `AwsS3` to `@uppy/aws-s3` 6 years ago
README.md f4e558bf94 rename serverUrl to companionUrl 6 years ago
package.json e5c854e12a Add cuid dependency to @uppy/aws-s3 (#2236) 5 years ago

README.md

@uppy/aws-s3

Build Status

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

const Uppy = require('@uppy/core')
const AwsS3 = require('@uppy/aws-s3')

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

Installation

$ npm install @uppy/aws-s3 --save

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.