Files
medusa-store/packages/medusa-file-local
Annika 7d04f95603 docs(plugins): puts local-file plugin into correct category in site (#5804)
Closes [Issue #5782](https://github.com/medusajs/medusa/issues/5782)

Per Shahed, @medusajs/file-local plugin doesn't have the correct "storage" category, and its because the [package.json file](https://github.com/medusajs/medusa/blob/develop/packages/medusa-file-local/package.json) doesn't have the keyword medusa-plugin-storage. This PR is to add the keyword.
2023-12-06 12:20:38 +00:00
..
2023-08-25 16:15:33 +02:00

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.