ochorocho/gitlab-pages-satis

gitlab-pages-satis镜像说明

镜像概述

本镜像用于构建satis（Composer仓库管理工具）并通过GitLab Pages发布，基于satis-gitlab项目优化，提供灵活配置方式，帮助用户快速搭建并发布Composer仓库。

核心功能

1. 多配置方式：支持默认配置文件（./config.yml）、环境变量（GITLAB_SATIS_CONFIG）或指定路径的配置文件。
2. 参数兼容：options字段值以--option-key形式传递给命令，arguments字段值以argument-key形式传递，兼容satis及satis-gitlab的所有选项。
3. 基础认证支持：配置basic-auth可自动生成.htaccess和.htpasswd文件（需提供绝对路径）。

使用场景

• 企业内部私有Composer仓库的构建与维护。
• 通过GitLab Pages发布公开/私有Composer仓库，方便团队或外部用户访问。

配置说明

示例配置（config.yml）

yaml
arguments:
  gitlab-url: 'https://gitlab.example.org'  # GitLab实例地址
  gitlab-token: 'TOKEN'  # GitLab访问令牌
options:
  homepage: 'https://satis.example.org'  # 仓库首页URL
  output: 'satis.json'  # 输出文件名
  ignore: '(^knallimall\/typo3-desktop)'  # 忽略的仓库正则
  template: 'satis-template.example.json'  # 自定义模板路径
  use-file-to-include: '.satisinclude'  # 包含文件路径
build-dir: './public'  # GitLab Pages部署目录
basic-auth:
  auth-name: "Satis Repository"  # 认证名称
  auth-file: "/path/to/.htpasswd"  # .htpasswd绝对路径
  username: "admin"  # 认证用户名
  password: "password"  # 认证密码

配置方式

1. 默认配置：将config.yml放在当前目录，执行：

   bash
   bin/gitlab-pages-satis
   

2. 指定配置文件：

   bash
   bin/gitlab-pages-satis /path/to/config.yml
   

3. 环境变量配置：

   bash
   export GITLAB_SATIS_CONFIG="
   arguments:
     gitlab-url: 'https://gitlab.example.org'
     gitlab-token: 'TOKEN'
   options:
     homepage: 'https://satis.example.org'
     output: 'satis.json'
     ignore: '(^knallimall\/typo3-desktop)'
   build-dir: './public'
   "
   

Docker部署示例

Docker Run命令

挂载本地配置文件：

bash
docker run -v $(pwd)/config.yml:/app/config.yml -v $(pwd)/public:/app/public ochorocho/gitlab-pages-satis bin/gitlab-pages-satis /app/config.yml

Docker Compose示例

yaml
version: '3'
services:
  satis:
    image: ochorocho/gitlab-pages-satis
    volumes:
      - ./config.yml:/app/config.yml
      - ./public:/app/public  # 挂载构建输出目录
    command: bin/gitlab-pages-satis /app/config.yml