primetechsg/circleci-ruby

Ruby-Alpine扩展镜像文档

1. 镜像概述

本镜像基于官方ruby-alpine镜像构建，是其功能扩展版本。在保留Ruby运行环境的基础上，集成了gnupg1、gpgme、chromium等工具，旨在为需要Ruby环境且依赖加密操作、GPG功能或浏览器渲染能力的应用提供轻量级解决方案。

2. 核心功能与特性

2.1 基础环境

• 继承ruby-alpine的轻量级特性，基于Alpine Linux构建，镜像体积小，资源占用低
• 包含完整Ruby运行环境，版本与官方ruby-alpine镜像保持一致

2.2 集成工具

• gnupg1：GNU Privacy Guard工具，支持数据加密、签名、验证及密钥管理
• gpgme：GPG加密支持库，提供编程接口，便于Ruby应用通过代码调用GPG功能
• chromium：开源浏览器，支持网页渲染、DOM操作，适用于需要浏览器环境的Ruby脚本（如网页截图、前端自动化测试等）

3. 使用场景

• 需要GPG加密/签名功能的Ruby应用（如加密配置文件处理、安全通信服务）
• 集成GPGME库的Ruby脚本开发与运行
• 依赖浏览器渲染的Ruby工具（如基于浏览器的网页内容抓取、前端组件测试）
• 轻量级Ruby开发环境，需同时满足加密操作与浏览器功能需求

4. 使用方法

4.1 基本使用

通过docker run命令直接启动镜像，进入交互式Ruby环境：

bash
docker run --rm -it [镜像名称] irb

运行本地Ruby脚本（将当前目录挂载到容器内/app目录）：

bash
docker run --rm -v $(pwd):/app -w /app [镜像名称] ruby your_script.rb

4.2 环境变量

本镜像继承ruby-alpine的环境变量配置，常用变量包括：

• RUBY_VERSION：Ruby版本（与基础镜像一致）
• BUNDLE_PATH：Bundler依赖安装路径（默认/usr/local/bundle）
• 其他Alpine基础环境变量（如PATH、LANG等）

4.3 docker-compose示例

以下为使用docker-compose管理镜像的示例配置（docker-compose.yml）：

yaml
version: '3.8'

services:
  ruby-app:
    image: [镜像名称]
    volumes:
      - ./app:/app  # 挂载本地应用代码
      - ./gpg-keys:/root/.gnupg  # 挂载GPG密钥目录（可选）
    working_dir: /app
    command: ruby main.rb  # 运行应用入口脚本
    environment:
      - RUBY_ENV=production  # 设置Ruby环境

5. 注意事项

• 镜像基于Alpine Linux，部分依赖可能需要通过apk包管理器安装（如apk add --no-cache [package]）
• Chromium运行时可能需要配置沙箱权限，建议在非生产环境或可信环境中使用
• GPG密钥管理需注意文件权限，挂载密钥目录时建议设置正确的读写权限（如chmod 700 ./gpg-keys）