跳至主要內容

管理連接器

備註:

對於每個命令，你可以附加 --path /your/path/to/logto（別名 -p）來指定 Logto 實例路徑。

如果工作目錄位於 Logto 專案的根目錄，則可以省略使用 --path 選項，因為 CLI 會自動檢測。

列出現有的連接器​

使用以下命令列出已添加到你的 Logto 實例中的現有連接器：

logto 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 初始化），則無需手動添加官方連接器。

logto connector add --official

第三方連接器​

第三方連接器是為 Logto 製作但不在 @logto/connectors 中的連接器。

要添加的連接器應為有效的 NPM 套件，且套件名稱必須以 connector- 或 @some-org/connector- 開頭。例如：

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 下載的內容），以避免潛在的安全問題。

備註:

記得重新啟動你的 Logto 實例以反映更改。

Logto 還附帶了一組預建的連接器，位於 Logto 實例目錄的 <logto-root>/packages/connectors 中。它們預設已連結到核心服務，你可以手動再次連結以進行更新（例如添加新的本地連接器）。

logto connector link

此命令會在 <logto-root>/packages/connectors 中的每個連接器創建符號連結到 <logto-root>/packages/core/connectors。如果 packages/core/connectors 中已存在同名連接器，將會先移除。

移除連接器​

logto connector remove connector-service-a @org/connector-service-b
備註:

記得重新啟動你的 Logto 實例以反映更改。