bioplatformsaustralia/bpa-ckan

CKAN for data.bioplatforms.com Docker镜像文档

镜像概述和主要用途

本镜像为data.bioplatforms.com定制的CKAN（Comprehensive Knowledge Archive Network）Docker镜像。CKAN是一个开源的数据门户平台，旨在简化数据的发布、共享、管理和查找流程。该定制镜像针对生物数据领域优化，适用于生物信息学研究机构、生物样本库、科研项目团队等场景，提供专业化的生物数据门户解决方案，支持数据全生命周期管理与跨平台共享。

核心功能和特性

核心功能

• 数据集管理：支持生物数据集的创建、编辑、版本控制及归档
• 元数据定制：内置生物数据专用元数据字段（如样本类型、测序方法、伦理审批等）
• 数据预览与访问：支持常见生物数据格式（FASTA、BAM、VCF等）的在线预览，提供多种下载方式
• 用户与权限管理：基于角色的访问控制（RBAC），支持多级别用户权限配置（管理员、编辑者、查看者）
• API支持：提供RESTful API，支持与生物信息学工具（如Galaxy、ENA）集成
• 数据引用追踪：自动生成数据集DOI，支持学术引用统计

增强特性

• 生物数据扩展：集成CKANext-bioinfo扩展，支持生物数据标准化元数据模板
• 批量操作工具：内置批量导入/导出脚本，适配生物数据批量处理需求
• 数据质量校验：集成数据格式与完整性校验功能，确保生物数据合规性
• 多存储后端：支持本地存储、S3兼容对象存储及生物数据专用存储系统（如iRODS）

使用场景和适用范围

典型使用场景

• 生物数据门户建设：构建机构级生物数据门户，整合多源生物数据资源
• 研究团队数据共享：支持实验室或跨机构研究团队内部数据协作与共享
• 生物样本库管理：管理生物样本元数据及关联测序数据，实现样本-数据联动
• 学术数据发布：满足科研论文配套数据发布需求，提供持久化访问链接

适用范围

• 生物信息学研究机构
• 大学医学院/生命科学院
• 医院生物样本库
• 生物技术企业研发部门
• 国际/国家级生物数据中心

使用方法和配置说明

快速启动（Docker Run）

bash
docker run -d \
  --name ckan-bioplatforms \
  -p 80:5000 \
  -e CKAN_SITE_URL=http://localhost \
  -e CKAN_DB_USER=ckan \
  -e CKAN_DB_PASSWORD=securepassword \
  -e CKAN_DB_HOST=db \
  -e CKAN_DB_NAME=ckan \
  -e CKAN_ADMIN_USER=admin \
  -e CKAN_ADMIN_EMAIL=admin@example.com \
  -e CKAN_ADMIN_PASSWORD=adminpassword \
  -v ckan_config:/etc/ckan \
  -v ckan_data:/var/lib/ckan \
  bioplatforms/ckan:latest

Docker Compose配置示例

yaml
version: '3'

services:
  ckan:
    image: bioplatforms/ckan:latest
    ports:
      - "80:5000"
    environment:
      - CKAN_SITE_URL=http://localhost
      - CKAN_DB_USER=ckan
      - CKAN_DB_PASSWORD=securepassword
      - CKAN_DB_HOST=db
      - CKAN_DB_NAME=ckan
      - CKAN_REDIS_HOST=redis
      - CKAN_SMTP_SERVER=smtp.example.com
      - CKAN_SMTP_PORT=587
      - CKAN_SMTP_USER=smtp_user@example.com
      - CKAN_SMTP_PASSWORD=smtp_password
      - CKAN_ADMIN_USER=admin
      - CKAN_ADMIN_EMAIL=admin@example.com
      - CKAN_ADMIN_PASSWORD=adminpassword
    volumes:
      - ckan_config:/etc/ckan
      - ckan_data:/var/lib/ckan
    depends_on:
      - db
      - redis

  db:
    image: postgres:13
    environment:
      - POSTGRES_USER=ckan
      - POSTGRES_PASSWORD=securepassword
      - POSTGRES_DB=ckan
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redis:
    image: redis:6
    volumes:
      - redis_data:/data

volumes:
  ckan_config:
  ckan_data:
  postgres_data:
  redis_data:

环境变量配置说明

持久化存储配置

为确保数据持久化，需挂载以下目录：

• /etc/ckan：配置文件目录（包含生物数据元数据模板）
• /var/lib/ckan：数据存储目录（包含上传的数据集文件）
• 数据库与Redis数据卷（通过docker-compose volumes配置）

初始化与维护

1. 首次启动初始化：

   bash
   docker exec -it ckan-bioplatforms ckan db init
   docker exec -it ckan-bioplatforms ckan sysadmin add $CKAN_ADMIN_USER
   

2. 生物数据扩展启用：

   bash
   docker exec -it ckan-bioplatforms ckan extension enable ckanext-bioinfo
   docker exec -it ckan-bioplatforms ckan db upgrade -p bioinfo
   

3. 日志查看：

   bash
   docker logs -f ckan-bioplatforms
   

注意事项

• 生产环境需配置HTTPS（建议通过Nginx反向代理实现）
• 生物数据通常体积较大，建议配置外部存储（如S3）而非本地存储
• 定期备份PostgreSQL数据库及/var/lib/ckan目录
• 升级镜像前请备份配置文件及数据卷