Files
medusa-store/packages/medusa-file-local/README.md
Shahed Nasser 81fea66ef3 docs: added documentation for local file service (#4162)
* docs: added documentation for local file service

* fixed eslint errors

* change local file service package name
2023-05-30 19:31:57 +02:00

1.1 KiB

Local file storage

Store uploaded files to your Medusa backend locally.

Not suited for production environments

Plugin Documentation | Medusa Website | Medusa Repository

Features

  • Store product images locally

Prerequisites


How to Install

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

npm install @medusajs/file-local

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

const plugins = [
  // ...
  {
    resolve: `@medusajs/file-local`,
    options: {
      upload_dir: 'uploads/images', // optional
      backend_url: 'http://localhost:9000' // optional
    }
  },
]

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.