This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/master by this push:
new 2bd5b1ce doc: update hugegraph-server.md (#195)
2bd5b1ce is described below
commit 2bd5b1ce85ec2a1cffcb2daccbe5a0fb06932147
Author: imbajin <[email protected]>
AuthorDate: Fri Feb 10 23:22:50 2023 +0800
doc: update hugegraph-server.md (#195)
* Update hugegraph-server.md
* Update hugegraph-server.md
---
content/en/docs/quickstart/hugegraph-server.md | 33 +++++++++++++++-----------
1 file changed, 19 insertions(+), 14 deletions(-)
diff --git a/content/en/docs/quickstart/hugegraph-server.md
b/content/en/docs/quickstart/hugegraph-server.md
index 7dee5ee0..76ffbef7 100644
--- a/content/en/docs/quickstart/hugegraph-server.md
+++ b/content/en/docs/quickstart/hugegraph-server.md
@@ -1,12 +1,12 @@
---
title: "HugeGraph-Server Quick Start"
-linkTitle: "Install HugeGraph-Server"
+linkTitle: "Install/Build HugeGraph-Server"
weight: 1
---
### 1 HugeGraph-Server Overview
-HugeGraph-Server is the core part of the HugeGraph Project, contains
submodules such as Core、Backend、API.
+`HugeGraph-Server` is the core part of the HugeGraph Project, contains
submodules such as Core、Backend、API.
The Core Module is an implementation of the Tinkerpop interface; The Backend
module is used to save the graph data to the data store, currently supported
backends include：Memory、Cassandra、ScyllaDB、RocksDB; The API Module provides
HTTP Server, which converts Client's HTTP request into a call to Core Module.
@@ -37,21 +37,25 @@ gcc --version
There are three ways to deploy HugeGraph-Server components:
- Method 1: One-click deployment
-- Method 2: Download the tarball
+- Method 2: Download the tarball (most recommended)
- Method 3: Source code compilation
#### 3.1 One-click deployment
-HugeGraph-Tools provides a command-line tool for one-click deployment, users
can use this tool to quickly download、decompress、configure and start
HugeGraphServer and HugeGraphStudio with one click.
-of course, you still have to download the tarball of HugeGraph-Tools first.
+HugeGraph-Tools provides a command-line tool for one-click deployment, users
can use this tool to quickly download、decompress、configure and start
HugeGraphServer and HugeGraph-Hubble with one click.
+
+Of course, you should download the tarball of HugeGraph-Toolchain first.
```bash
-wget
https://github.com/hugegraph/hugegraph-tools/releases/download/v${version}/hugegraph-tools-${version}.tar.gz
-tar -zxvf hugegraph-tools-${version}.tar.gz
-cd hugegraph-tools-${version}
+# download toolchain package, it includes loader + tool + hubble, please check
the latest version (here is 1.0.0)
+wget
https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
+tar zxf *hugegraph-*.tar.gz
+
+# enter the tool's package
+cd *hugegraph*/*tool*
```
-> note：${version} is the version, The latest version can refer to [Download
Page](/docs/download/download), Or click the link to download directly from the
Download page
+> note：${version} is the version, The latest version can refer to [Download
Page](/docs/download/download), or click the link to download directly from the
Download page
The general entry script for HugeGraph-Tools is `bin/hugegraph`, Users can use
the `help` command to view its usage, here only the commands for one-click
deployment are introduced.
@@ -64,8 +68,9 @@ bin/hugegraph deploy -v {hugegraph-version} -p {install-path}
[-u {download-path
#### 3.2 Download the tar tarball
```bash
-wget
https://github.com/hugegraph/hugegraph/releases/download/v${version}/hugegraph-${version}.tar.gz
-tar -zxvf hugegraph-${version}.tar.gz
+# use the latest version, here is 1.0.0 for example
+wget
https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-incubating-1.0.0.tar.gz
+tar zxf *hugegraph*.tar.gz
```
#### 3.3 Source code compilation
@@ -73,14 +78,14 @@ tar -zxvf hugegraph-${version}.tar.gz
Download HugeGraph source code
```bash
-git clone https://github.com/hugegraph/hugegraph.git
+git clone https://github.com/apache/hugegraph.git
```
Compile and generate tarball
```bash
cd hugegraph
-mvn package -DskipTests
+mvn package -DskipTests -ntp
```
The execution log is as follows:
@@ -106,7 +111,7 @@ The execution log is as follows:
......
```
-After successful execution, hugegraph-*.tar.gz files will be generated in the
hugegraph directory, which is the tarball generated by compilation.
+After successful execution, `*hugegraph-*.tar.gz` files will be generated in
the hugegraph directory, which is the tarball generated by compilation.
### 4 Config
