Files

Anders Semb Hermansen 36fd6e905a perf(storage-s3): stream files and abort s3 request from static handler (#13430 )

### What?

Stream S3 object directly to response instead of creating a Buffer in
memory and wire up an abort controller to stop streaming if user aborts
download

### Why?

To avoid excessive memory usage and to abort s3 download if user has
aborted the request anyway.

### How?

In node environment the AWS S3 always returns a Readable. The
streamToBuffer method always required this, but the any type hided that
this was actually needed. Now there is an explicit type check, but this
should never trigger in a node server environment.

Wire up and abort controller to the request so that we tell the S3
object to also stop streaming further if the user aborts.

Fixes #10286
Maybe also helps on other issues with s3 and resource usage

2025-08-20 14:53:21 -04:00

src

perf(storage-s3): stream files and abort s3 request from static handler (#13430 )

2025-08-20 14:53:21 -04:00

.prettierignore

feat(plugin-cloud-storage): implement storage packages (#5928 )

2024-04-22 14:31:20 -04:00

.swcrc

feat(plugin-cloud-storage): implement storage packages (#5928 )

2024-04-22 14:31:20 -04:00

docker-compose.yml

feat(plugin-cloud-storage): implement storage packages (#5928 )

2024-04-22 14:31:20 -04:00

LICENSE.md

chore: update year in licenses (#10463 )

2025-01-10 14:05:37 -05:00

package.json

chore(release): v3.52.0 [skip ci]

2025-08-15 10:42:32 -04:00

README.md

feat(storage-s3): dynamic presigned URL downloads (#12706 )

2025-06-09 19:03:06 +00:00

tsconfig.json

fix: reduce global DOM/Node type conflicts in server-only packages (#12737 )

2025-06-11 20:59:19 +00:00

README.md

S3 Storage for Payload

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.

Installation

pnpm add @payloadcms/storage-s3

Usage

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 any S3ClientConfig 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 to true for each collection.
When deploying to Vercel, server uploads are limited with 4.5MB. Set clientUploads to true to do uploads directly on the client. You must allow CORS PUT method for the bucket to your website.
Configure signedDownloads (either globally of per-collection in collections) to use presigned URLs for files downloading. This can improve performance for large files (like videos) while still respecting your access control. Additionally, with signedDownloads.shouldUseSignedURL you can specify a condition whether Payload should use a presigned URL, if you want to use this feature only for specific files.

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,
        },
        'media-with-presigned-downloads': {
          // Filter only mp4 files
          signedDownloads: {
            shouldUseSignedURL: ({ collection, filename, req }) => {
              return filename.endsWith('.mp4')
            },
          },
        },
      },
      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
      },
    }),
  ],
})

Configuration Options

See the the AWS SDK Package and S3ClientConfig object for guidance on AWS S3 configuration.