管理连接器
对于每个命令,你可以添加 --path /your/path/to/logto
(别名 -p
)来指定 Logto 实例路径。
如果工作目录位于 Logto 项目的根目录,可以省略使用 --path
选项,因为 CLI 会自动检测。
列出现有连接器
使用以下命令列出已添加到 Logto 实例中的现有连接器:
- CLI
- Local
- npx
logto connector list
npm run cli connector list
npx @logto/cli connector list
示例输出:
OFFICIAL
@logto/connector-alipay-native
@logto/connector-aliyun-dm
@logto/connector-aliyun-sms
@logto/connector-apple
@logto/connector-azuread
3RD-PARTY
connector-some-third-party
添加连接器
官方连接器
所有官方连接器都列在 @logto/connectors,除了那些以 connector-mock-
开头用于测试目的的名称。
每个连接器默认都是一个 Tier 1 Bounty Hunter issue。如果你感兴趣,可以随时在相关 GitHub issue 上发表评论或创建 issue 来确认一个连接器。
如果你使用的是官方 Logto 版本(Docker 镜像、Docker Compose、从 GitHub 发布页面下载或通过 CLI 初始化),则无需手动添加官方连接器。
- CLI
- Local
- npx
logto connector add --official
npm run cli connector add --official
npx @logto/cli connector add --official
第三方连接器
第三方连接器是为 Logto 制作但不在 @logto/connectors 中的连接器。
要添加的连接器应是一个有效的 NPM 包,包名必须以 connector-
或 @some-org/connector-
开头。例如:
- CLI
- Local
- npx
logto connector add service-a connector-service-b @org/service-c
# 等同于
logto connector add connector-service-a connector-service-b @org/connector-service-c
npm run cli connector add service-a connector-service-b @org/service-c
# 等同于
npm run cli connector add connector-service-a connector-service-b @org/connector-service-c
npx @logto/cli connector add service-a connector-service-b @org/service-c
# 等同于
npx @logto/cli connector add connector-service-a connector-service-b @org/connector-service-c
连接器是可执行代码!如果你尝试使用第三方连接器,请非常仔细地检查和审查编译后的代码(从 NPM 下载的内容),以避免潜在的安全问题。
记得重启你的 Logto 实例以使更改生效。
链接本地连接器
Logto 还附带了一组预构建的连接器,位于 Logto 实例目录的 <logto-root>/packages/connectors
中。它们默认链接到核心服务,你可以手动重新链接以进行更新(例如,添加新的本地连接器)。
- CLI
- Local
- npx
logto connector link
npm run cli connector link
npx @logto/cli connector link
此命令将在 <logto-root>/packages/connectors
中的每个连接器创建符号链接到 <logto-root>/packages/core/connectors
。如果 packages/core/connectors
中已存在同名连接器,它将首先被移除。
移除连接器
- CLI
- Local
- npx
logto connector remove connector-service-a @org/connector-service-b
npm run cli connector remove connector-service-a @org/connector-service-b
npx @logto/cli connector remove connector-service-a @org/connector-service-b
记得重启你的 Logto 实例以使更改生效。