699c363c25
Replaced the link for our awesome-Medusa-repo with a direct link to our official plugins page. Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
118 lines
4.6 KiB
Plaintext
118 lines
4.6 KiB
Plaintext
---
|
||
description: 'Learn what Plugins are and how they are used in Medusa. Plugins are re-usable customizations that can be added to a Medusa backend.'
|
||
---
|
||
|
||
import DocCardList from '@theme/DocCardList';
|
||
import Icons from '@theme/Icon';
|
||
import LearningPath from '@site/src/components/LearningPath';
|
||
|
||
# Plugins
|
||
|
||
In this document, you’ll get an overview of plugins in Medusa, where to find them, and how to install them. If you want to learn how to create a plugin, check out [this guide](create.mdx) instead.
|
||
|
||
## Overview
|
||
|
||
Medusa was built with flexibility and extendability in mind. All different components and functionalities in Medusa are built with an abstraction layer that gives developers the freedom to choose what services they want to use or how to implement a certain component in their ecommerce store.
|
||
|
||
Developers can use plugins to take advantage of this abstraction, flexibility, and extendibility. Plugins allow developers to implement custom features or integrate third-party services into Medusa.
|
||
|
||
For example, if you want to use Stripe as a payment processor in your store, then you can install the Stripe plugin on your backend and use it.
|
||
|
||
An alternative approach is developing a custom way of handling payment on your ecommerce store. Both approaches are achievable by either creating a plugin or using an existing plugin.
|
||
|
||
Plugins run within the same process as the core Medusa backend eliminating the need for extra backend capacity, infrastructure, and maintenance. As a result, plugins can use all other services as dependencies and access the database.
|
||
|
||
Plugins can contain customizations to the Medusa backend or the admin dashboard.
|
||
|
||
<LearningPath pathName="plugin" />
|
||
|
||
---
|
||
|
||
## Using Existing Plugins
|
||
|
||
### Official Plugins
|
||
|
||
Medusa has official plugins that cover different aspects and functionalities such as payment, Content Management System (CMS), fulfillment, and notifications. You can check out the available plugins under the [Plugins section of this documentation](../../plugins/overview.mdx).
|
||
|
||
:::tip
|
||
|
||
To feature your plugin in our repository, you can send a pull request that adds your plugin into the `packages` directory. Our team will review your plugin and, if approved, will merge the pull request and add your plugin in the repository.
|
||
|
||
:::
|
||
|
||
### Community Plugins
|
||
|
||
You can find community plugins by [searching NPM for the `medusa` or `medusa-plugin` keywords](https://www.npmjs.com/search?q=keywords%3Amedusa%2Cmedusa-plugin).
|
||
|
||
You can also check [our Plugin directory](https://medusajs.com/plugins/) for a list of existing Medusa plugins.
|
||
|
||
---
|
||
|
||
## How to Install a Plugin
|
||
|
||
To install an existing plugin, in your Medusa backend run the following command:
|
||
|
||
```bash npm2yarn
|
||
npm install <plugin_name>
|
||
```
|
||
|
||
Where `<plugin_name>` is the package name of the plugin. For example, if you’re installing the Stripe plugin `<plugin_name>` is `medusa-payment-stripe`.
|
||
|
||
### Plugin Configuration
|
||
|
||
If you’re installing an official plugin from the Medusa repository, you can find in its `README.md` file a list of configurations that are either required or optional. You can also refer to the documentation related to that plugin for more details on how to install, configure, and use it.
|
||
|
||
For community plugins, please refer to the installation instructions of that plugin to learn about any required configurations.
|
||
|
||
### enableUI Plugin Option
|
||
|
||
All plugins accept an option named `enableUI`. This option allows you to disable admin customizations from appearing in the admin dashboard.
|
||
|
||
:::note
|
||
|
||
`enableUI`'s default value is `false` if not provided by the plugin users. This means that it must be enabled manually in a plugin's configuration for the customizations to appear in the admin dashboard.
|
||
|
||
:::
|
||
|
||
You can set the `enableUI` value by passing it as part of the plugin's configurations:
|
||
|
||
```js title="medusa-config.js"
|
||
const plugins = [
|
||
// ...
|
||
{
|
||
resolve: `medusa-plugin-custom`,
|
||
options: {
|
||
// other options
|
||
enableUI: true,
|
||
},
|
||
},
|
||
]
|
||
```
|
||
|
||
---
|
||
|
||
## Custom Development
|
||
|
||
Developers can create plugins and reuse them across different Medusa backends. They can also share them with the community to help out other developers.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/development/plugins/create',
|
||
label: 'Create a Plugin',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to create plugins in Medusa.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/development/plugins/publish',
|
||
label: 'Publish a Plugin',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to publish a plugin to NPM.'
|
||
}
|
||
},
|
||
]} />
|