跳到主要内容
版本：2.4

快速上手

本文介绍如何从零开始注册登录极狐星TowerFox v2.x，并开始使用极狐星TowerFox 的相关功能。

前提条件​

您已经正确安装 2.0 及以上版本的极狐星TowerFox，具体请参见安装极狐星 TowerFox。

操作一：登录极狐星TowerFox，配置关联极狐GitLab​

初始安装后，以默认管理员账户的邮箱地址和密码登录极狐星TowerFox，具体可参见安装配置文件 install.env 中的 TOWERFOX_ROOT_EMAIL 和 TOWERFOX_ROOT_PW。

操作二：导入激活证书​

安装极狐星TowerFox 后，在导入并激活证书之前，无法进行其他操作。导入并激活证书步骤如下：

  1. 以极狐星TowerFox 管理员的身份登录进入系统。
  2. 在左侧边栏中，选择 组织架构 > 订阅管理，点击 导入许可证。
  3. 在弹出框中选择从极狐星TowerFox 获取到的证书，选择 导入。
  4. 导入成功后，刷新界面即可。

关于证书操作更多内容，请参见订阅管理。

操作三：创建实例​

极狐星TowerFox 初次安装启动后，需要创建至少一个实例，用以指定关联的极狐GitLab 实例。步骤如下：

  1. 以极狐星TowerFox 管理员的身份登录进入极狐星TowerFox 平台。
  2. 在左侧边栏上，选择 组织架构 > 实例管理。
  3. 选择右上角的 添加实例，依次输入指定信息，详细信息请参见实例管理。 instance

一个极狐星TowerFox 实例可以管理多个极狐GitLab 实例，创建关联实例操作只能由极狐星管理员操作。

注意⚠️：

  1. Access Token 推荐使用极狐GitLab 的 Admin token。因为极狐星TowerFox 会使用这个 token 与指定的极狐GitLab 交互，当前主要是通过 API 进行数据抽取。
  2. 复选了作为快捷登录方式，并正确配置 OAuth 后，就可以使用当前极狐GitLab 以 OAuth 方式来登录极狐星TowerFox。

操作四：创建/关联群组​

极狐星TowerFox 不会主动拉取极狐GitLab 上所有的群组和项目信息，您需要通过创建极狐星TowerFox 上的群组来实现。步骤如下：

  1. 以极狐星TowerFox 管理员的身份登录进入极狐星TowerFox 平台。
  2. 在左侧边栏上，选择 组织架构 > 群组管理。
  3. 选择右上角的 新建群组，输入/选择 群组名称* 和 关联的群组**。

org

注意⚠️：

  • 所属实例：显示的是当前极狐星TowerFox 所有已经关联的极狐GitLab 实例。
  • 关联的群组/项目：支持多选，可以选择极狐GitLab 上的群组或项目。
  • 数据抽取范围：想要抽取的性能数据范围。
  • 群组创建后，指定数据会马上开始抽取，这些数据包括群组、项目、议题、合并请求和流水线等。

操作五：添加/移除用户（可选）​

极狐星TowerFox 的群组创建成功后，当前用户（也就是管理员用户）会成为"负责人"角色，此时可以将其他极狐星TowerFox 用户添加到群组，或者将已有用户移除出群组。

添加用户：

  1. 登录进入极狐星TowerFox 平台。
  2. 在左侧边栏上，选择 组织架构 > 群组管理。
  3. 选择指定群组所对应的 详情。
  4. 选择右上角的 添加成员。
  5. 在弹出框中输入要添加的用户的 用户名 或 邮箱，并指定相应的 角色。
  6. 选择 邀请，将指定用户添加到群组中。

注意⚠️：

  • 只有极狐星TowerFox 群组的 负责人 和 管理员 才有权限进行用户添加和移除操作。
  • 只有被添加到指定极狐星TowerFox 群组的用户才能在极狐星TowerFox 上查询该群组的相关效能信息，不在任何极狐星TowerFox 群组中的用户，将无法正常使用极狐星TowerFox。
  • 极狐星TowerFox 群组中的 用户 不是极狐GitLab 中的用户，而是 极狐星TowerFox 的用户。
  • 极狐星TowerFox 中的用户是完全独立的，和极狐GitLab 中的用户无关，即使是通过 OAuth 机制在极狐星TowerFox 中创建的用户，也和极狐GitLab 无关。极狐星TowerFox 中的用户所能看到的数据和能进行的操作，完全由极狐星TowerFox 中的权限系统控制。

操作六：查询效能信息​

查询效能信息：

  1. 登录进入极狐星TowerFox 平台。
  2. 在左侧边栏上，选择 效能管理 > 人员效能。
  3. 选择时间段、群组或项目、分支或成员。

filter_org

注意⚠️：

  • 仅显示关联了极狐GitLab 群组的极狐星TowerFox 群组信息。
  • 群组或项目 选择框以 极狐星TowerFox 群组 -- 极狐GitLab 顶级群组 -- 极狐GitLab 项目 的组织结构进行展示。
  • 默认情况下，指定群组或项目的效能信息有一天的滞后性，即当天的效能信息，要到第二天才能被查询获取。