Apache HugeGraph AI 项目教程
1. 项目的目录结构及介绍
incubator-hugegraph-ai/
├── README.md
├── LICENSE
├── NOTICE
├── conf
│ ├── hugegraph.properties
│ └── rest-server.properties
├── data
│ └── sample-data
├── docs
│ └── api-docs
├── scripts
│ ├── start.sh
│ └── stop.sh
├── src
│ ├── main
│ │ ├── java
│ │ └── resources
│ └── test
│ ├── java
│ └── resources
└── web
└── static
- README.md: 项目介绍和基本使用说明。
- LICENSE: 项目许可证。
- NOTICE: 项目依赖的第三方库和版权声明。
- conf: 配置文件目录。
- hugegraph.properties: 主要配置文件,包含数据库连接和存储设置。
- rest-server.properties: RESTful API 服务配置文件。
- data: 示例数据目录。
- sample-data: 包含一些示例数据文件。
- docs: 文档目录。
- api-docs: API 文档。
- scripts: 脚本目录。
- start.sh: 启动项目的脚本。
- stop.sh: 停止项目的脚本。
- src: 源代码目录。
- main: 主程序源代码。
- test: 测试代码。
- web: 前端资源目录。
- static: 静态文件,如 HTML, CSS, JavaScript 等。
2. 项目的启动文件介绍
项目的启动文件位于 scripts
目录下,主要包括:
- start.sh: 这是一个 shell 脚本,用于启动 HugeGraph AI 项目。执行该脚本会启动后端服务和 RESTful API 服务。
./scripts/start.sh
- stop.sh: 这是一个 shell 脚本,用于停止 HugeGraph AI 项目。执行该脚本会停止所有正在运行的服务。
./scripts/stop.sh
3. 项目的配置文件介绍
项目的配置文件位于 conf
目录下,主要包括:
- hugegraph.properties: 这是 HugeGraph AI 项目的主要配置文件,包含数据库连接、存储设置等关键配置。
# 数据库连接配置
backend=rocksdb
serializer=binary
store=hugegraph
# 存储路径
rocksdb.data_path=.
rocksdb.wal_path=.
- rest-server.properties: 这是 RESTful API 服务的配置文件,包含端口、认证等配置。
# 服务端口
restserver.url=http://127.0.0.1:8080
# 认证配置
auth.authenticator=com.baidu.hugegraph.auth.StandardAuthenticator
auth.admin_token=162f7843-8d13-427e-94cd-fa327c8990d7
通过这些配置文件,用户可以根据自己的需求调整 HugeGraph AI 项目的运行参数。