如何搭建与使用 Satis - Composer 的私有包仓库

Satis 是 Composer 提供的一个轻量级的工具，用于创建私有的 Composer 包仓库，便于团队内部或者特定场景下管理 PHP 依赖包的分发。下面是关于 Satis 项目的关键组成部分以及如何设置和使用的简要指南。

1. 项目的目录结构及介绍

Satis 的仓库结构相对简单，主要关注点在于 config.json 配置文件。以下是典型的项目结构：

.
├── config.json       # 核心配置文件，定义你的仓库元数据。
├── dist/             # （可选）存放打包后的包文件。
├── .gitignore        # 版控忽略文件列表。
└── web/              # 网站根目录，包含index.php，用于公开访问仓库。

• config.json：存放所有关于你的私有库的信息，包括你要托管的包的源地址和版本信息。
• dist/ 目录：用于存储由 Satis 自动生成的归档文件（如 .zip, .tar.gz），当部署时不是必需的，但可以提供更快的下载速度。
• web/ 目录：包含服务端点的入口文件 index.php，用户通过该文件与 Satis 交互获取包信息。

2. 项目的启动文件介绍

在 Satis 中，核心的启动并不直接对应一个“启动文件”像传统应用那样。然而，如果你指的是让 Satis 开始工作的过程，实际上是通过运行命令行脚本来实现的。关键步骤是构建你的 Satis 仓库，这通常通过执行以下 Composer 命令来完成：

composer install --no-dev --optimize-autoloader --working-dir=<your-satis-repo-path>

接着，你需要执行生成操作：

./bin/satis build config.json web/

这段命令基于 config.json 配置文件生成静态 HTML 和仓库元数据，准备被 Composer 客户端使用。

3. 项目的配置文件介绍

config.json 是 Satis 的心脏，它定义了哪些包将被包含在你的仓库中，以及它们来自哪里。基本结构大致如下：

{
    "name": "your-private-repository",
    "homepage": "http://example.com/composer",
    "repositories": [
        {
            "type": "vcs",
            "url": "[e-mail]:vendor/repo.git"
        }
    ],
    "require-all": true,
    "output-html": "web/index.html",
    "skip-errors": true
}

• name: 私有仓库的名字。
• homepage: 访问 Satis 仓库的网址。
• repositories: 列出你想添加到仓库中的包来源，类型可以是 vcs(Git, SVN等)，package(直接指定包详情)。
• require-all: 如果设为 true，Satis 将尝试下载并包含所有列出的包的所有版本。
• output-html: 指定生成的 HTML 文件路径，用于Composer客户端查询。
• skip-errors: 在构建过程中遇到错误是否继续，避免因个别包的问题中断整个过程。

理解这些部分后，你就能灵活地配置 Satis 来满足自己的私有包发布需求了。