Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wangjue666/medusa-file-ali
Aliyun OSS file connector for Medusa
https://github.com/wangjue666/medusa-file-ali
Last synced: about 2 months ago
JSON representation
Aliyun OSS file connector for Medusa
- Host: GitHub
- URL: https://github.com/wangjue666/medusa-file-ali
- Owner: wangjue666
- Created: 2024-01-24T04:16:00.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-24T03:32:20.000Z (8 months ago)
- Last Synced: 2024-05-05T07:34:32.276Z (7 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/medusa-file-ali
- Size: 132 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-medusajs - Aliyun OSS - square)  (Uncategorized / Uncategorized)
README
# medusa-file-ali
Aliyun OSS file connector for Medusa
## Features
- Store product images on Aliyun OSS
- Support for importing and exporting data through CSV files, such as Products or Prices.
- Support for Bucket Policies and User Permissions.
---
## Prerequisites
- [Medusa backend](https://docs.medusajs.com/development/backend/install)
- [Aliyun OSS](https://www.alibabacloud.com/help/en/oss/developer-reference/overview-21)
---
## How to Install
1\. Run the following command in the directory of the Medusa backend:
```bash
npm install medusa-file-ali
```
2\. Set the following environment variables in `.env`:
```bash
ALI_OSS_REGION=
ALI_OSS_BUCKET=
ALI_OSS_ACCESS_KEY_ID=
ALI_OSS_ACCESS_SECRET=
ALI_OSS_PREFIX= (optional)
ALI_OSS_STORAGE_TYPE= (optional, you can set 'flat' or 'byDate')
```
3\. In `medusa-config.js` add the following at the end of the `plugins` array:
```js
const plugins = [
// ...
{
resolve: `medusa-file-ali`,
options: {
region: process.env.ALI_OSS_REGION,
bucket: process.env.ALI_OSS_BUCKET,
accessKeyId: process.env.ALI_OSS_ACCESS_KEY_ID,
accessKeySecret: process.env.ALI_OSS_ACCESS_SECRET,
prefix: process.env.ALI_OSS_PREFIX,
storageType: process.env.ALI_OSS_STORAGE_TYPE,
},
},
];
```
---
## Test the Plugin
1\. Run the following command in the directory of the Medusa backend to run the backend:
```bash
npm run start
```
2\. Upload an image for a product using the admin dashboard or using [the Admin APIs](https://docs.medusajs.com/api/admin#tag/Upload).
---
### ALI_OSS_STORAGE_TYPE
you can set 'flat' or 'byDate'
- flat: all files will be stored in the root of the bucket
- byDate: files will be stored in a folder structure based on the date of upload, e.g. `[ALI_OSS_PREFIX]/2024/01/24/Filename.jpg`