DocIntel 项目安装与使用教程

DocIntel 项目安装与使用教程

DocIntel Open Source Platform for storing, organizing, and searching documents related to cyber threats 项目地址: https://gitcode.com/gh_mirrors/do/DocIntel

1. 项目的目录结构及介绍

DocIntel 项目是一个开源的威胁情报知识库，其目录结构如下：

• .github/: 存放 GitHub 工作流文件。
• DocIntel.AdminConsole: 管理控制台相关代码。
• DocIntel.Console: 控制台应用代码。
• DocIntel.Core: 核心功能代码。
• DocIntel.Core.Tests: 核心功能的单元测试。
• DocIntel.Extensions: 扩展功能代码。
• DocIntel.Integrations: 集成第三方服务代码。
• DocIntel.Services: 服务层代码，包括文档分析、索引、导入等。
• DocIntel.Services.Cron: 定时任务服务代码。
• DocIntel.Services.DocumentAnalyzer: 文档分析服务代码。
• DocIntel.Services.DocumentIndexer: 文档索引服务代码。
• DocIntel.Services.Importer: 文档导入服务代码。
• DocIntel.Services.Newsletters: 新闻订阅服务代码。
• DocIntel.Services.Scraper: 网页抓取服务代码。
• DocIntel.Services.SourceIndexer: 数据源索引服务代码。
• DocIntel.Services.TagIndexer: 标签索引服务代码。
• DocIntel.Services.Thumbnailer: 缩略图生成服务代码。
• DocIntel.Tests: 项目测试代码。
• DocIntel.WebApp: Web 应用程序代码。
• Library: 存放依赖库代码。
• conf: 配置文件。
• synsharp @ df5c762: SharpYaml 的 Git 子模块。
• .dockerignore: Docker 构建忽略文件。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块配置文件。
• DocIntel.sln: Visual Studio 解决方案文件。
• LICENSE.md: 项目许可证文件。
• README.md: 项目介绍文件。
• SECURITY.md: 安全策略文件。
• VERSION: 版本文件。
• build-docker-images.sh: 构建 Docker 镜像脚本。
• push-docker-images.sh: 推送 Docker 镜像脚本。
• run.sh: 运行脚本。

2. 项目的启动文件介绍

项目的启动文件为 run.sh 脚本，该脚本用于帮助用户以尽可能简单的方式安装应用程序。脚本会询问用户一些问题，并创建一个 docker-compose.yml 文件。

启动命令如下：

curl https://raw.githubusercontent.com/docintelapp/DocIntel/main/run.sh -o run.sh
sh run.sh

3. 项目的配置文件介绍

项目的配置文件主要包括 docker-compose.yml 文件，该文件定义了项目运行所需的服务和容器配置。

在运行 run.sh 脚本之后，会生成一个 docker-compose.yml 文件，用户可以检查配置并进行修改。然后使用以下命令启动部署：

docker compose -f docker-compose.yml -p docintel-dev up -d

在部署后，需要创建一个管理员账户才能登录平台。可以使用以下命令添加管理员用户：

docker exec -it docintel-dev-webapp \
dotnet /cli/DocIntel.AdminConsole.dll \
user add --username admin
docker exec -it docintel-dev-webapp \
dotnet /cli/DocIntel.AdminConsole.dll \
user role --username admin --role administrator

完成后，可以通过访问 http://localhost:5005 来登录平台。

DocIntel Open Source Platform for storing, organizing, and searching documents related to cyber threats 项目地址: https://gitcode.com/gh_mirrors/do/DocIntel