Kuzzle V1升级至V2时插件应在何处声明才能正常加载
Kuzzle V2 插件加载配置方法
Kuzzle V2 已经废弃了 V1 版本中通过enabled文件夹声明插件的机制,改为通过配置文件或环境变量两种方式声明加载插件,对应操作如下:
- 配置文件声明方式
你通过官方一键脚本bash -c "$(curl https://get.kuzzle.io)"安装的Kuzzle V2,默认配置文件路径为/etc/kuzzle/.kuzzlerc;Docker部署场景下默认配置读取路径为容器内的/var/app/.kuzzlerc。
打开配置文件,在plugins根节点下添加对应插件的声明:
保存配置后重启Kuzzle服务即可加载对应插件。{ "plugins": { // 替换为你的插件实际名称 "custom-plugin": { // 替换为插件在运行环境中的绝对路径 "path": "/opt/kuzzle/plugins/custom-plugin", "enabled": true } } } - 环境变量声明方式(更适合Docker部署场景)
无需修改配置文件,直接在启动Kuzzle的环境中添加两组变量即可:KUZZLE_PLUGINS__<插件名称全大写>__PATH:对应插件的绝对路径KUZZLE_PLUGINS__<插件名称全大写>__ENABLED:值设为true表示启用该插件
示例:插件名称为my-plugin时,设置的环境变量如下:
KUZZLE_PLUGINS__MY_PLUGIN__PATH=/usr/plugins/my-plugin KUZZLE_PLUGINS__MY_PLUGIN__ENABLED=true
注意事项
- 确保插件所在目录对Kuzzle的运行用户(Docker环境下默认是
node用户)有读取和执行权限,否则会出现加载失败的情况。 - 如果你直接复用V1版本的自定义插件,需要先适配V2版本的插件开发规范,否则即使配置正确也无法正常加载运行。
内容的提问来源于stack exchange,提问作者clement saint-pierre
相关产品推荐
相关产品推荐

