composer/satis

Satis - 静态Composer仓库生成器

镜像概述和主要用途

Satis是一个简单的静态Composer仓库生成器，用于创建和管理私有Composer包的静态仓库。它能够将指定的包（包括私有包）编译为静态文件集合，供Composer客户端检索和安装，适用于需要集中管理私有依赖且不希望依赖公共仓库的场景。

核心功能和特性

• 静态仓库生成：将配置文件中定义的包编译为静态HTML和JSON文件，形成可直接托管的Composer仓库
• 归档包支持：可选择将包归档为zip文件，便于离线使用和版本控制
• 冗余文件清理：提供purge命令，用于删除不再被引用的归档文件，节省存储空间
• 多环境支持：可通过源码直接运行，或作为Docker容器部署，适应不同环境需求
• 配置简单：基于JSON配置文件（通常为satis.json）定义仓库信息和包依赖

使用场景和适用范围

• 私有包管理：企业或团队内部开发的私有Composer包，需要集中托管供内部项目依赖
• 静态托管：生成的仓库文件可通过HTTP服务器（如Nginx、Apache）或静态托管服务（如GitHub Pages）部署
• 依赖版本控制：固定依赖版本，避免公共仓库变更影响项目稳定性
• 离线环境支持：通过归档包功能，可在无网络环境中提供依赖安装支持

详细使用方法和配置说明

从源码运行

Satis需要较新版本的PHP（具体版本要求参见项目composer.json），不支持已停止维护的PHP版本。

安装Satis

sh
composer create-project composer/satis:dev-main

生成仓库

sh
php bin/satis build <配置文件路径> <输出目录>

• <配置文件路径>：Satis配置文件路径（通常为satis.json）
• <输出目录>：生成的静态仓库文件存放路径

详细说明参见官方文档

作为Docker容器运行

拉取镜像

sh
docker pull composer/satis

运行容器

运行时建议挂载本地目录以持久化数据并共享Composer缓存：

sh
docker run --rm --init -it \
  --user $(id -u):$(id -g) \  # 使用当前用户ID避免文件权限问题
  --volume $(pwd):/build \     # 挂载当前目录到容器内/build，用于访问配置文件和输出
  --volume "${COMPOSER_HOME:-$HOME/.composer}:/composer" \  # 共享Composer缓存
  composer/satis build <配置文件路径> <输出目录>

覆盖入口点

如需执行容器内其他命令，可覆盖默认入口点：

sh
docker run --rm --init -it \
  --entrypoint /bin/sh \  # 覆盖入口点为shell
  composer/satis

Purge命令：清理冗余归档文件

若构建时启用了包归档功能，长期运行后可能积累无用归档文件。使用purge命令可删除这些文件：

sh
php bin/satis purge <配置文件路径> <输出目录>

注意：执行此命令前，需确保所有项目的composer.lock文件中不再引用任何待删除的归档，否则可能导致依赖安装失败。

更新方法

源码运行环境

sh
# 在Satis安装目录执行
git pull && composer install

Docker容器环境

sh
docker pull composer/satis

社区工具

• satis-go：简单Web服务器，用于管理Satis配置和托管生成的仓库 https://github.com/benschw/satis-go
• satisfy：基于Symfony的仓库管理器，提供Web UI https://github.com/ludofleury/satisfy
• satis-control-panel：带CI集成的Satis仓库Web管理界面 https://github.com/realshadow/satis-control-panel
• composer-satis-builder：根据项目composer.json自动更新Satis配置的工具 https://github.com/AOEpeople/composer-satis-builder

使用示例

• eventum/composer：托管于GitHub Pages的简单静态包集合 https://github.com/eventum/composer

贡献指南

Satis项目遵循贡献者行为准则。参与项目即表示同意遵守其条款。贡献方式：Fork项目，创建功能分支，提交Pull Request。新功能或bug修复建议包含测试用例。

许可证

Satis基于MIT许可证开源，详见https://github.com/composer/satis/blob/master/LICENSE

贡献者

详见参与该项目的https://github.com/composer/satis/contributors