ypereirareis/docker-satis

Docker Satis

一个用于轻松快速运行https://github.com/composer/satis%E7%9A%84Docker%E9%95%9C%E5%83%8F%E5%8F%8A%E9%85%8D%E7%BD%AE%EF%BC%8C%E5%8F%AF%E5%9C%A8%E5%87%A0%E7%A7%92%E9%92%9F%E5%86%85%E5%AE%8C%E6%88%90%E9%83%A8%E7%BD%B2%E3%80%82

镜像概述

该镜像集成以下组件：

• Satisfy v3.4.0
• PHP 8.1 - PHP 8.1.1 (cli) (built: Dec 20 2021 21:35:13) (NTS)
• Debian 11 Bullseye
• nginx/1.18.0 - built with OpenSSL 1.1.1k 25 Mar 2021
• Composer 2 - Composer version 2.2.3 2021-12-31 12:18:53

核心功能和特性

• 快速部署私有Composer包仓库
• 提供Web管理界面(Satisfy)
• 支持定时自动构建包索引
• 集成Nginx作为Web服务器
• 支持SSH密钥认证访问私有代码仓库
• 可配置Composer缓存以提高性能

使用场景和适用范围

• 企业内部私有PHP包管理
• 需要集中管理多个私有Git仓库的Composer包
• 希望简化Satis部署和维护流程的开发团队

使用方法和配置说明

环境要求

• docker
• docker-compose
• make

安装步骤

bash
# 复制环境变量模板
cp .env.dist .env
# 复制Satisfy配置模板
cp config/parameters.satisfy.yml.dist config/parameters.satisfy.yml
# 复制Satis配置模板
cp config/satis.json.dist config/satis.json
# 启动服务
make start

默认Satis配置文件

默认配置文件satis.json内容如下：

json
{
    "name": "company/private-packagist",
    "homepage": "https:\/\/satis.domain.tld",
    "output-dir": "web",
    "output-html": true,
    "repositories": [
    ],
    "require-all": true,
    "require-dependencies": true,
    "require-dev-dependencies": true,
    "include-filename": "include\/all$%hash%.json",
    "minimum-stability": "dev",
    "providers": false
}

服务管理命令

• 启动服务

  bash
  make start
  

• 停止服务

  bash
  make stop
  

• 移除服务

  bash
  make remove
  

• 查看服务状态

  bash
  make state
  

访问方式

• 首页
  http://satis.localhost

• 手动构建/ Web hook
  http://satis.localhost/admin/satis/build

• 管理界面
  http://satis.localhost/admin

默认登录凭据：admin / foo

高级配置

构建频率设置

默认情况下，构建脚本每分钟执行一次，配置来自docker-compose：

yaml
satis:
    image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2
    environment:
        # 每分钟执行一次
        CRONTAB_FREQUENCY: "*/1 * * * *"

• 修改执行频率：可将值改为 */5 * * * *（每5分钟）或 */10 * * * *（每10分钟）
• 禁用定时构建：设置 CRONTAB_FREQUENCY=-1

SSH密钥配置

容器需要访问私有仓库的SSH密钥（可选SSH配置）：

yaml
satis:
    image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2
    volumes:
        # 挂载本地SSH密钥
        - "~/.ssh/id_rsa:/var/tmp/id"
        # 挂载SSH配置（可选）
        - "~/.ssh/config:/var/tmp/sshconf"

警告：不建议将SSH密钥添加到自定义镜像中，这会导致密钥泄露风险。

私有仓库服务器的SSH指纹需要添加到容器的known_hosts文件，通过环境变量指定域名列表：

yaml
satis:
    environment:
        # 支持带端口的域名，如yourownserver.com:54322
        PRIVATE_REPO_DOMAIN_LIST: bitbucket.org gitlab.com github.com yourownserver.com:54322

Composer缓存配置

为提高性能，建议将Composer缓存目录与主机共享：

yaml
satis:
    volumes:
        - "/var/tmp/composer:/root/.composer"

外部访问配置

若需对外提供访问，建议使用反向代理。以下是Nginx配置示例：

nginx
server {
    server_name satis.domain.tld;

    location / {
        proxy_pass http://127.0.0.1:80;
    }
}

测试

bash
./tests.sh

许可协议

MIT许可协议

Copyright (c) 2017 Yannick Pereira-Reis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.