overture/score-server

SCORe 镜像文档

镜像概述和主要用途

SCORe（Secure Cloud Object Repository，安全云对象仓库）前身为ICGC Storage，是ICGC（国际癌症基因组联盟）云项目的存储与传输系统。该系统专为基于云的项目设计，支持S3和Azure后端存储，提供安全的对象存储与数据传输能力，目前已处于通用可用（GA）阶段。

核心功能和特性

• 多后端支持：兼容S3和Azure云存储后端
• 模块化设计：包含五大核心模块
  • Core：核心功能模块
  • Client：客户端工具
  • File System：文件系统集成
  • Server：服务端组件
  • Test：测试支持模块
• 开发支持：提供本地开发环境部署能力，支持调试
• 两种运行模式：开发模式（快速构建测试）和演示模式（完全隔离环境）
• 安全传输：专为敏感数据设计的安全传输机制

使用场景和适用范围

• ICGC云项目的日常数据存储与传输
• 需要对接S3或Azure后端的云存储解决方案
• 科研机构或组织的敏感数据安全存储需求
• 云存储系统的本地开发与测试环境搭建

详细使用方法和配置说明

文档参考

完整文档请访问 SCORe Read the Docs

构建方法

从仓库根目录执行以下命令进行编译、测试和打包：

shell
mvn

运行方法

各模块的具体运行说明请参考相应模块文档：

• Core
• Client
• File System
• Server
• Test

开发环境部署

提供多个make目标用于通过Docker本地部署依赖服务，支持两种开发模式：

1. 开发模式（默认）

特点：

• 在Docker主机上执行mvn package（若*-dist.tar.gz文件缺失）
• 将构建产物复制到容器中运行，缩短构建测试周期
• 暴露调试端口（score-client为5005，score-server为5006）

启用方式：DEMO_MODE=0（未定义时默认启用）

IntelliJ调试配置

调试score-client

1. 创建Docker镜像运行配置，使用make intellij-score-client-config命令输出的配置
2. 创建远程调试配置：
   • 主机：localhost
   • 端口：5005
   • 使用模块类路径：score-client
3. 在"启动前"部分添加：
   • "启动Docker前调试"，选择上述Docker配置，自定义选项：-p 5005:5005
   • "运行外部工具"，添加5秒延迟：

     名称：Sleep for 5 seconds
     程序：/usr/bin/sleep
     参数：5
     

4. 运行远程调试配置开始调试

调试score-server

1. 启动服务：make clean start-score-server
2. 创建远程调试配置：
   • 主机：localhost
   • 端口：5006
   • 使用模块类路径：score-server
3. 运行调试配置开始调试

2. 演示模式

特点：

• 在Docker容器内部执行构建，而非Docker主机
• 环境完全隔离，但构建速度较慢（Maven需每次下载依赖）

启用方式：DEMO_MODE=1

示例命令：

bash
make start-score-server DEMO_MODE=1

环境变量说明

其他命令

查看所有可用make目标：

bash
make help

变更日志

用户可见模块的变更记录请参见 CHANGES.md

许可信息

版权和许可信息请参见 LICENSE.md