Files

Sasha fc42c40883 fix(storage-s3, storage-azure, storage-gcs): client uploads when a collection has prefix configured (#11436 )

### What?
Fixes client uploads when storage collection config has the `prefix`
property configured. Previously, it failed with "Object key was not
found".

### Why?
This is expected to work.

### How?
The client upload handler now receives to its props `prefix`. Then it
threads it to the server-side `staticHandler` through
`clientUploadContext` and then to `getFilePrefix`, which checks for
`clientUploadContext.prefix` and returns if there is.

Previously, `staticHandler` tried to load the file without including
prefix consideration.

This changes only these adapters:
* S3
* Azure
* GCS

With the Vercel Blob adapter, `prefix` works correctly.

2025-02-28 15:50:23 -05:00

src

fix(storage-s3, storage-azure, storage-gcs): client uploads when a collection has prefix configured (#11436 )

2025-02-28 15:50:23 -05: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

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

2025-02-27 12:06:03 -05: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`