PackVault

主题

基础设置 ​

本文档将指导您完成 PackVault 平台的基础设置，包括团队配置、代码托管平台授权和私有包管理等核心功能的设置步骤。

团队设置 ​

团队设置是使用 PackVault 的第一步，它将确定您的私有包仓库的基本信息和访问方式。

设置步骤 ​

  1. 登录 PackVault 平台后，点击导航菜单中的基本设置
  2. 在左侧菜单中选择"团队设置"选项
  3. 填写以下必要信息：

团队设置

团队名称 ​

输入您的团队或组织名称，此名称将显示在平台界面和通知中。建议使用简洁明了的名称，方便识别。

团队域名 ​

团队域名是客户端访问您私有包仓库的入口，格式通常为 your-team-name.repo.catchadmin.vip。

重要提示

团队域名一旦设置后不建议频繁更改，因为这会影响所有依赖您私有包的项目。如需更改，请确保通知所有团队成员更新其 Composer 配置。

私有包存储平台 ​

选择您计划用于存储私有包源代码的平台，目前支持：

  • GitHub
  • Gitee
  • Coding
  • GitLab（即将支持）

您可以根据团队的实际使用情况选择一个或多个平台。多平台支持允许您从不同的代码托管服务获取私有包。

授权 VCS（代码托管平台） ​

为了让 PackVault 能够访问您的私有代码仓库，您需要授权相应的代码托管平台。

GitHub 授权 ​

目前 PackVault 优先支持 GitHub 平台的完整集成。授权过程简单直观：

  1. 在"基本设置"页面，找到"代码托管平台"部分
  2. 点击 GitHub 图标旁的"授权"按钮
  3. 系统将跳转到 GitHub 的授权页面
  4. 选择要授权的范围（建议选择包含您私有包的仓库）
  5. 确认授权

授权 VCS

授权范围说明

  • 如果您只需要访问公开仓库，可以选择最小权限
  • 如果需要访问私有仓库，请确保授予相应的读取权限
  • PackVault 只会读取必要的代码和元数据，不会修改您的源代码

其他平台授权 ​

对于 Gitee、Coding 等其他平台，授权流程类似：

  1. 点击相应平台的"授权"按钮
  2. 按照平台指引完成 OAuth 授权流程
  3. 返回 PackVault 平台验证授权状态

添加 Package ​

授权代码托管平台后，您可以开始添加私有包。PackVault 支持从已授权的代码仓库中导入符合 Composer 规范的 PHP 包。

添加包的前提条件 ​

在添加包之前，请确保您的代码仓库满足以下条件：

  1. 仓库中包含有效的 composer.json 文件
  2. composer.json 文件中定义了正确的包名称（name 字段）
  3. 包的命名符合 Composer 规范（vendor/package 格式）
  4. 建议使用语义化版本管理（使用 Git 标签标记版本）

添加包的步骤 ​

  1. 在导航菜单中点击"包管理"
  2. 点击"添加包"按钮
  3. 在弹出的对话框中，粘贴您要添加的代码仓库 URL

添加 Package

重要提示

禁止添加 packagist.org 上已有的公共库。PackVault 专注于私有包托管，公共包应通过 Composer 官方仓库获取。

添加包的详细操作 ​

添加包的过程非常简单，只需几个步骤：

  1. 复制您要添加的代码仓库 URL（例如：https://github.com/your-org/your-package）
  2. 粘贴到"仓库 URL"输入框
  3. 点击"确认"按钮
  4. 系统将自动验证仓库并提取包信息

添加 Package