Composer Satis 配置详解：构建私有PHP包仓库指南
项目地址: https://gitcode.com/gh_mirrors/sa/satis 什么是Composer Satis
Composer Satis是一个轻量级的静态Composer仓库生成器，它允许开发者构建自己的私有PHP包仓库。与完整的包管理解决方案不同，Satis通过生成静态文件来提供服务，非常适合中小型项目或企业内部使用。
基础配置解析
核心配置项
Satis的配置文件是一个JSON格式的文件，包含多个关键配置项：
- name：仓库名称，会显示在生成的网页中
- description：仓库描述信息
- homepage：仓库的访问地址
- repositories：定义源仓库，可以包含多个Composer仓库
{
"name": "企业私有包仓库",
"description": "包含公司所有PHP项目的私有包",
"homepage": "https://packages.example.com",
"repositories": [
{
"type": "composer",
"url": "https://packagist.org"
}
]
}
包依赖管理
require配置
require字段用于指定需要包含在仓库中的包及其版本约束：
"require": {
"company/logger": "^1.0",
"company/utils": "dev-master",
"company/auth": "1.2.*"
}
版本约束支持Composer的所有语法，包括：
- 精确版本：
1.2.3 - 范围约束：
>=1.0 <2.0 - 通配符：
1.2.* - 开发分支：
dev-master
依赖解析选项
Satis提供了几个关键选项来控制依赖解析行为：
- require-all：包含所有源仓库中的所有包版本
- require-dependencies：自动解析并包含所有依赖
- require-dev-dependencies：包含开发依赖
- only-dependencies：仅包含依赖，不包含主项目
{
"require-all": false,
"require-dependencies": true,
"require-dev-dependencies": false
}
高级功能配置
包归档设置
archive配置允许你将包归档为压缩文件，便于离线使用：
"archive": {
"directory": "dist",
"format": "zip",
"skip-dev": true,
"prefix-url": "https://cdn.example.com/packages"
}
关键参数说明：
- directory：归档文件存储目录
- format：归档格式（zip或tar）
- skip-dev：是否跳过开发版本
- whitelist/blacklist：包过滤列表，支持通配符
废弃包标记
abandoned字段可以标记已废弃的包，并可指定替代包：
"abandoned": {
"company/old-package": true,
"company/deprecated": "company/new-package"
}
输出控制
控制生成仓库的输出行为：
{
"output-dir": "public/packages",
"output-html": true,
"twig-template": "custom-template.html.twig",
"pretty-print": true
}
最佳实践建议
- 版本控制：将Satis配置文件和生成的仓库都纳入版本控制
- CDN集成：使用
prefix-url将归档文件托管在CDN上 - 定期更新：设置定时任务定期重建仓库
- 访问控制：通过Web服务器配置保护私有仓库
常见问题解答
Q：如何只包含特定版本的包？ A：使用require字段精确指定版本，或使用blacklist排除不需要的版本
Q：生成的仓库太大怎么办？ A：使用only-best-candidates选项只保留最佳版本，或设置skip-dev跳过开发版本
Q：如何自定义仓库界面？ A：通过twig-template指定自定义模板文件
通过合理配置Satis，你可以构建一个高效、稳定的私有PHP包仓库，满足团队开发需求，同时保持与公共Composer生态的兼容性。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
