OpenCGA 项目安装与使用教程

1. 项目目录结构及介绍

OpenCGA 项目的目录结构如下：

opencga/
├── docs/
├── misc/
├── opencga-analysis/
├── opencga-app/
├── opencga-catalog/
├── opencga-client/
├── opencga-clinical/
├── opencga-core/
├── opencga-master/
├── opencga-server/
├── opencga-storage/
├── opencga-test/
├── gitbook/
├── gitignore
├── Jenkinsfile
├── LICENSE
├── README.md
├── checkstyle.xml
├── pom.xml

目录结构介绍

• docs/: 包含项目的文档文件。
• misc/: 包含项目的杂项文件。
• opencga-analysis/: 包含分析相关的代码和配置文件。
• opencga-app/: 包含应用程序相关的代码和配置文件。
• opencga-catalog/: 包含元数据目录相关的代码和配置文件。
• opencga-client/: 包含客户端相关的代码和配置文件。
• opencga-clinical/: 包含临床相关的代码和配置文件。
• opencga-core/: 包含核心功能的代码和配置文件。
• opencga-master/: 包含主控相关的代码和配置文件。
• opencga-server/: 包含服务器相关的代码和配置文件。
• opencga-storage/: 包含存储相关的代码和配置文件。
• opencga-test/: 包含测试相关的代码和配置文件。
• gitbook/: 包含 GitBook 相关的文件。
• gitignore: Git 忽略文件。
• Jenkinsfile: Jenkins 构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• checkstyle.xml: Checkstyle 配置文件。
• pom.xml: Maven 项目配置文件。

2. 项目启动文件介绍

OpenCGA 项目的启动文件主要位于 opencga-server/ 目录下。主要的启动文件包括：

• opencga-server/src/main/java/org/opencb/opencga/server/OpenCGAApplication.java: 这是 OpenCGA 服务器的主启动类，负责初始化和启动整个应用程序。

启动步骤

1. 确保已经安装了 Java 8 或更高版本。

2. 进入 opencga-server/ 目录。

3. 运行以下命令启动服务器：

   java -jar opencga-server.jar
   

3. 项目配置文件介绍

OpenCGA 项目的配置文件主要位于 opencga-server/ 和 opencga-catalog/ 目录下。主要的配置文件包括：

• opencga-server/src/main/resources/application.yml: 这是服务器的主要配置文件，包含了服务器的端口、数据库连接、日志配置等信息。
• opencga-catalog/src/main/resources/catalog.yml: 这是元数据目录的配置文件，包含了数据库连接、用户权限、文件管理等信息。

配置文件示例

application.yml

server:
  port: 9090

spring:
  data:
    mongodb:
      uri: mongodb://localhost:27017/opencga

logging:
  level:
    org.opencb.opencga: DEBUG

catalog.yml

catalog:
  db:
    hosts: localhost:27017
    user: admin
    password: password
    authenticationDatabase: admin

通过修改这些配置文件，可以自定义 OpenCGA 的行为和功能。