This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 83e4cb70 fix: hugegraph-server.md chapter 5.2.2 (#404)
83e4cb70 is described below
commit 83e4cb70653951c6c0f7c813b413183b5b029268
Author: imbajin <[email protected]>
AuthorDate: Wed Jun 4 13:37:08 2025 +0000
fix: hugegraph-server.md chapter 5.2.2 (#404)
Chapter 5.2.2 has an indentation issue in the docker-compose.yml code.
8fb4563e2c8c8308e8d31aec85f52a4f5e99f509
---
cn/docs/_print/index.html | 20 ++++++++++----------
cn/docs/index.xml | 2 +-
cn/docs/quickstart/_print/index.html | 20 ++++++++++----------
cn/docs/quickstart/hugegraph-server/index.html | 26 +++++++++++++-------------
cn/docs/quickstart/index.xml | 2 +-
cn/sitemap.xml | 2 +-
sitemap.xml | 2 +-
7 files changed, 37 insertions(+), 37 deletions(-)
diff --git a/cn/docs/_print/index.html b/cn/docs/_print/index.html
index c032888d..00e0c3d6 100644
--- a/cn/docs/_print/index.html
+++ b/cn/docs/_print/index.html
@@ -212,16 +212,16 @@ HugeGraph 支持多用户并行操作，用户可输入 Gremlin 查询语句，
</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>hugegraph-data</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span></code></pre></div><p>在这个 yaml 中，需要在环境变量中以
<code>hugegraph.<parameter_name></code>的形式进行参数传递，配置 Cassandra
相关的参数。</p><p>具体来说，在 <code>hugegraph.properties</code> 配置文件中，提供了
<code>backend=xxx</code>, <code>cassandra.host=xxx</code>
等配置项，为了配置这些配置项，在传递环境变量的过程之中，我们需要在这些配置项前加上 <code>hugegrpah.</code>，即
<code>hugegraph.backend</code> 和
<code>hugegraph.cassandra.host</code>。</p><p>其他配置可以参照 <a
href=#4-%E9%85%8D%E7%BD%AE>4 配置</a></p></details><h5
id=522-启动-server-的时候创建示例图>5.2. [...]
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>services</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>server</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>image</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>hugegraph/hugegraph:1.5.0</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>container_name</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>server</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>environment</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>PRELOAD=true</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>/path/to/yourscript:/hugegraph/scripts/example.groovy</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>ports</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>services</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>server</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>image</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>hugegraph/hugegraph:1.5.0</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>container_name</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>server</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>environment</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>PRELOAD=true</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>/path/to/yourscript:/hugegraph/scripts/example.groovy</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>ports</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span></code></pre></div><p>使用命令 <code>docker-compose up
-d</code> 启动容器</p></li></ol><p>使用 RESTful API 请求 <code>HugeGraphServer</code>
得到如下结果：</p><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-javascript data-lang=javascript><span
style=display:flex><span><span style=color:#ce5c00;font-weight:700>></span>
<span style=color:#000>curl</span> <span
style=color:#4e9a06>"http://localhost:8 [...]
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#000;font-weight:700>{</span><span
style=color:#4e9a06>"vertices"</span><span
style=color:#ce5c00;font-weight:700>:</span><span
style=color:#000;font-weight:700>[{</span><span
style=color:#4e9a06>"id"</span><span
style=color:#ce5c00;font-weight:700>:</span><span
style=color:#4e9a06>"2:lop"</span><span
style=color:#000;font-weight:700>,</span><span
style=color:#4e9a06>"label"</span><span style=c [...]
diff --git a/cn/docs/index.xml b/cn/docs/index.xml
index 69b47942..18151df7 100644
--- a/cn/docs/index.xml
+++ b/cn/docs/index.xml
@@ -2517,7 +2517,7 @@ HugeGraph 支持多用户并行操作，用户可输入 Gremlin 查询语句，
<p>使用<code>docker-compose</code></p>
<p>创建<code>docker-compose.yml</code>，具体文件如下，在环境变量中设置
PRELOAD=true。其中，<a
href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy";><code>example.groovy</code></a>
是一个预定义的脚本，用于预加载样例数据。如果有需要，可以通过挂载新的 <code>example.groovy</code>
脚本改变预加载的数据。</p>
<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-yaml" data-lang="yaml"><span
style="display:flex;"><span><span
style="color:#204a87;font-weight:bold">version</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#4e9a06">&#39;3&#39;</span><span
style="color:#f8f8f8;tex [...]
-</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">services</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#204a87;font-weight:bold">services</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">server</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">image</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">hugegraph/hugegraph:1.5.0</span><span
style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">container_name</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">server</span><span
style="color:#f8f8f8;text-decoration:underline">
diff --git a/cn/docs/quickstart/_print/index.html
b/cn/docs/quickstart/_print/index.html
index 718f0cf6..6a552a8f 100644
--- a/cn/docs/quickstart/_print/index.html
+++ b/cn/docs/quickstart/_print/index.html
@@ -201,16 +201,16 @@
</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>hugegraph-data</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span></code></pre></div><p>在这个 yaml 中，需要在环境变量中以
<code>hugegraph.<parameter_name></code>的形式进行参数传递，配置 Cassandra
相关的参数。</p><p>具体来说，在 <code>hugegraph.properties</code> 配置文件中，提供了
<code>backend=xxx</code>, <code>cassandra.host=xxx</code>
等配置项，为了配置这些配置项，在传递环境变量的过程之中，我们需要在这些配置项前加上 <code>hugegrpah.</code>，即
<code>hugegraph.backend</code> 和
<code>hugegraph.cassandra.host</code>。</p><p>其他配置可以参照 <a
href=#4-%E9%85%8D%E7%BD%AE>4 配置</a></p></details><h5
id=522-启动-server-的时候创建示例图>5.2. [...]
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>services</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>server</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>image</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>hugegraph/hugegraph:1.5.0</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>container_name</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>server</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>environment</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>PRELOAD=true</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>/path/to/yourscript:/hugegraph/scripts/example.groovy</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>ports</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>services</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>server</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>image</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>hugegraph/hugegraph:1.5.0</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>container_name</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>server</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>environment</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>PRELOAD=true</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>/path/to/yourscript:/hugegraph/scripts/example.groovy</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>ports</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span></code></pre></div><p>使用命令 <code>docker-compose up
-d</code> 启动容器</p></li></ol><p>使用 RESTful API 请求 <code>HugeGraphServer</code>
得到如下结果：</p><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-javascript data-lang=javascript><span
style=display:flex><span><span style=color:#ce5c00;font-weight:700>></span>
<span style=color:#000>curl</span> <span
style=color:#4e9a06>"http://localhost:8 [...]
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#000;font-weight:700>{</span><span
style=color:#4e9a06>"vertices"</span><span
style=color:#ce5c00;font-weight:700>:</span><span
style=color:#000;font-weight:700>[{</span><span
style=color:#4e9a06>"id"</span><span
style=color:#ce5c00;font-weight:700>:</span><span
style=color:#4e9a06>"2:lop"</span><span
style=color:#000;font-weight:700>,</span><span
style=color:#4e9a06>"label"</span><span style=c [...]
diff --git a/cn/docs/quickstart/hugegraph-server/index.html
b/cn/docs/quickstart/hugegraph-server/index.html
index 6c963aeb..ea6a9957 100644
--- a/cn/docs/quickstart/hugegraph-server/index.html
+++ b/cn/docs/quickstart/hugegraph-server/index.html
@@ -7,14 +7,14 @@ Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存
在往下阅读之前先执行 java -version 命令确认 jdk 版本
注：使用 Java 8 启动 HugeGraph-Server 会失去一些安全性的保障，也会降低性能相关指标
3 部署 有四种方式可以部署 HugeGraph-Server 组件：
-方式 1：使用 Docker 容器 (便于测试) 方式 2：下载 tar 包 方式 3：源码编译 方式 4：使用 tools 工具部署 (Outdated)
注意 生产或对外网暴露访问的环境必须使用 Java 11 并开启 Auth 权限认证, 否则会有安全隐患。"><meta property="og:type"
content="article"><meta property="og:url"
content="/cn/docs/quickstart/hugegraph-server/"><meta
property="article:section" content="docs"><meta
property="article:modified_time" content="2025-02-20T14:44:10+08:00"><meta
property="og:site_name" content="HugeGraph"><meta itemprop=name
content="HugeGraph-Server Quick Start"><meta itemp [...]
+方式 1：使用 Docker 容器 (便于测试) 方式 2：下载 tar 包 方式 3：源码编译 方式 4：使用 tools 工具部署 (Outdated)
注意 生产或对外网暴露访问的环境必须使用 Java 11 并开启 Auth 权限认证, 否则会有安全隐患。"><meta property="og:type"
content="article"><meta property="og:url"
content="/cn/docs/quickstart/hugegraph-server/"><meta
property="article:section" content="docs"><meta
property="article:modified_time" content="2025-06-04T21:36:29+08:00"><meta
property="og:site_name" content="HugeGraph"><meta itemprop=name
content="HugeGraph-Server Quick Start"><meta itemp [...]
Core 模块是 Tinkerpop 接口的实现，Backend
模块用于管理数据存储，目前支持的后端包括：Memory、Cassandra、ScyllaDB 以及 RocksDB，API 模块提供 HTTP
Server，将 Client 的 HTTP 请求转化为对 Core 的调用。
文档中会出现 HugeGraph-Server 及 HugeGraphServer 这两种写法，其他组件也类似。
这两种写法含义上并明显差异，可以这么区分：HugeGraph-Server 表示服务端相关组件代码，HugeGraphServer 表示服务进程。
2 依赖 2.1 安装 Java 11 (JDK 11) 请优先考虑在 Java 11 的环境上启动 HugeGraph-Server(在 1.5.0
版前，会保留对 Java 8 的基本兼容)
在往下阅读之前先执行 java -version 命令确认 jdk 版本
注：使用 Java 8 启动 HugeGraph-Server 会失去一些安全性的保障，也会降低性能相关指标
3 部署 有四种方式可以部署 HugeGraph-Server 组件：
-方式 1：使用 Docker 容器 (便于测试) 方式 2：下载 tar 包 方式 3：源码编译 方式 4：使用 tools 工具部署 (Outdated)
注意 生产或对外网暴露访问的环境必须使用 Java 11 并开启 Auth 权限认证, 否则会有安全隐患。"><meta
itemprop=dateModified content="2025-02-20T14:44:10+08:00"><meta
itemprop=wordCount content="1468"><meta itemprop=keywords content><meta
name=twitter:card content="summary"><meta name=twitter:title
content="HugeGraph-Server Quick Start"><meta name=twitter:description
content="1 HugeGraph-Server 概述 HugeGraph-Server 是 HugeGraph 项目的核心部分，包含
graph-core、bac [...]
+方式 1：使用 Docker 容器 (便于测试) 方式 2：下载 tar 包 方式 3：源码编译 方式 4：使用 tools 工具部署 (Outdated)
注意 生产或对外网暴露访问的环境必须使用 Java 11 并开启 Auth 权限认证, 否则会有安全隐患。"><meta
itemprop=dateModified content="2025-06-04T21:36:29+08:00"><meta
itemprop=wordCount content="1468"><meta itemprop=keywords content><meta
name=twitter:card content="summary"><meta name=twitter:title
content="HugeGraph-Server Quick Start"><meta name=twitter:description
content="1 HugeGraph-Server 概述 HugeGraph-Server 是 HugeGraph 项目的核心部分，包含
graph-core、bac [...]
Core 模块是 Tinkerpop 接口的实现，Backend
模块用于管理数据存储，目前支持的后端包括：Memory、Cassandra、ScyllaDB 以及 RocksDB，API 模块提供 HTTP
Server，将 Client 的 HTTP 请求转化为对 Core 的调用。
文档中会出现 HugeGraph-Server 及 HugeGraphServer 这两种写法，其他组件也类似。
这两种写法含义上并明显差异，可以这么区分：HugeGraph-Server 表示服务端相关组件代码，HugeGraphServer 表示服务进程。
2 依赖 2.1 安装 Java 11 (JDK 11) 请优先考虑在 Java 11 的环境上启动 HugeGraph-Server(在 1.5.0
版前，会保留对 Java 8 的基本兼容)
@@ -228,16 +228,16 @@ Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存
</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>hugegraph-data</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span></code></pre></div><p>在这个 yaml 中，需要在环境变量中以
<code>hugegraph.<parameter_name></code>的形式进行参数传递，配置 Cassandra
相关的参数。</p><p>具体来说，在 <code>hugegraph.properties</code> 配置文件中，提供了
<code>backend=xxx</code>, <code>cassandra.host=xxx</code>
等配置项，为了配置这些配置项，在传递环境变量的过程之中，我们需要在这些配置项前加上 <code>hugegrpah.</code>，即
<code>hugegraph.backend</code> 和
<code>hugegraph.cassandra.host</code>。</p><p>其他配置可以参照 <a
href=#4-%E9%85%8D%E7%BD%AE>4 配置</a></p></details><h5
id=522-启动-server-的时候创建示例图>5.2. [...]
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>services</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>server</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>image</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>hugegraph/hugegraph:1.5.0</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>container_name</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>server</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>environment</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>PRELOAD=true</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>/path/to/yourscript:/hugegraph/scripts/example.groovy</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>ports</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
-</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline></span><span
style=color:#204a87;font-weight:700>services</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>server</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>image</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>hugegraph/hugegraph:1.5.0</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>container_name</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#000>server</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>environment</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>PRELOAD=true</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>volumes</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#000>/path/to/yourscript:/hugegraph/scripts/example.groovy</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span><span
style=color:#204a87;font-weight:700>ports</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#f8f8f8;text-decoration:underline>
+</span></span></span><span style=display:flex><span><span
style=color:#f8f8f8;text-decoration:underline> </span>- <span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#000;font-weight:700>:</span><span
style=color:#0000cf;font-weight:700>8080</span><span
style=color:#f8f8f8;text-decoration:underline>
</span></span></span></code></pre></div><p>使用命令 <code>docker-compose up
-d</code> 启动容器</p></li></ol><p>使用 RESTful API 请求 <code>HugeGraphServer</code>
得到如下结果：</p><div class=highlight><pre tabindex=0
style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code
class=language-javascript data-lang=javascript><span
style=display:flex><span><span style=color:#ce5c00;font-weight:700>></span>
<span style=color:#000>curl</span> <span
style=color:#4e9a06>"http://localhost:8 [...]
</span></span><span style=display:flex><span>
</span></span><span style=display:flex><span><span
style=color:#000;font-weight:700>{</span><span
style=color:#4e9a06>"vertices"</span><span
style=color:#ce5c00;font-weight:700>:</span><span
style=color:#000;font-weight:700>[{</span><span
style=color:#4e9a06>"id"</span><span
style=color:#ce5c00;font-weight:700>:</span><span
style=color:#4e9a06>"2:lop"</span><span
style=color:#000;font-weight:700>,</span><span
style=color:#4e9a06>"label"</span><span style=c [...]
@@ -300,7 +300,7 @@ Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存
</span></span><span style=display:flex><span><span
style=color:#000;font-weight:700>}</span>
</span></span></code></pre></div><p id=swaggerui-example></p><p>详细的 API 请参考 <a
href=/docs/clients/restful-api>RESTful-API</a> 文档。</p><p>另外也可以通过访问
<code>localhost:8080/swagger-ui/index.html</code> 查看 API。</p><div
style=text-align:center><img src=/docs/images/images-server/swagger-ui.png
alt=image></div><p>在使用 Swagger UI 调试 HugeGraph 提供的 API 时，如果 HugeGraph Server
开启了鉴权模式，可以在 Swagger 页面输入鉴权信息。</p><div style=text-align:center><img
src=/docs/images/images-server/swagger-ui-where-set-auth-exam [...]
</span></span><span style=display:flex><span><span
style=color:#000>$bin</span>/stop-hugegraph.sh
-</span></span></code></pre></div><h3 id=8-使用-intellij-idea-调试-server>8 使用
IntelliJ IDEA 调试 Server</h3><p>请参考<a
href=/docs/contribution-guidelines/hugegraph-server-idea-setup>在 IDEA 中配置
Server 开发环境</a></p><div class="text-muted mt-5 pt-3 border-top">Last modified
February 20, 2025: <a
href=https://github.com/apache/incubator-hugegraph-doc/commit/67fe6f63683af84c14f6ad47c30324608d8d1bfd>doc:
add EN for vermeer(OLAP) & server auth (#396)
(67fe6f63)</a></div></div></main></div></div><footer [...]
+</span></span></code></pre></div><h3 id=8-使用-intellij-idea-调试-server>8 使用
IntelliJ IDEA 调试 Server</h3><p>请参考<a
href=/docs/contribution-guidelines/hugegraph-server-idea-setup>在 IDEA 中配置
Server 开发环境</a></p><div class="text-muted mt-5 pt-3 border-top">Last modified
June 4, 2025: <a
href=https://github.com/apache/incubator-hugegraph-doc/commit/8fb4563e2c8c8308e8d31aec85f52a4f5e99f509>fix:
hugegraph-server.md chapter 5.2.2 (#404)
(8fb4563e)</a></div></div></main></div></div><footer class="bg- [...]
<script src=/js/bootstrap.min.js></script>
<script src=/js/tabpane-persist.js></script>
<script
src=/js/main.min.aa9f4c5dae6a98b2c46277f4c56f1673a2b000d1756ce4ffae93784cab25e6d5.js
integrity="sha256-qp9MXa5qmLLEYnf0xW8Wc6KwANF1bOT/rpN4TKsl5tU="
crossorigin=anonymous></script>
diff --git a/cn/docs/quickstart/index.xml b/cn/docs/quickstart/index.xml
index c58bbc46..e27497f1 100644
--- a/cn/docs/quickstart/index.xml
+++ b/cn/docs/quickstart/index.xml
@@ -365,7 +365,7 @@
<p>使用<code>docker-compose</code></p>
<p>创建<code>docker-compose.yml</code>，具体文件如下，在环境变量中设置
PRELOAD=true。其中，<a
href="https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy";><code>example.groovy</code></a>
是一个预定义的脚本，用于预加载样例数据。如果有需要，可以通过挂载新的 <code>example.groovy</code>
脚本改变预加载的数据。</p>
<div class="highlight"><pre tabindex="0"
style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code
class="language-yaml" data-lang="yaml"><span
style="display:flex;"><span><span
style="color:#204a87;font-weight:bold">version</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#4e9a06">&#39;3&#39;</span><span
style="color:#f8f8f8;tex [...]
-</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">services</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline">
+</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"></span><span
style="color:#204a87;font-weight:bold">services</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">server</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">image</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">hugegraph/hugegraph:1.5.0</span><span
style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#204a87;font-weight:bold">container_name</span><span
style="color:#000;font-weight:bold">:</span><span
style="color:#f8f8f8;text-decoration:underline"> </span><span
style="color:#000">server</span><span
style="color:#f8f8f8;text-decoration:underline">
diff --git a/cn/sitemap.xml b/cn/sitemap.xml
index b40ec009..443a454d 100644
--- a/cn/sitemap.xml
+++ b/cn/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9";
xmlns:xhtml="http://www.w3.org/1999/xhtml";><url><loc>/cn/docs/language/hugegraph-gremlin/</loc><lastmod>2023-01-01T16:16:43+08:00</lastmod><xhtml:link
rel="alternate" hreflang="en"
href="/docs/language/hugegraph-gremlin/"/><xhtml:link rel="alternate"
hreflang="cn"
href="/cn/docs/language/hugegraph-gremlin/"/></url><url><loc>/cn/docs/performance/hugegraph-benchmark-0.5.6/</lo
[...]
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9";
xmlns:xhtml="http://www.w3.org/1999/xhtml";><url><loc>/cn/docs/language/hugegraph-gremlin/</loc><lastmod>2023-01-01T16:16:43+08:00</lastmod><xhtml:link
rel="alternate" hreflang="en"
href="/docs/language/hugegraph-gremlin/"/><xhtml:link rel="alternate"
hreflang="cn"
href="/cn/docs/language/hugegraph-gremlin/"/></url><url><loc>/cn/docs/performance/hugegraph-benchmark-0.5.6/</lo
[...]
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index 920d4a7b..b57a35d9 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9";><sitemap><loc>/en/sitemap.xml</loc><lastmod>2025-03-10T01:37:22-05:00</lastmod></sitemap><sitemap><loc>/cn/sitemap.xml</loc><lastmod>2025-02-20T14:44:10+08:00</lastmod></sitemap></sitemapindex>
\ No newline at end of file
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><sitemapindex
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9";><sitemap><loc>/en/sitemap.xml</loc><lastmod>2025-03-10T01:37:22-05:00</lastmod></sitemap><sitemap><loc>/cn/sitemap.xml</loc><lastmod>2025-06-04T21:36:29+08:00</lastmod></sitemap></sitemapindex>
\ No newline at end of file
