Package detail

medusa-file-minio

medusajs2kMIT1.3.2

MinIO server file connector for Medusa

medusa-plugin, medusa-plugin-file

readme

MinIO

Store uploaded files to your Medusa backend on MinIO.

Plugin Documentation | Medusa Website | Medusa Repository

Features

  • Store product images on MinIO
  • Support for importing and exporting data through CSV files, such as Products or Prices.
  • Support for both private and public buckets.

Prerequisites


How to Install

1. Run the following command in the directory of the Medusa backend:

  npm install medusa-file-minio

2. Set the following environment variables in .env:

  MINIO_ENDPOINT=<ENDPOINT>
  MINIO_BUCKET=<BUCKET>
  MINIO_ACCESS_KEY=<ACCESS_KEY>
  MINIO_SECRET_KEY=<SECRET_KEY>

3. In medusa-config.js add the following at the end of the plugins array:

  const plugins = [
    // ...
    {
      resolve: `medusa-file-minio`,
      options: {
          endpoint: process.env.MINIO_ENDPOINT,
          bucket: process.env.MINIO_BUCKET,
          access_key_id: process.env.MINIO_ACCESS_KEY,
          secret_access_key: process.env.MINIO_SECRET_KEY,
      },
    },
  ]

Test the Plugin

1. Run the following command in the directory of the Medusa backend to run the backend:

  npm run start

2. Upload an image for a product using the admin dashboard or using the Admin APIs.


Additional Resources