You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
|[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
+
33
47
## Quick Start
34
48
35
49
### 1. Docker (For Test)
@@ -39,7 +53,7 @@ Use Docker to quickly start a HugeGraph server with `RocksDB` (in the background
39
53
```
40
54
# (Optional)
41
55
# - 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
43
57
```
44
58
45
59
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.
54
68
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)
55
69
to download the latest release package and start the server.
56
70
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.
58
72
59
73
### 3. Build From Source
60
74
@@ -64,7 +78,9 @@ steps to build the source code and start the server.
64
78
The project [doc page](https://hugegraph.apache.org/docs/) contains more information on HugeGraph
65
79
and provides detailed documentation for users. (Structure / Usage / API / Configs...)
66
80
67
-
And here are links of other **HugeGraph** component/repositories:
0 commit comments