README

一个简单的静态Composer仓库生成器。

关于

Satis 是一个工具，允许 PHP 开发者为他们的项目依赖项创建私有包仓库。它通过创建一个可以托管在任何地方（甚至通过 Docker，本地）的静态 Composer 注册表，提供了对包分发的更多控制、改进的安全性和更快的包安装。

从源运行

Satis 需要较新的 PHP 版本，不支持旧版本的 PHP。有关详细信息，请检查 composer.json 文件。

• 安装 Satis: composer create-project --keep-vcs --no-dev composer/satis:dev-main
• 构建仓库: php bin/satis build <配置文件> <输出目录>

在 文档 中阅读更详细的说明。

作为 Docker 容器运行

注意：使用 composer/satis 对于 Docker Hub，使用 ghcr.io/composer/satis 对于 GitHub 容器注册表。

拉取镜像

docker pull composer/satis

运行镜像（使用主机 Composer 缓存）

docker run --rm --init -it \
  --user $(id -u):$(id -g) \
  --volume $(pwd):/build \
  --volume "${COMPOSER_HOME:-$HOME/.composer}:/composer" \
  composer/satis build <configuration-file> <output-directory>

如果您想在不隐式运行 Satis 的情况下运行镜像，您必须覆盖 Dockerfile 中指定的入口点

--entrypoint /bin/sh

清除

如果您选择在构建过程中存档包，随着时间的推移，您可能会留下无用的文件。使用 purge 命令可以删除这些文件。

php bin/satis purge <configuration-file> <output-dir>

注意：除非您确定您的项目不再在它们的 composer.lock 文件中引用这些存档，否则请不要这样做。

更新

更新 Satis 与在 Satis 目录中运行 git pull && composer install 一样简单。

如果您正在作为 Docker 容器运行 Satis，只需拉取最新镜像即可。

贡献

请注意，本项目遵循 贡献者行为准则。通过参与本项目，您同意遵守其条款。

将项目分支，创建一个功能分支，并向我们发送拉取请求。

如果您引入了新功能或修复了错误，请尽量包含测试用例。

虽然这不是强制性的，但如果您的贡献符合我们的编码标准，我们将非常感激。

您可以通过运行我们使用的工具自行检查这些内容

# install tooling & dependencies
for d in tools/*; do composer --working-dir=$d install; done

# run php-cs-fixer
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix

# run phpstan
tools/phpstan/vendor/bin/phpstan

# alternatively, use the shortcuts
composer phpstan
composer php-cs-fixer[-fix]

作者

查看参与此项目的 贡献者 列表。

社区工具

• satisfy - 基于 Symfony 的简单 Web UI 的 composer 仓库管理器。

示例

• eventum/composer - 一个简单的静态包集，托管在 GitHub Pages 上
• satis.spatie.be - 设置和保障 Satis 仓库的简要指南

许可证

satist遵循MIT许可证 - 详细内容请参阅LICENSE文件