OpenCTI 项目安装与使用教程

OpenCTI 项目安装与使用教程

opencti Open Cyber Threat Intelligence Platform 项目地址: https://gitcode.com/gh_mirrors/op/opencti

1. 项目目录结构及介绍

OpenCTI 项目的目录结构如下：

opencti/
├── circleci/
├── devcontainer/
├── github/
├── opencti-platform/
├── opencti-worker/
├── scripts/
├── drone.yml
├── gitattributes
├── gitignore
├── grenrc.js
├── pre-commit-config.yaml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
└── renovate.json

目录介绍：

• circleci/: 包含 CircleCI 的配置文件。
• devcontainer/: 包含开发容器的配置文件。
• github/: 包含 GitHub 相关的配置文件。
• opencti-platform/: 包含 OpenCTI 平台的核心代码。
• opencti-worker/: 包含 OpenCTI 工作者的代码。
• scripts/: 包含项目使用的脚本文件。
• drone.yml: Drone CI 的配置文件。
• gitattributes: Git 属性配置文件。
• gitignore: Git 忽略文件配置。
• grenrc.js: GitHub Release Notifier 配置文件。
• pre-commit-config.yaml: 预提交钩子配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• SECURITY.md: 安全指南文件。
• renovate.json: Renovate Bot 配置文件。

2. 项目启动文件介绍

OpenCTI 项目的启动文件主要位于 opencti-platform/ 目录下。以下是主要的启动文件：

• server.js: 这是 OpenCTI 平台的主服务器启动文件。它负责启动 GraphQL API 和前端服务。
• worker.js: 这是 OpenCTI 工作者启动文件，负责处理后台任务和数据处理。

启动命令：

# 启动 OpenCTI 平台
node opencti-platform/server.js

# 启动 OpenCTI 工作者
node opencti-worker/worker.js

3. 项目配置文件介绍

OpenCTI 项目的配置文件主要位于项目的根目录和 opencti-platform/ 目录下。以下是主要的配置文件：

• config.json: 这是 OpenCTI 平台的主要配置文件，包含数据库连接、API 密钥、日志级别等配置。
• docker-compose.yml: 这是 Docker 容器的配置文件，用于定义和配置 OpenCTI 的 Docker 服务。
• env.example: 这是环境变量的示例文件，用户可以根据此文件创建自己的 .env 文件。

配置文件示例：

{
  "database": {
    "host": "localhost",
    "port": 5432,
    "username": "opencti",
    "password": "password",
    "database": "opencti"
  },
  "api": {
    "key": "your-api-key"
  },
  "logging": {
    "level": "info"
  }
}

环境变量配置：

# 复制示例文件并创建 .env 文件
cp env.example .env

# 编辑 .env 文件
vi .env

通过以上步骤，您可以成功安装和配置 OpenCTI 项目，并启动平台和服务。

opencti Open Cyber Threat Intelligence Platform 项目地址: https://gitcode.com/gh_mirrors/op/opencti