新闻中心 分类>>

Composer如何配置Satis搭建私有包仓库

2025-12-01 00:00:00
浏览次数:
返回列表
使用Satis搭建私有包仓库需先全局安装composer/satis,再创建satis.json配置仓库信息与包源,接着执行satis build生成静态文件,最后通过Web服务器部署output-dir目录,并在项目composer.json中添加仓库地址即可使用。

要使用 Composer 搭建私有包仓库,Satis 是一个轻量级的静态构建工具,它能将多个 Composer 包聚合为一个可被 Composer 安装的私有仓库。以下是配置 Satis 的完整流程。

安装 Satis

Satis 可以通过 Composer 全局或本地安装:

  • 全局安装(推荐):
composer global require composer/satis
  • 确保 ~/.composer/vendor/bin 在系统 PATH 中,以便可以直接运行 satis 命令。

创建 satis.json 配置文件

在项目根目录创建 satis.json 文件,定义仓库的基本信息和包含的包:

{ "name": "My Private Package Repository", "homepage": "https://packages.example.com", "repositories": [ { "type": "vcs", "url": "https://github.com/username/private-package" } ], "require": { "username/private-package": "^1.0" }, "output-dir": "web" }

说明:

  • name:仓库名称。
  • homepage:仓库访问地址。
  • repositories:列出所有需要纳入私有仓库的 VCS(Git、SVN 等)源。
  • require:指定哪些包版本要包含进生成的 packages.json
  • output-dir:生成的静态文件存放路径,通常设为 web 目录。

生成静态仓库

运行以下命令生成仓库文件:

satis build satis.json .
  • 这会读取配置,克隆指定仓库,分析版本,并生成 packages.json 和相关文件到 output-dir 指定的目录。
  • 如果只更新部分包,可加 --skip-errors 参数避免中断。

部署仓库站点

将 output-dir(如 web)目录通过 Web 服务器(Nginx/Apache)对外提供服务:

  • 例如,配置域名 packages.example.com 指向 web 目录。
  • 确保能访问到 https://packages.example.com/packages.json。

在项目中使用私有仓库

在需要使用私有包的项目 composer.json 中添加仓库配置:

{ "repositories": [ { "type": "composer", "url": "https://packages.example.com" } ], "require": { "username/private-package": "^1.0" } }
  • Composer 会优先从该仓库查找包。
  • 建议配合 HTTPS 和认证机制(如 HTTP Basic Auth 或 SSH Token)保障安全。

基本上就这些。Satis 适合中小型团队管理私有包,不复杂但容易忽略权限和同步问题。定期重新运行 satis build 以同步新版本。

搜索