Skip to content

Latest commit

 

History

History
94 lines (66 loc) · 3.71 KB

README.md

File metadata and controls

94 lines (66 loc) · 3.71 KB
Raw

Medusa File Cloudflare Images

Upload files to the Cloudflare images service.

Description

This plugin is designed to extend off of the medusa commerce engine and provide a file connector to be able to upload images to Cloudflare images.

This plugin is written in Typescript and uses ESBuild to create the bundle and files needed to be included in the medusa.config.js

Installation

npm install medusa-file-cloudflare-images

# or...

yarn add medusa-file-cloudflare-images

Basic Usage

Open your medusa.config.js and add the below configuration

module.exports = {
  plugins: [
    ...otherMedusaPlugins,
    {
      resolve: `medusa-file-cloudflare-images`,
      options: {
        // required
        accountId: process.env.CLOUDFLARE_ACCOUNT_ID,
        apiToken: process.env.CLOUDFLARE_IMAGE_API_TOKEN,
      },
    },
  ],
};

Getting the necessary keys

Click on the link and follow the instructions below.

https://developers.cloudflare.com/images/cloudflare-images/api-request/

CLOUDFLARE_ACCOUNT_ID

The account ID that is associated with your account. Click on the link above and follow the instructions located under the heading Your Cloudflare Account ID

CLOUDFLARE_IMAGE_API_TOKEN

The API token that is going to be used to allow the plugin to upload images to the images service. Click on the link above and follow the instructions underneath the heading Your Global API Key or API Token

Serving images from a Cloudflare domain

Cloudflare images supports serving images that you upload from any Cloudflare domain. In order to do that you need to provide the domain that you want to serve your images from and then the account hash of your Cloudflare images account.

Once you have those, add the below to your medusa-config.js in the medusa-file-cloudflare-images plugin definition.

module.exports = {
  plugins: [
    ...otherMedusaPlugins,
    {
      resolve: `medusa-file-cloudflare-images`,
      options: {
        // required
        accountId: process.env.CLOUDFLARE_ACCOUNT_ID,
        apiToken: process.env.CLOUDFLARE_IMAGE_API_TOKEN,
        // write the domain it as you would see it in
        // the websites tab of your Cloudflare dashboard
        serveFromCloudflareDomain: "yourcloudflaredomain.com",
        accountHash: process.env.CLOUDFLARE_IMAGE_ACCOUNT_HASH,
      },
    },
  ],
};

Here are few useful tips on getting the keys and using this feature.

  • Your Account hash will be under Developer Resources in the Images section of your Cloudflare Dashboard.
  • If you forget your account hash, the plugin will throw an error to help you get back on your feet.
  • The images are automatically served via https:// so don't worry about adding that to your domain. Just write it as you see it in the Websites section of your Cloudflare Dashboard.
  • If you only include the accountHash, this plugin will ignore the custom domain all together and serve it using the provided image delivery URL once it's done uploading. You will need to include the serveFromCloudflareDomain domain string as well as the accountHash

Gotchas / Errors

Error Services must inherit from BaseService

When starting the medusa server, you get an error that says Services must inherit from BaseService. This is due to the fact that your medusa-interfaces are out of sync. Much like React, any package using medusa-interfaces has to be using the same version.

Make sure that they're all the same version and also that they don't conflict with each other. If you're using a monorepo, it might be wise to delete all of your node_modules. Also ensure any package author is not bundling medusa_interfaces they should be a peerDependency of whatever the plugin is.