Skip to content

Commit 22f4dd1

Browse files
committed
docs: update README with requirements and architecture info
Added sections for Requirements and Architecture, specifying Java and Maven versions and deployment options. Updated Docker command to use version 1.7.0. Included build from source instructions with Maven command.
1 parent 9a67014 commit 22f4dd1

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ achieved through the powerful [Gremlin](https://tinkerpop.apache.org/gremlin.htm
3030
- Integration with `Flink/Spark/HDFS`, and friendly to connect other big data platforms
3131
- Complete graph ecosystem (including both in/out-memory `Graph Computing` + `Graph Visualization & Tools` + `Graph Learning & AI`, see [here](#3-build-from-source))
3232

33+
## Architecture
34+
35+
HugeGraph supports both **standalone** and **distributed** deployments:
36+
37+
| Module | Description |
38+
|----------------------------------------|-----------------------------------------------------------------------------------------------------------|
39+
| [hugegraph-server](hugegraph-server) | Core graph engine with REST API, Gremlin/Cypher support, and pluggable backends (RocksDB default) |
40+
| [hugegraph-pd](hugegraph-pd) | Placement Driver for distributed mode - handles meta storage, partition management and cluster scheduling |
41+
| [hugegraph-store](hugegraph-store) | Distributed storage with Raft consensus for high availability and horizontal scaling |
42+
| [hugegraph-commons](hugegraph-commons) | shared utilities, RPC framework and common components |
43+
44+
- **Standalone**: HugeGraph Server + RocksDB (for all-in-one deployment)
45+
- **Distributed**: HugeGraph Server + PD + Store (Raft + RocksDB by default)
46+
3347
## Quick Start
3448

3549
### 1. Docker (For Test)
@@ -39,7 +53,7 @@ Use Docker to quickly start a HugeGraph server with `RocksDB` (in the background
3953
```
4054
# (Optional)
4155
# - add "-e PRELOAD=true" to auto-load a sample graph
42-
docker run -itd --name=graph -e PASSWORD=xxx -p 8080:8080 hugegraph/hugegraph:1.5.0
56+
docker run -itd --name=graph -e PASSWORD=xxx -p 8080:8080 hugegraph/hugegraph:1.7.0
4357
```
4458

4559
Please visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or
@@ -54,7 +68,7 @@ the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details.
5468
Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) and refer the [doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#32-download-the-binary-tar-tarball)
5569
to download the latest release package and start the server.
5670

57-
**Note:** if you want to use it in the production environment or expose it to the public network, must enable the [AuthSystem](https://hugegraph.apache.org/docs/config/config-authentication/) to ensure safe.
71+
**Note:** if you want to use it in the production environment or expose it to the public network, you must enable the [AuthSystem](https://hugegraph.apache.org/docs/config/config-authentication/) to ensure safe.
5872

5973
### 3. Build From Source
6074

@@ -64,7 +78,9 @@ steps to build the source code and start the server.
6478
The project [doc page](https://hugegraph.apache.org/docs/) contains more information on HugeGraph
6579
and provides detailed documentation for users. (Structure / Usage / API / Configs...)
6680

67-
And here are links of other **HugeGraph** component/repositories:
81+
## Ecosystem
82+
83+
Other **HugeGraph** components/repositories:
6884

6985
1. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (graph tools **[loader](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-loader)/[dashboard](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-hubble)/[tool](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-tools)/[client](https://github.com/apache/hugegraph-toolchain/tree/master/hugegraph-client)**)
7086
2. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (integrated **graph computing** system)

0 commit comments

Comments
 (0)