adobe/s3mock

S3Mock Docker镜像文档

1. 镜像概述与主要用途

S3Mock 是一款轻量级服务器，实现了部分 Amazon S3 API。其核心用途是支持封闭测试（hermetic testing），减少软件开发与测试过程中对外部基础设施（如真实 AWS S3 服务）的依赖，提供本地可控的 S3 服务模拟环境。

2. 核心功能与特性

• 轻量级设计：资源占用低，适合本地部署和测试场景。
• S3 API 模拟：实现部分 Amazon S3 API，支持基本的 S3 服务交互模拟。
• 多协议支持：暴露 HTTP（9090 端口）和 HTTPS（9191 端口）两种访问方式。
• 封闭测试支持：无需依赖外部服务，确保测试环境的独立性和可重复性。
• 降低依赖：减少测试阶段对真实 AWS 账户及 S3 服务的依赖，简化测试流程。

3. 使用场景与适用范围

• 软件开发测试：单元测试、集成测试中需模拟 S3 服务交互的场景（如文件上传、下载、列表等操作测试）。
• 本地开发环境：替代真实 S3 服务，用于开发阶段的功能验证和调试。
• 封闭测试环境：确保测试过程不受外部网络或服务可用性影响，提升测试稳定性。
• 教学与演示：无需配置真实 AWS 账户，即可展示 S3 API 的使用方法和功能特性。

4. 使用方法

4.1 基本运行（Docker Run）

通过 docker run 命令直接启动 S3Mock 容器，需映射 HTTP 和 HTTPS 端口：

bash
# 启动 S3Mock 容器，映射本地端口到容器端口
docker run -p 9090:9090 -p 9191:9191 -t docker.xuanyuan.run/adobe/s3mock

# 停止容器：在运行容器的终端中按 Ctrl+C

参数说明：

• -p 9090:9090：映射本地 9090 端口到容器 HTTP 服务端口（用于 HTTP 访问）。
• -p 9191:9191：映射本地 9191 端口到容器 HTTPS 服务端口（用于 HTTPS 访问）。
• -t：分配伪终端，支持终端交互（如查看日志、停止容器）。

4.2 Docker Compose 配置（示例）

通过 docker-compose.yml 配置文件管理 S3Mock 服务，适用于多服务协同的开发/测试环境：

yaml
version: '3'
services:
  s3mock:
    image: docker.xuanyuan.run/adobe/s3mock
    ports:
      - "9090:9090"  # HTTP 端口映射
      - "9191:9191"  # HTTPS 端口映射
    restart: unless-stopped  # 除非手动停止，否则容器退出后自动重启

启动命令：

bash
docker-compose up -d  # 后台启动服务
docker-compose down    # 停止并移除服务

5. 配置说明

当前版本的 S3Mock Docker 镜像未提供额外可配置的环境变量或启动参数，默认配置即可满足基本使用需求。容器启动后，可通过以下地址访问服务：

• HTTP 服务：http://localhost:9090
• HTTPS 服务：https://localhost:9191

6. 更多信息

如需了解 S3Mock 的完整功能、API 支持列表或高级配置，请参考官方文档：
https://github.com/adobe/S3Mock