cross12tamu/apollo

Apollo 镜像文档

镜像概述

Apollo 是一个协作式、实时的基因组注释编辑器，技术栈包括 Java Web 应用/数据库后端和运行在网页浏览器中的 Javascript 客户端（作为 JBrowse 插件实现）。该工具旨在实现基因组注释的民主化，支持科研团队协同进行基因组注释工作。

核心功能与特性

• 协作实时编辑：支持多用户同时进行基因组注释，实时同步编辑内容
• JBrowse 集成：客户端作为 JBrowse 插件实现，可利用 JBrowse 的基因组浏览器功能
• 多数据目录支持：允许配置多个数据目录，且数据目录需存储在 Tomcat webapps 目录之外
• 灵活部署选项：支持 Docker 部署、AWS EC2 实例部署、本地临时服务器运行等多种方式
• Web 服务接口：提供 Python 库及其他 Web 服务示例，支持程序matic 操作
• 数据迁移支持：提供从旧版本迁移注释和数据的指南

使用场景

• 基因组注释项目的团队协作
• 科研机构内部的基因组数据注释与管理
• 教学环境中的基因组注释实践
• 需要实时协作的基因组学研究

使用方法

Docker 部署

Apollo 可通过 Docker 启动，具体部署步骤可参考 https://github.com/GMOD/Apollo/blob/develop/docs/Docker.md%E3%80%82

本地临时服务器运行

使用以下命令启动临时服务器，自动初始化 H2 数据库（零配置）：

bash
apollo run-local 8080

若已配置 apollo-config.groovy 文件，将自动应用自定义设置。

生成 WAR 文件（生产部署）

生成可部署到 Tomcat 的 WAR 文件：

bash
apollo deploy

生成的 WAR 文件（如 target/apollo-1.0.2.war）需复制到 Tomcat 的 webapps 目录。注意：生产环境需根据示例文件（如 sample-postgres-apollo-config.groovy）创建 apollo-config.groovy，配置数据库等参数。

开发模式运行

单终端模式

bash
apollo devmode

双终端模式

终端 1：

bash
apollo run-local

终端 2：

bash
gradlew devmode

配置说明

数据目录设置

Apollo 2.X 允许添加多个数据目录，需存储在 Tomcat webapps 目录之外。详细配置方法参见 https://github.com/GMOD/Apollo/blob/develop/docs/Apollo2Build.md%E3%80%82

重要提示：执行 Tomcat "undeploy" 操作时，webapps 目录下的所有数据（即使是符号链接）都会丢失。

配置文件

主要配置文件为 apollo-config.groovy，可根据需求配置数据库连接、数据目录、JBrowse 插件等。示例配置文件可参考项目中的样本文件。

数据迁移

从旧版本迁移注释和数据，请参考 https://github.com/GMOD/Apollo/blob/develop/docs/Migration.md%E3%80%82

Web 服务

• Python 库：可通过 apollo PyPI 包 访问 Web 服务
• 示例代码：更多 Web 服务示例见 https://github.com/GMOD/Apollo/tree/develop/docs/web_services/examples

引用与社区

引用 Apollo 请使用：
Dunn NA, Unni DR, Diesh C, Munoz-Torres M, Harris NL, Yao E, et al. (2019) Apollo: Democratizing genome annotation. PLoS Comput Biol 15(2): e***. <[***]>

社区支持：

• 邮件列表：***
• Google 群组：Apollo 论坛
• 历史存档：Nabble 存档

完整文档：Apollo 文档页面