以下是集成CodeRabbit到自托管GitLab的步骤摘要:
​步骤1:开始​
访问CodeRabbit登录页面,选择"Self-Hosted GitLab"选项。
​步骤2:输入自托管GitLab URL​
在指定页面输入您的自托管GitLab实例URL并提交。系统将检查数据库中是否存在您的组织记录。若存在,则启动登录流程;若不存在,则启动手动或自动 onboarding 流程。
​步骤3:Onboarding(手动或自动)​
  • ​自动Onboarding​​:
    • 需要提供管理员访问令牌(Admin Access Token),用于在自托管实例中设置新的CodeRabbit机器人用户。该令牌仅在初始设置过程中需要一次,可设置最短有效期。
    • 此操作不会自动在所有项目中安装CodeRabbit应用,您需要在后续步骤中手动将CodeRabbit添加到所需项目。
  • ​手动Onboarding​​:
    • ​创建CodeRabbit用户​​:
      • 建议创建名为"CodeRabbitAI"的专用用户,以便于识别和精细访问控制。
      • 使用实例管理员账户登录GitLab,按照GitLab文档创建用户。
      • 创建后,从用户个人资料中获取用户ID并生成访问令牌(用于在合并请求中发布评论)。
      • 建议使用CodeRabbit徽标作为用户头像以便识别。
    • ​创建OAuth2应用程序​​:
      • 建议创建实例级应用程序(除非希望将评论限制到单个组或用户)。
      • 所需作用域:apiread_useremailopenid
      • 回调URL:https://app.coderabbit.ai/login
    • ​生成个人访问令牌​​:
      • 遵循以下流程生成令牌(仅初始设置需要,最小有效期即可):
        1. 1.
          左侧边栏选择头像。
        2. 2.
          选择"Edit profile"。
        3. 3.
          左侧边栏选择"Access Tokens"。
        4. 4.
          选择"Add new token"。
        5. 5.
          输入令牌名称和有效期(若不设置有效期,则自动设置为当前日期后365天)。
        6. 6.
          选择作用域:apiread_apiread_user
        7. 7.
          创建令牌并妥善保存(仅可见一次)。
​步骤4:提交详细信息​
将所需信息粘贴到表单中并提交。CodeRabbit将处理设置流程。后续访问时,系统将自动检测您的设置并允许直接登录。
​步骤5:白名单CodeRabbit IP地址​
如果您的实例需要IP白名单,请将以下IP地址加入白名单:
  • 35.222.179.152/32
  • 34.170.211.100/32
    如需VPN隧道功能(作为附加包),请联系 [email protected]
​注意​​:
  • CodeRabbit支持GitLab 16.x及以上版本。15.x版本可能出现意外问题(如评论无法发布或注册流程完全失效),建议升级GitLab实例以获得最佳体验。
  • 管理员访问令牌或个人访问令牌仅用于初始设置,后续登录通过OAuth2流程完成。