第三方插件安装与升级

如果你拿到的是第三方插件包,通常来说先把它导入目标应用的 storage/plugins,然后先重启应用,再继续启用或验证插件是否生效。

快速索引

我想要……去哪里看
先切到目标 env,再开始导入或重启插件先确认目标环境
从远程压缩包、本地压缩包或 npm 导入第三方插件nb plugin import 导入插件包
导入完成后让应用重新加载插件目录nb app restart
第一次安装后正式启用插件nb plugin enable
想确认插件是否已经出现在当前应用里nb plugin list
目标机器不能直接联网,只能手动上传 .tgz 再导入不能直接联网时

先确认目标环境

如果你本地管理了多个应用,先切到目标 env 再操作:

nb env use app1

nb plugin import 导入插件包

nb plugin import 支持三类来源:远程压缩包、本地压缩包、npm 包名。这个命令只负责把插件导入 storage/plugins,不会自动启用插件。

如果你已经拿到了插件包下载地址、本地文件路径,或者插件已经发布到 npm,可以执行:

# 远程压缩包
nb plugin import https://github.com/nocobase/plugin-auth-cas/releases/download/v1.4.0/plugin-auth-cas-1.4.0.tgz

# 本地压缩包
nb plugin import /your/path/plugin-auth-cas-1.4.0.tgz

# npm 包名或 tag
nb plugin import @my-scope/plugin-auth-cas@beta

如果你用的是私有 npm 源,通常来说先登录,再指定 registry:

npm login --registry=https://registry.example.com
nb plugin import @my-scope/plugin-auth-cas@beta --npm-registry=https://registry.example.com

导入之后先重启

导入完成后,先重启目标应用:

nb app restart

如果你没有先切换当前 env,也可以在命令里显式传入 -e <env>

重启之后再启用或验证

如果这是第一次安装,重启后再启用插件:

nb plugin enable @nocobase/plugin-auth-cas

第一次启用时会自动完成安装。

如果插件已经启用,而你这次只是更新压缩包或重新导入一个新版本,通常来说重启完成后就可以继续验证插件是否正常工作,不需要再用 upgrade 的做法。

不能直接联网时

如果目标机器不能直接访问插件下载地址,可以先把 .tgz 文件上传到目标机器的任意目录,再在目标机器执行本地导入。

比如:

nb plugin import /your/path/plugin-auth-cas-1.4.0.tgz
nb app restart
注意

这里不需要手动解压到 storage/pluginsnb plugin import 会自动把插件放到正确目录。