payload-plugin-cloud-storage-ali v1.0.1

Payload Cloud Storage Plugin

This repository contains the officially supported Payload Cloud Storage plugin. It extends Payload to allow you to store all uploaded media in third-party permanent storage.

Requirements

• Payload version 1.0.19 or higher is required

Installation

yarn add payload-plugin-cloud-storage-ali or npm install payload-plugin-cloud-storage-ali

Usage

Add this package into your dependencies executing this code in your command line:

yarn add payload-plugin-cloud-storage-ali

Now install this plugin within your Payload as follows:

import { buildConfig } from 'payload/config';
import path from 'path';
import { cloudStorage } from 'payload-plugin-cloud-storage-ali';

export default buildConfig({
  plugins: [
    cloudStorage({
      collections: {
        'my-collection-slug': {
          adapter: theAdapterToUse, // see docs for the adapter you want to use
        },
      },
    }),
  ],
  // The rest of your config goes here
});

Conditionally Enabling/Disabling

The proper way to conditionally enable/disable this plugin is to use the enabled property.

cloudStorage({
  enabled: process.env.MY_CONDITION === 'true',
  collections: {
    'my-collection-slug': {
      adapter: theAdapterToUse, // see docs for the adapter you want to use
    },
  },
}),

If the code is included in any way in your config but conditionally disabled in another fashion, you may run into issues such as Webpack Build Error: Can't Resolve 'fs' and 'stream' or similar because the plugin must be run at all times in order to properly extend the webpack config.

Features

Adapter-based Implementation

This plugin supports the following adapters:

• Ali OSS

However, you can create your own adapter for any third-party service you would like to use.

All adapters are implemented dev directory's Payload Config. See this file for examples.

Plugin options

This plugin is configurable to work across many different Payload collections. A * denotes that the property is required.

Collection-specific options:

Ali OSS Adapter

To use the Ali adapter, you need to have ali-oss installed in your project dependencies. To do so, run yarn add ali-oss.

From there, create the adapter, passing in all of its required properties:

import { aliAdapter } from 'payload-plugin-cloud-storage-ali/ali';

const adapter = aliAdapter({
  config: {
    accessKeyId: process.env.ALI_ACCESS_KEY_ID,
    accessKeySecret: process.env.ALI_ACCESS_KEY_SECRET,
    region: process.env.ALI_REGION,
    bucket: process.env.ALI_BUCKET,
    // ... Other Ali configuration
  },
})

// Now you can pass this adapter to the plugin

Payload Access Control

Payload ships with access control that runs even on statically served files. The same read access control property on your upload-enabled collections is used, and it allows you to restrict who can request your uploaded files.

To preserve this feature, by default, this plugin keeps all file URLs exactly the same. Your file URLs won't be updated to point directly to your cloud storage source, as in that case, Payload's access control will be completely bypassed and you would need public readability on your cloud-hosted files.

Instead, all uploads will still be reached from the default /collectionSlug/staticURL/filename path. This plugin will "pass through" all files that are hosted on your third-party cloud service—with the added benefit of keeping your existing access control in place.

If this does not apply to you (your upload collection has read: () => true or similar) you can disable this functionality by setting disablePayloadAccessControl to true. When this setting is in place, this plugin will update your file URLs to point directly to your cloud host.

Credit

This plugin was created with significant help, and code, from Alex Bechmann and Richard VanBergen. Thank you!!