README

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

Satis - 包仓库生成器

(Kirby的多包仓库版本)

多包仓库

要使用多包仓库，请使用类型 "vcs-namespace"。

{
  "repositories": [
    {
      "type": "vcs-namespace",
      "url": "git@github.com:yourname/yourrepo"
    }
  ]
}

它与 andkirby/multi-repo-composer 兼容。您可以了解更多关于 多仓库需求 的信息。

从源代码运行

• 安装 satis: composer create-project composer/satis:dev-master --keep-vcs
• 构建仓库: php bin/satis build <configuration-file> <output-dir>

请参阅文档中的更详细说明。

作为Docker容器运行

拉取镜像

docker pull composer/satis

运行镜像

docker run --rm -it -v /build:/build composer/satis

注意：默认情况下，它将在 /build 目录中查找名为 satis.json 的配置文件，并将生成的输出文件存放在 /build/output。

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

docker run --rm -it -v /build:/build -v $COMPOSER_HOME:/composer composer/satis

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

docker run --rm -it --entrypoint /bin/sh composer/satis

清除

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

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

注意：除非您确定您的项目不再引用这些存档中的任何一个，否则请不要执行此操作。

更新

更新Satis就像在Satis目录中运行 git pull && composer update 一样简单。

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

贡献

请注意，该项目采用 贡献者行为准则 发布。通过参与此项目，您同意遵守其条款。

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

作者

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

社区工具

• satis-go - 一个用于管理Satis配置和托管生成的Composer仓库的简单Web服务器。
• satisfy - 基于Symfony的composer仓库管理器，具有简单的Web用户界面。
• satis-control-panel - 用于管理您的Satis仓库的简单Web用户界面，可选的CI集成。
• composer-satis-builder - 一个简单工具，用于根据项目的composer.json更新Satis配置（satis.json）中的"require"键。

许可证

Satis采用MIT许可证 - 请参阅LICENSE文件以获取详细信息。