This package provides a simple way to use S3 with Payload.
NOTE: This package removes the need to use @payloadcms/plugin-cloud-storage
as was needed in Payload 2.x.
pnpm add @payloadcms/storage-s3
- Configure the
collections
object to specify which collections should use the AWS S3 adapter. The slug must match one of your existing collection slugs. - The
config
object can be anyS3ClientConfig
object (from@aws-sdk/client-s3
). This is highly dependent on your AWS setup. Check the AWS documentation for more information. - When enabled, this package will automatically set
disableLocalStorage
totrue
for each collection. - When deploying to Vercel, server uploads are limited with 4.5MB. Set
clientUploads
totrue
to do uploads directly on the client. You must allow CORS PUT method for the bucket to your website.
import { s3Storage } from '@payloadcms/storage-s3'
import { Media } from './collections/Media'
import { MediaWithPrefix } from './collections/MediaWithPrefix'
export default buildConfig({
collections: [Media, MediaWithPrefix],
plugins: [
s3Storage({
collections: {
media: true,
'media-with-prefix': {
prefix,
},
},
bucket: process.env.S3_BUCKET,
config: {
credentials: {
accessKeyId: process.env.S3_ACCESS_KEY_ID,
secretAccessKey: process.env.S3_SECRET_ACCESS_KEY,
},
region: process.env.S3_REGION,
// ... Other S3 configuration
},
}),
],
})
See the the AWS SDK Package and S3ClientConfig
object for guidance on AWS S3 configuration.