liquidinvestigations/hoover-ui

Hoover UI

概述

Hoover UI是Hoover的高级用户界面，属于Liquid Investigations项目，旨在提供直观且功能丰富的交互体验。该项目支持本地开发与生产环境部署，可灵活配置与Hoover后端服务的连接，适用于需要高效管理和交互Hoover数据的场景。

• https://github.com/liquidinvestigations/hoover-ui.git
• https://github.com/liquidinvestigations/docs/wiki
• https://github.com/liquidinvestigations/docs/wiki/Security
• https://github.com/liquidinvestigations/docs/wiki/Contributing
• https://github.com/liquidinvestigations/docs/blob/37c1fd98b643a10a321ae124f2636ce738cb159d/github_community_health/files/.github/CODE_OF_CONDUCT.md

核心功能与特性

• 多环境支持：提供开发服务器（热重载）和生产服务器（优化构建）两种部署模式，均默认监听8000端口。
• 灵活的后端集成：通过环境变量配置后端服务URL，支持本地开发时代理后端API。
• 可配置的搜索参数：支持调整搜索请求并发控制、重试策略、异步搜索轮询间隔等参数。
• 扩展的图标支持：集成MaterialUI Icons、Font Awesome（免费版，solid风格）等图标库，支持添加SVG格式的第三方图标库。
• 功能开关：通过环境变量控制顶部菜单中的地图和翻译链接显示。

使用场景与适用范围

• 本地开发：前端开发者可独立运行UI代码，连接现有后端服务或本地完整技术栈进行功能开发与调试。
• 后端集成：作为Hoover后端服务的前端界面，适用于需要直观数据交互的场景。
• 生产部署：通过构建优化的生产版本，部署到服务器提供稳定的用户界面服务。

使用方法与配置说明

安装

开发UI需依赖最新版Node.js（版本见package.json中的"engine"字段）。

1. 下载代码并安装依赖

   shell
   git clone https://github.com/liquidinvestigations/hoover-ui.git
   cd hoover-ui
   npm install
   

2. 启动开发服务器

   shell
   npm run dev
   

3. 启动生产服务器

   shell
   npm run build
   npm run prod
   

所有服务器默认监听8000端口。

开发方式

可通过两种方式进行开发：连接现有后端服务（需登录权限）或本地运行完整技术栈。

仅运行UI代码，连接现有后端

1. 配置环境变量：设置以下环境变量以连接现有后端

   • API_URL=https://hoover.your.server.url：后端服务器URL（必填）
   • REWRITE_API=true：启用后端API代理（用于本地开发）
   • NODE_TLS_REJECT_UNAUTHORIZED=0：允许无SSL的本地代理

   可在启动脚本中配置环境变量（修改package.json的"scripts"）：

   json
   "scripts": {
       ...
       "dev": "cross-env API_URL=https://hoover.your.server.url REWRITE_API=1 NODE_TLS_REJECT_UNAUTHORIZED=0 next dev -p 8000 -H 0.0.0.0",
       ...
   }
   

2. 授权配置：通过浏览器开发工具复制认证Cookie

   1. 登录https://your.server.url并访问Hoover
   2. 打开开发工具的Cookies（Chrome：Application -> Cookies；Firefox：Data -> Cookies），找到_oauth2_proxy...开头的Cookie名称
   3. 启动本地开发服务器，打开http://localhost:8000的开发工具Cookies，粘贴Cookie名称
   4. 复制并粘贴Cookie值，完成授权

运行完整本地技术栈

需满足https://github.com/liquidinvestigations/docs/wiki/Hardware-requirements#storage%EF%BC%88%E4%BB%85%E8%BF%90%E8%A1%8CHoover%E9%9C%80%E8%87%B3%E5%B0%9116GB%E7%A9%BA%E9%97%B2RAM%EF%BC%89%E3%80%82%E9%80%9A%E8%BF%87%E8%AE%BE%E7%BD%AEhttps://github.com/liquidinvestigations/node/blob/master/docs/Development.md%E8%BF%90%E8%A1%8CLiquid Investigations，可在本地仓库中修改代码。

使用Docker运行npm

可使用npm.docker.sh脚本替代本地npm二进制文件，该脚本以当前用户身份运行Docker镜像并执行npm命令。示例：

shell
./npm.docker.sh test -- -u

Node版本升级

升级Node版本需修改以下文件中的版本号：

• package.json（"engine"字段）
• .travis.yml
• Dockerfile

图标库

项目使用以下图标库：

• MaterialUI Icons
• Font Awesome（免费版，solid风格）

可添加支持SVG格式的其他图标库（如Bootstrap Icons）。

环境变量