Skip to main content

Spaces

In this document, you’ll learn how to install the Spaces plugin on your Medusa backend and use it for storage.

Overview​

To manage images in Medusa, you need a file service plugin responsible for hosting the images. Without a file service plugin, you will face issues while working with Medusa, such as when uploading images for products.

Medusa provides three different options to handle your file storage. This document focuses on using Spaces to store images and files uploaded to the Medusa backend.

Prerequisites​

Medusa Backend​

A Medusa backend is required to be set up before following along with this document. You can follow the quickstart guide to get started in minutes.

Required Accounts​

You need to create a DigitalOcean account to follow along with this documentation. A credit card is required during registration.

Create DigitalOcean Space​

In your DigitalOcean account, click on the Create button at the top right, then choose Spaces from the dropdown.

Click on the green Create button at the top right, then choose Spaces in the dropdown

In the Create a Space form, you can choose any of the regions listed. You can alternatively leave all settings as they are and scroll down to the Finalize and Create section.

The Space form can be left as is and move towards the Finalize and Create section

In the Finalize and Create section, enter a name for the field “Choose a unique name”. You’ll use this name later in the integration with Medusa. Also, select the project you want to add the new Space to.

Enter a name for the Space in the Choose a unique name field

Once you’re done, click on the Create a Space button. This creates the Space and redirects you to the Space’s page.

Create Space Access Keys​

Choose API from the bottom of the sidebar.

Choose API from the bottom of the sidebar.

This opens the Application & API page. Scroll down to Spaces Access Keys and click the Generate New Key button.

In the Spaces access keys section, click the Generate New Key button

This shows a table with the Name field editable. Enter a name for the Access Keys and click on the checkmark button to save and generate the Spaces access keys.

Enter a name for the Space access key in the field under the Name column

Then, two keys will be available under the Key column of the table. The first one is the Access Key ID and the second is the Secret Access Key. Copy both as you’ll use them later.

The secret access key will not be shown again after you leave the page. Make sure to copy it when you see it or you’ll need to re-generate a new one.

Install the Spaces Plugin​

In the directory of your Medusa backend, run the following command to install the Spaces plugin:

npm install medusa-file-spaces

Then, add the following environment variables:

SPACE_URL=<YOUR_SPACE_URL>
SPACE_BUCKET=<YOUR_SPACE_NAME>
SPACE_ENDPOINT=<YOUR_SPACE_ENDPOINT>
SPACE_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
SPACE_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>

Where:

  1. <YOUR_SPACE_URL> is the URL of your Space which you can find on the Space’s page below the Space’s name.

The URL is available under the Space's name on the Space's page

  1. <YOUR_SPACE_NAME> is the name of your Space.
  2. <YOUR_SPACE_ENDPOINT> is your Space’s endpoint which can be found by going to your Space’s page, clicking on the Settings tab, and scrolling to the Endpoint section.

Endpoint can be found on the Settings tab in the Space's page

  1. <YOUR_ACCESS_KEY_ID> and <YOUR_SECRET_ACCESS_KEY> are the keys you created in the previous section.

Finally, in medusa-config.js add a new item to the plugins array:

medusa-config.js
const plugins = [
  // ...
  {
    resolve: `medusa-file-spaces`,
    options: {
        spaces_url: process.env.SPACE_URL,
        bucket: process.env.SPACE_BUCKET,
        endpoint: process.env.SPACE_ENDPOINT,
        access_key_id: process.env.SPACE_ACCESS_KEY_ID,
        secret_access_key: process.env.SPACE_SECRET_ACCESS_KEY,
    },
  },
]

If you have multiple storage plugins configured, the last plugin declared in the medusa-config.js file will be used.

Test the Space Plugin​

Run your Medusa backend with the following command:

npx @medusajs/medusa-cli develop

Then, you can either test the plugin using the REST APIs or using the Medusa Admin.

On the Medusa Admin, create a new product and, in the Images section, upload an image then click Save. If the integration was successful, the product image will be uploaded successfully.

Image successfully uploaded on Medusa's admin

You can also check that the image was uploaded on the Space’s page.

Image can be seen on the Space's page on DigitalOcean

Next.js Starter Template Configuration​

If you’re using a Next.js Starter Template, you need to add an additional configuration that adds the Space’s domain name into the configured images’ domain names. This is because all URLs of product images will be from the Space.

If this configuration is not added, you’ll receive the error "next/image Un-configured Host”.

In next.config.js add the following option in the exported object:

next.config.js
const { withStoreConfig } = require("./store-config")

// ...

module.exports = withStoreConfig({
  // ...
  images: {
    domains: [
      // ...
      "<YOUR_SPACE_DOMAIN>",
    ],
  },
})

Where <YOUR_SPACE_DOMAIN> is the domain name for your Space which can be retrieved from the Space URL. For example, medusa-backend.digitaloceanspaces.com.

See Also​

Was this page helpful?
© 2023 Medusa, Inc. All rights reserved.