GitHub
Cursor GitHub app 會連結您的儲存庫,讓您使用 雲端代理、Bugbot 等功能。
設定
需要具備 Cursor 管理員權限和 GitHub 組織管理員權限。
- 前往儀表板中的整合
- 點擊 GitHub 旁的 連結 (若已連線,則點擊 管理連線)
- 選擇 所有儲存庫 或 選取的儲存庫
- 返回儀表板,為儲存庫設定功能
若要中斷 GitHub 帳戶連結,請返回整合儀表板並點擊 中斷帳戶連結。
IP 允許清單設定
如果您的組織使用 GitHub 的 IP 允許清單功能限制儲存庫存取,Cursor 可設定為使用僅含少量 IP 位址的託管輸出代理伺服器。
設定 IP 允許清單前,請聯絡 hi@cursor.com,為您的團隊啟用此功能。以下任一設定方式皆須先啟用此功能。
為已安裝的 GitHub Apps 啟用 IP 允許清單設定 (建議)
Cursor GitHub app 已預先設定 IP 清單。您可以為已安裝的應用程式啟用允許清單,讓它們自動繼承此清單。這是建議做法,因為我們可以更新此清單,而您的組織將自動收到更新。
啟用方式如下:
- 前往您組織的安全性設定
- 前往 IP 允許清單設定
- 勾選 「允許 GitHub Apps 存取」
如需詳細操作說明,請參閱 GitHub 文件。
直接將 IP 新增至允許清單
如果您的組織使用由 GitHub 中的 IdP 定義的允許清單,或因其他原因無法使用預先設定的允許清單,請將 Git 輸出代理伺服器和 IP 允許清單中列出的代理伺服器 IP 新增至清單。
進階網路
自架執行個體支援 IP 允許清單以外的多種連線方式。如需設定詳情及支援的私有網路選項,請參閱私有連線。
適用於企業版客戶。當您的 GitHub Enterprise Server 位於 AWS,或可部署在 AWS Network Load Balancer 後方時,請使用 AWS PrivateLink。PrivateLink 可讓 Cursor 存取 GHES,並在需要時讓 GHES 將 Webhook 傳回 Cursor,而無須透過公用網際網路傳出流量。
**最適合:**託管於 AWS 的 GHES 執行個體,以及希望透過私有 VPC 端點連線的團隊
**安全性:**HTTPS 加密、AWS PrivateLink、VPC 端點政策、服務帳號存取 Token
**缺點:**需要與 Cursor 協調並設定 AWS endpoint service。
適用於企業版客戶。當 AWS PrivateLink 不適用,或您需要僅限輸出的部署模式時,請使用 Cloudflare Tunnel。您的網路會執行 cloudflared,Cursor 則提供通道主機名稱和 Token。
**最適合:**沒有輸入網路存取權的環境
**安全性:**HTTPS 加密、Cloudflare Tunnel、服務帳號存取 Token
**缺點:**需要在您的環境中執行及維護 cloudflared。
權限
GitHub app 會要求下列權限,以支援 Cursor 功能:
| 權限 | 用途 |
|---|---|
| 儲存庫存取權 | 複製您的程式碼並建立工作分支 |
| Pull Requests | 建立 PR 並留下審查留言 |
| Issues | 追蹤審查過程中發現的程式錯誤和任務 |
| 檢查和狀態 | 回報程式碼品質和測試結果 |
| Actions 和工作流程 | 監控 CI/CD 管線,並從 Pull Requests 觸發重新執行 CI |
| 管理 | 讀取分支保護規則和必要檢查規則,以判斷 PR 是否可合併 |
| 自訂儲存庫角色 | 判斷使用者的存取層級,以顯示適當的合併和審查選項 |
| 組織自訂屬性 | 在篩選時顯示組織定義的儲存庫中繼資料 |
所有權限皆遵循最小權限原則。
受保護的 Git 範圍
將 GitHub 組織鎖定至您的 Cursor 組織,確保只有您的團隊能透過雲端代理、自動化和 Bugbot 使用其儲存庫。保護範圍需要 GitHub 組織擁有者或管理員權限。請參閱 受保護的 Git 範圍。
疑難排解
- 安裝具備儲存庫存取權的 GitHub App
- 檢查私有儲存庫的權限
- 確認您的 GitHub 帳戶權限
- 授予 App Pull Request 寫入權限
- 檢查分支保護規則
- 若 App 安裝已過期,請重新安裝
- 檢查是否已在組織層級安裝
- 從 github.com/apps/cursor 重新安裝
- 若安裝已損毀,請聯繫支援
後續步驟
GitHub 整合功能已連線後,請設定使用此整合功能的功能: