StaPH-B Docker镜像仓库文档

镜像概述和主要用途

本仓库包含StaPH-B（州公共卫生实验室生物信息学）联盟成员使用的各类程序的Docker镜像构建所需的Dockerfile及其他相关文件。其核心目的是提供一个集中化的Docker镜像资源库，方便用户访问，并提供清晰的文档说明容器的构建过程和使用方法。

核心功能和特性

1. 集中化资源管理：统一托管生物信息学工具的Docker镜像，简化工具获取和部署流程。
2. 多平台镜像托管：镜像同步托管于Dockerhub和Quay.io两大平台，确保高可用性。
3. 无拉取限制：已通过Docker“开源计划”认证，所有staphb镜像无拉取次数限制。
4. Singularity兼容性：所有容器均兼容Singularity，支持通过Singularity下载和运行。
5. 丰富工具覆盖：包含数百个生物信息学工具镜像，覆盖基因分析、序列比对、进化树构建等多个领域。
6. 清晰文档支持：提供详细的用户指南，包括Docker容器使用和开发最佳实践。

使用场景和适用范围

适用场景

• 公共卫生实验室病原体基因组监测（如SARS-CoV-2及其他重要公共卫生相关病原体）。
• 生物信息学研究中各类工具的快速部署与环境一致性保障。
• 跨平台（Docker/Singularity）的工具使用需求。

适用人群

• 公共卫生领域研究人员及实验室技术人员。
• 生物信息学工具开发者和使用者。
• 需要标准化分析流程的科研团队。

镜像仓库与托管

托管平台

StaPH-B镜像同时托管于以下两个平台，并定期同步：

1. Dockerhub：[***]
2. Quay.io：[***]

拉取限制说明

2020年11月起，Dockerhub对镜像拉取实施限流（如匿名用户每6小时100次拉取）。StaPH-B已通过Docker“开源计划”认证，所有staphb镜像不受拉取限制。若遇到类似ERROR: toomanyrequests的限流错误，请通过提交issue反馈。

使用方法和配置说明

Docker使用

拉取镜像

从Dockerhub拉取镜像：

docker pull staphb/<镜像名>:<版本标签>
# 示例：拉取ABRicate 1.0.0版本
docker pull staphb/abricate:1.0.0

从Quay.io拉取镜像：

docker pull quay.io/staphb/<镜像名>:<版本标签>

运行容器

以ABRicate为例，运行容器并挂载本地数据目录：

docker run --rm -v /本地数据目录:/data staphb/abricate:1.0.0 abricate /data/input.fasta

Singularity使用

大部分Docker镜像可直接转换为Singularity格式。具体步骤参考Docker用户指南，基本流程如下：

# 从Dockerhub下载并转换为Singularity镜像
singularity pull docker://staphb/<镜像名>:<版本标签>

# 运行Singularity容器
singularity run <镜像名>_<版本标签>.sif <命令>

可用Docker镜像列表

贡献指南

若需贡献新镜像或改进现有镜像，请按以下步骤操作：

1. Fork本仓库；
2. 进行修改或添加；
3. 提交Pull Request。

贡献详情参见贡献指南。

问题反馈

使用中遇到问题（如镜像不兼容Singularity、拉取错误等），请通过GitHub Issues提交反馈。