插件配置
页面摘要:
/config/plugins用于启用或禁用插件并覆盖其设置,并提供了本地插件开发的示例。
插件配置存储在 /config/plugins.js|ts(参见项目结构)。每个插件都可以使用以下可用参数进行配置:
| Parameter | Description | Type |
|---|---|---|
enabled | 启用(true)或禁用(false)已安装的插件 | Boolean |
config |
可选 | 用于覆盖插件的默认配置(在 strapi-server.js 中定义) | Object |
| resolve
可选,仅本地插件需要 | 插件文件夹的路径 | String |
核心功能和提供方的配置
-
Strapi 的一些核心功能在历史上曾作为核心插件实现。这解释了为什么它们的配置仍然定义在
/config/plugins文件中,尽管在 Strapi 5 中它们在技术上已不再是插件。这包括:详细的 GraphQL 插件配置 也在其专用插件页面中记录。
-
此外,媒体库和邮件功能的提供方配置也定义在
/config/plugins中。它们的配置详见 Upload 提供方配置 和 邮件提供方配置。
插件的基本自定义配置示例:
JavaScript
module.exports = ({ env }) => ({
// 启用一个不需要任何配置的插件
i18n: true,
// 启用一个自定义插件
myplugin: {
// my-plugin 将作为此插件使用的内部名称
enabled: true,
resolve: './src/plugins/my-local-plugin',
config: {
// 用户插件配置写在这里
},
},
// 禁用一个插件
'my-other-plugin': {
enabled: false, // 插件已安装但被禁用
},
});
TypeScript
export default ({ env }) => ({
// 启用一个不需要任何配置的插件
i18n: true,
// 启用一个自定义插件
myplugin: {
// my-plugin 将作为此插件使用的内部名称
enabled: true,
resolve: './src/plugins/my-local-plugin',
config: {
// 用户插件配置写在这里
},
},
// 禁用一个插件
'my-other-plugin': {
enabled: false, // 插件已安装但被禁用
},
});
TIP
如果不需要特定配置,也可以使用简写语法 'plugin-name': true 来声明插件。