Satis是composer官方推荐的私有镜像工具,通过生成静态packages.json文件实现私有包管理。首先全局安装Satis并配置satis.json,指定仓库源与输出目录,运行satis build生成文件后部署至Web服务器,项目中添加该仓库地址即可使用私有包,建议结合httpS、认证机制及定时任务实现安全高效的自动化更新。

搭建私有镜像对于团队开发或企业级项目非常有用,尤其是当你需要托管私有包、控制依赖版本或加速下载时。Satis 是 Composer 官方推荐的轻量级静态包仓库生成器,可以用来创建一个私有的 Composer 镜像服务。
什么是 Satis?
Satis 实际上是一个“静态的 Composer 仓库生成器”。它会读取你指定的 composer 包信息(支持 git、svn、私有包等),然后生成一个 packages.json 文件,供 Composer 客户端使用。你可以将这个文件部署到 Web 服务器上,从而让团队成员通过 Composer 安装你的私有包。
安装与配置 Satis
以下是使用 Satis 搭建私有镜像的完整步骤:
1. 安装 Satis
推荐使用全局安装方式:
composer global require composer/satis
确保你的 ~/.composer/vendor/bin 已加入系统 PATH,以便可以直接运行 satis 命令。
或者,也可以克隆官方仓库:
git clone https://github.com/composer/satis.git
cd satis && composer install
2. 创建 Satis 配置文件
在项目目录下新建一个 satis.json 文件,内容如下:
{ "name": "My Private Package Repository", "homepage": "https://satis.example.com", "repositories": [ { "type": "vcs", "url": "https://github.com/your-company/private-package" }, { "type": "vcs", "url": "ssh://git@bitbucket.org/your-team/another-private-repo.git" } // 可继续添加其他私有或公共包 ], "require-all": true, "output-dir": "web/" }
说明:
- name:仓库名称
- homepage:访问地址(建议配置域名)
- repositories:列出你要包含的所有包源,支持 git、svn、mercurial 等
- require-all:是否拉取所有分支和标签作为可用版本
- output-dir:生成的静态文件输出目录
如果你只想包含特定版本,可以使用 require 字段代替 require-all:
"require": { "your-company/private-package": "^1.0" }
3. 生成静态仓库
运行以下命令生成 packages.json 和相关文件:
satis build satis.json .
如果 output-dir 设置为 web/,则改为:
satis build satis.json web/
执行后,Satis 会克隆你配置的仓库,分析 composer.json 并生成一个聚合的 packages.json 文件。
4. 部署到 Web 服务器
将输出目录(如 web/)部署到 nginx 或 apache 等 Web 服务器中。
例如,配置 Nginx:
server { listen 80; server_name satis.example.com; root /path/to/web; index index.html; location / { try_files $uri $uri/ =404; } }
确保可以通过浏览器访问:https://satis.example.com/packages.json
在项目中使用私有镜像
在你的 php 项目中修改 composer.json,添加私有仓库:
{ "repositories": [ { "type": "composer", "url": "https://satis.example.com" } ], "require": { "your-company/private-package": "^1.0" } }
然后运行:
composer install
Composer 将优先从你的私有镜像拉取包。
自动化更新(可选)
为了保持私有仓库同步,可以设置定时任务自动构建:
例如使用 crontab 每小时更新一次:
0 * * * * /home/user/.composer/vendor/bin/satis build /path/to/satis.json /path/to/web
也可结合 CI/CD 流程,在代码提交后触发构建。
安全建议
- 使用 HTTPS 提供服务,避免敏感信息泄露
- 对访问进行认证(如 HTTP Basic Auth、IP 白名单)
- 私有代码仓库应配置 SSH 密钥或 OAuth Token 访问权限
- 定期清理旧版本以节省空间
基本上就这些。Satis 虽然功能简单,但足够稳定,适合中小型团队快速搭建私有包仓库。只要配置好源和输出路径,再配合 Web 服务和定时更新,就能实现高效的私有依赖管理。不复杂但容易忽略细节,比如权限和网络访问问题,部署前务必测试连通性。
以上就是composer怎么搭建私有镜像(Satis)_指导使用Satis搭建composer私有镜像的详细内容,更多请关注php中文网其它相关文章!


