wurmlab/sequenceserver

SequenceServer - BLAST 搜索服务

镜像概述和主要用途

SequenceServer 是一个为 BLAST+ 工具提供直观 Web 界面的应用程序，可快速搭建本地化 BLAST 服务器，适用于个人或团队使用。它简化了 BLAST 数据库的管理和序列比对分析流程，提供现代化的用户界面和便捷的操作体验。

如果使用 SequenceServer，请引用以下论文：https://doi.org/10.1093/molbev/msz185

核心功能和特性

• 提供直观的 Web 界面，简化 BLAST 搜索流程
• 支持自定义 BLAST 数据库管理
• 支持多种 BLAST 分析工具集成
• 提供详细的搜索结果可视化和分析功能
• 支持本地部署和 Docker 容器化运行
• 开发模式支持，便于功能扩展和定制

使用场景和适用范围

• 生命科学研究机构搭建本地 BLAST 服务
• 科研团队内部共享 BLAST 数据库和分析结果
• 教学环境中 BLAST 工具的演示和教学
• 需要处理敏感序列数据的本地化分析
• 生物信息学流程中的 BLAST 分析模块集成

详细的使用方法和配置说明

环境要求

• Docker 环境（推荐）
• 或 Ruby (>= 2.5) 和 RubyGems
• 或 Node.js 和 npm（用于前端开发）

Docker 部署方案

1. 构建 Docker 镜像

bash
# 克隆代码仓库（如需修改源代码）
git clone https://github.com/wurmlab/sequenceserver.git
cd sequenceserver

# 修改 Dockerfile（如需使用开发环境）
# 将 Dockerfile 末尾的 "from final" 改为 "from dev"

# 构建镜像
docker build -t sequenceserver .

2. 基本运行方式

bash
# 简单运行（使用默认配置和示例数据库）
docker run --rm -it -p 4567:4567 docker.xuanyuan.run/sequenceserver

运行后，在浏览器中访问 http://localhost:4567 即可使用 SequenceServer。首次运行时，系统会提示进行初始配置，可选择默认选项快速启动。

3. 挂载自定义数据库

bash
# 创建本地数据库目录
mkdir -p ./blastdb

# 将自定义数据库文件放入 ./blastdb 目录后运行
docker run --rm -it -p 4567:4567 -v $(pwd)/blastdb:/db docker.xuanyuan.run/sequenceserver

4. 后台运行模式

bash
docker run -d --name docker.xuanyuan.run/sequenceserver -p 4567:4567 -v $(pwd)/blastdb:/db sequenceserver

5. Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  sequenceserver:
    build: .
    ports:
      - "4567:4567"
    volumes:
      - ./blastdb:/db
    restart: unless-stopped
    environment:
      - SEQUENCESERVER_PORT=4567
      - SEQUENCESERVER_HOST=0.0.0.0

启动服务：

bash
docker-compose up -d

配置参数说明

命令行参数

• -D: 开发模式运行，启用详细日志输出
• -h: 显示帮助信息
• -v: 显示版本信息
• -p <port>: 指定服务端口（默认：4567）
• -H <host>: 指定绑定地址（默认：0.0.0.0）

环境变量

• SEQUENCESERVER_PORT: 服务端口
• SEQUENCESERVER_HOST: 绑定地址
• BLASTDB: BLAST 数据库目录路径

从源代码运行（开发用途）

1. 安装依赖

bash
# 安装 bundler
gem install bundler

# 克隆代码仓库
git clone https://github.com/wurmlab/sequenceserver.git
cd sequenceserver

# 安装 Ruby 依赖
bundle install

# 如需跳过开发依赖
bundle install --without=development

2. 运行应用

bash
# 正常模式
bundle exec bin/sequenceserver

# 开发模式（详细日志）
bundle exec bin/sequenceserver -D

3. 前端开发

bash
# 安装前端依赖
npm install

# 运行前端开发服务器（自动构建更改）
npm run-script watch

# 构建生产版本的前端资源
npm run-script build

测试与开发

运行测试

bash
# Ruby 测试
bundle exec rspec

# JavaScript 测试
npm run test

# 运行单个测试文件
npm run test file_name

# 运行单个测试用例
npm run test -e "test name"

代码检查

bash
# 安装 CodeClimate
gem install codeclimate-test-reporter

# 运行所有代码检查
codeclimate analyze

# 运行特定检查
codeclimate analyze -e eslint   # JavaScript 检查
codeclimate analyze -e rubocop  # Ruby 代码检查
codeclimate analyze -e stylelint # CSS 检查

问题报告与支持

• GitHub 问题跟踪: https://github.com/wurmlab/sequenceserver/issues
• 社区支持论坛: [***]

版本更新

新版本发布信息将在以下渠道公布：

• GitHub 发布页面: https://github.com/wurmlab/sequenceserver/releases
• 支持页面: [***]

联系方式

• Yannick Wurm (PI): ***
• 官方网站: [] & []
• 邮件列表/论坛: [***]