Files

Sasha b540da53ec feat(storage-*): large file uploads on Vercel (#11382 )

Currently, usage of Payload on Vercel has a limitation - uploads are
limited by 4.5MB file size.
This PR allows you to pass `clientUploads: true` to all existing storage
adapters
* Storage S3
* Vercel Blob
* Google Cloud Storage
* Uploadthing
* Azure Blob

And then, Payload will do uploads on the client instead. With the S3
Adapter it uses signed URLs and with Vercel Blob it does this -
https://vercel.com/guides/how-to-bypass-vercel-body-size-limit-serverless-functions#step-2:-create-a-client-upload-route.
Note that it doesn't mean that anyone can now upload files to your
storage, it still does auth checks and you can customize that with
`clientUploads.access`


https://github.com/user-attachments/assets/5083c76c-8f5a-43dc-a88c-9ddc4527d91c

Implements https://github.com/payloadcms/payload/discussions/7569
feature request.

2025-02-26 21:59:34 +02:00

src

feat(storage-*): large file uploads on Vercel (#11382 )

2025-02-26 21:59:34 +02: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

eslint.config.js

chore(eslint): FlatConfig type deprecated, set to Config

2024-09-20 22:46:40 -04:00

LICENSE.md

chore: update year in licenses (#10463 )

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

package.json

feat(storage-*): large file uploads on Vercel (#11382 )

2025-02-26 21:59:34 +02:00

README.md

feat(storage-*): large file uploads on Vercel (#11382 )

2025-02-26 21:59:34 +02:00

tsconfig.json

chore: make TypeScript strict by default in packages and 7 packages stricter (#10579 )

2025-01-14 21:39:40 +00:00

README.md

Google Cloud Storage for Payload

This package provides a simple way to use Google Cloud Storage 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-gcs

Usage

Configure the collections object to specify which collections should use the Google Cloud Storage adapter. The slug must match one of your existing collection slugs.
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.

import { gcsStorage } from '@payloadcms/storage-gcs'
import { Media } from './collections/Media'
import { MediaWithPrefix } from './collections/MediaWithPrefix'

export default buildConfig({
  collections: [Media, MediaWithPrefix],
  plugins: [
    gcsStorage({
      collections: {
        media: true,
        'media-with-prefix': {
          prefix,
        },
      },
      bucket: process.env.GCS_BUCKET,
      options: {
        apiEndpoint: process.env.GCS_ENDPOINT,
        projectId: process.env.GCS_PROJECT_ID,
      },
    }),
  ],
})

Configuration Options

Option	Description	Default
`enabled`	Whether or not to enable the plugin	`true`
`collections`	Collections to apply the storage to
`bucket`	The name of the bucket to use
`options`	Google Cloud Storage client configuration. See Docs
`acl`	Access control list for files that are uploaded	`Private`