oxynozeta/s3-proxy

S3-Proxy Docker镜像文档

镜像概述

S3-Proxy是一款功能全面的S3代理工具，通过HTTP/HTTPS协议提供对Amazon S3或兼容S3接口存储服务的访问能力。该工具支持文件上传（PUT）、下载（GET）和删除（DELETE）操作，集成多种认证机制，并提供灵活的配置选项，适用于需要安全管理和访问S3存储资源的场景。

核心功能和特性

• 多S3桶代理：支持同时配置和代理多个S3存储桶
• 索引文档支持：检测到索引文档时自动展示该文档，而非文件列表
• 自定义模板：允许使用自定义HTML模板定制界面展示
• S3端点自定义：兼容非AWS的S3兼容存储服务（如MinIO、Ceph等）
• 认证机制：
  • 基本认证（Basic Authentication）及多规则配置
  • OpenID Connect（OIDC）认证及多提供商支持
  • 基于访问路径和HTTP方法的细粒度认证控制
• 访问控制：支持按主机名和多路径配置桶挂载点
• OIDC重定向优化：认证完成后自动重定向至原始请求的主机和路径
• 监控集成：提供Prometheus指标接口，支持性能和访问量监控
• 文件操作：允许通过HTTP协议上传（发布）和删除S3桶中的文件

使用场景和适用范围

• Web化S3访问：需要通过浏览器或HTTP客户端便捷访问S3存储内容
• 权限管理：需对S3资源访问进行严格认证和授权控制（如限制特定用户或IP）
• 文件管理：需要通过HTTP接口实现S3文件的上传、下载和删除操作
• 监控需求：需收集S3访问指标（请求量、响应时间等）进行监控和分析
• 多环境适配：使用私有S3兼容存储服务时提供标准化访问入口

使用方法和配置说明

前提条件

• 已安装Docker环境
• 拥有S3或兼容存储服务的访问密钥（Access Key ID/Secret Access Key）
• （可选）认证配置所需的Basic Auth凭证或OIDC提供商信息

获取镜像

从Docker Hub拉取最新版本镜像：

bash
docker pull oxynozeta/s3-proxy:latest

基础部署示例

1. 单容器部署（Docker Run）

需提前创建配置文件（配置规范见https://oxyno-zeta.github.io/s3-proxy/%EF%BC%89%EF%BC%8C%E7%A4%BA%E4%BE%8B%E5%91%BD%E4%BB%A4%EF%BC%9A

bash
docker run -d \
  --name s3-proxy \
  -p 8080:8080 \
  -v /local/path/to/config.yaml:/app/config.yaml \
  oxynozeta/s3-proxy:latest \
  --config /app/config.yaml

2. Docker Compose部署

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  s3-proxy:
    image: oxynozeta/s3-proxy:latest
    container_name: s3-proxy
    restart: unless-stopped
    ports:
      - "8080:8080"  # 代理服务端口
      - "9090:9090"  # Prometheus指标端口（若启用）
    volumes:
      - ./config.yaml:/app/config.yaml  # 挂载配置文件
      - ./templates:/app/templates      # （可选）挂载自定义模板
    command: --config /app/config.yaml

启动服务：

bash
docker-compose up -d

配置说明

S3-Proxy通过YAML配置文件进行功能定义，核心配置项包括：

• 全局设置（监听端口、日志级别等）
• 存储桶配置（S3端点、访问密钥、挂载路径等）
• 认证规则（Basic Auth/OIDC配置、路径/方法权限控制）
• 模板和索引文档设置
• 监控指标开关

详细配置示例及参数说明请参考https://oxyno-zeta.github.io/s3-proxy/%E3%80%82

访问验证

服务启动后，通过以下方式访问S3资源：

• 基础访问：http://<部署主机IP>:8080/<桶挂载路径>/<文件路径>
• 指标监控：若启用，访问http://<部署主机IP>:9090/metrics获取Prometheus指标

参考资源

• 官方文档：https://oxyno-zeta.github.io/s3-proxy/
• 项目源码：https://github.com/oxyno-zeta/s3-proxy
• Docker镜像：https://hub.docker.com/r/oxynozeta/s3-proxy