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 d2b63d93 doc: sync doc about enable auth for docker image (#324)
d2b63d93 is described below
commit d2b63d937d9f6f0d49d597081acc58ec3d4d6966
Author: Dandelion <[email protected]>
AuthorDate: Thu Feb 1 18:09:33 2024 +0800
doc: sync doc about enable auth for docker image (#324)
1. sync with [2403](https://github.com/apache/incubator-hugegraph/pull/2403)
2. change the order of the changelogs (there is a small problem in the
origin order), and make the weight larger so that we can set the weight for
version 1.5.0 to 10-1=9, where 10 is the weight for 1.2.0
3. Put the relevant parts of docker first
---------
Co-authored-by: imbajin <[email protected]>
---
content/cn/_index.html | 2 +-
content/cn/docs/changelog/_index.md | 2 +-
.../changelog/hugegraph-0.10.4-release-notes.md | 3 +-
.../changelog/hugegraph-0.11.2-release-notes.md | 3 +-
.../changelog/hugegraph-0.12.0-release-notes.md | 16 ++--
.../docs/changelog/hugegraph-0.2-release-notes.md | 3 +-
.../changelog/hugegraph-0.2.4-release-notes.md | 3 +-
.../changelog/hugegraph-0.3.3-release-notes.md | 3 +-
.../changelog/hugegraph-0.4.4-release-notes.md | 3 +-
.../changelog/hugegraph-0.5.6-release-notes.md | 3 +-
.../changelog/hugegraph-0.6.1-release-notes.md | 3 +-
.../changelog/hugegraph-0.7.4-release-notes.md | 3 +-
.../changelog/hugegraph-0.8.0-release-notes.md | 3 +-
.../changelog/hugegraph-0.9.2-release-notes.md | 3 +-
.../changelog/hugegraph-1.0.0-release-notes.md | 2 +-
.../changelog/hugegraph-1.2.0-release-notes.md | 2 +-
content/cn/docs/config/config-authentication.md | 50 ++++++++++-
content/cn/docs/config/config-computer.md | 2 +-
content/cn/docs/config/config-guide.md | 2 +-
content/cn/docs/config/config-https.md | 2 +-
content/cn/docs/config/config-option.md | 2 +-
content/cn/docs/guides/architectural.md | 2 +-
content/cn/docs/guides/backup-restore.md | 2 +-
content/cn/docs/guides/desgin-concept.md | 2 +-
.../docs/images/images-server/31docker-option.jpg | Bin 0 -> 202402 bytes
.../cn/docs/performance/api-preformance/_index.md | 2 +-
.../docs/performance/hugegraph-benchmark-0.5.6.md | 2 +-
.../performance/hugegraph-loader-performance.md | 2 +-
content/cn/docs/quickstart/hugegraph-client.md | 4 +-
content/cn/docs/quickstart/hugegraph-computer.md | 2 +-
content/cn/docs/quickstart/hugegraph-hubble.md | 77 ++++++++--------
content/cn/docs/quickstart/hugegraph-loader.md | 98 +++++++++++----------
content/cn/docs/quickstart/hugegraph-server.md | 93 ++++++++++---------
content/cn/docs/quickstart/hugegraph-tools.md | 2 +-
.../changelog/hugegraph-0.10.4-release-notes.md | 2 +-
.../changelog/hugegraph-0.11.2-release-notes.md | 2 +-
.../changelog/hugegraph-0.12.0-release-notes.md | 3 +-
.../docs/changelog/hugegraph-0.2-release-notes.md | 2 +-
.../changelog/hugegraph-0.2.4-release-notes.md | 2 +-
.../changelog/hugegraph-0.3.3-release-notes.md | 2 +-
.../changelog/hugegraph-0.4.4-release-notes.md | 2 +-
.../changelog/hugegraph-0.5.6-release-notes.md | 2 +-
.../changelog/hugegraph-0.6.1-release-notes.md | 2 +-
.../changelog/hugegraph-0.7.4-release-notes.md | 2 +-
.../changelog/hugegraph-0.8.0-release-notes.md | 2 +-
.../changelog/hugegraph-0.9.2-release-notes.md | 2 +-
.../changelog/hugegraph-1.0.0-release-notes.md | 2 +-
.../changelog/hugegraph-1.2.0-release-notes.md | 2 +-
content/en/docs/config/config-authentication.md | 51 ++++++++++-
.../docs/images/images-server/31docker-option.jpg | Bin 0 -> 202402 bytes
content/en/docs/quickstart/hugegraph-client.md | 2 +
content/en/docs/quickstart/hugegraph-hubble.md | 76 ++++++++--------
content/en/docs/quickstart/hugegraph-loader.md | 87 +++++++++---------
content/en/docs/quickstart/hugegraph-server.md | 88 +++++++++---------
54 files changed, 431 insertions(+), 305 deletions(-)
diff --git a/content/cn/_index.html b/content/cn/_index.html
index 8294f18c..80223b1e 100644
--- a/content/cn/_index.html
+++ b/content/cn/_index.html
@@ -54,7 +54,7 @@ linkTitle = "Huge Docs"
{{< blocks/section color="blue-deep">}}
<div class="col">
-<h1 class="text-center">Apache 的第一个图数据库项目</h1>
+<h1 class="text-center">第一个 Apache 图数据库项目</h1>
</div>
{{< /blocks/section >}}
diff --git a/content/cn/docs/changelog/_index.md
b/content/cn/docs/changelog/_index.md
index e00adbf8..41b3951b 100644
--- a/content/cn/docs/changelog/_index.md
+++ b/content/cn/docs/changelog/_index.md
@@ -1,5 +1,5 @@
---
title: "CHANGELOGS"
linkTitle: "CHANGELOGS"
-weight: 9
+weight: 10
---
\ No newline at end of file
diff --git a/content/cn/docs/changelog/hugegraph-0.10.4-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.10.4-release-notes.md
index 4339fd49..c8b48038 100644
--- a/content/cn/docs/changelog/hugegraph-0.10.4-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.10.4-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.10 Release Notes"
linkTitle: "Release-0.10.4"
-weight: 3
+draft: true
+weight: 14
---
### API & Client
diff --git a/content/cn/docs/changelog/hugegraph-0.11.2-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.11.2-release-notes.md
index 5afd11d1..7b082a33 100644
--- a/content/cn/docs/changelog/hugegraph-0.11.2-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.11.2-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.11 Release Notes"
linkTitle: "Release-0.11.2"
-weight: 2
+draft: true
+weight: 13
---
### API & Client
diff --git a/content/cn/docs/changelog/hugegraph-0.12.0-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.12.0-release-notes.md
index f88ee3d7..e12de46e 100644
--- a/content/cn/docs/changelog/hugegraph-0.12.0-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.12.0-release-notes.md
@@ -1,14 +1,14 @@
---
title: "HugeGraph 0.12 Release Notes"
linkTitle: "Release-0.12.0"
-weight: 2
+weight: 12
---
### API & Client
#### 接口更新
-- 支持 https + auth 模式连接图服务 （hugegraph-client #109 #110）
+- 支持 https + auth 模式连接图服务（hugegraph-client #109 #110）
- 统一 kout/kneighbor 等 OLTP 接口的参数命名及默认值（hugegraph-client #122 #123）
- 支持 RESTful 接口利用 P.textcontains() 进行属性全文检索（hugegraph #1312）
- 增加 graph_read_mode API 接口，以切换 OLTP、OLAP 读模式（hugegraph #1332）
@@ -21,7 +21,7 @@ weight: 2
- 增加 OLAP 回写接口，支持 cassandra/rocksdb 后端（hugegraph #1506、hugegraph-client #129）
- 增加返回一个图的所有 Schema 的 API 接口（hugegraph #1567、hugegraph-client #134）
- 变更 property key 创建与更新 API 的 HTTP 返回码为 202（hugegraph #1584）
-- 增强 Text.contains() 支持3种格式："word"、"(word)"、"(word1|word2|word3)"（hugegraph
#1652）
+- 增强 Text.contains() 支持 3 种格式："word"、"(word)"、"(word1|word2|word3)"（hugegraph
#1652）
- 统一了属性中特殊字符的行为（hugegraph #1670 #1684）
- 支持动态创建图实例、克隆图实例、删除图实例（hugegraph-client #135）
@@ -44,9 +44,9 @@ weight: 2
- 支持审计日志，及其压缩、限速等功能（hugegraph #1492 #1493）
- 支持 OLTP 算法使用高性能并行无锁原生集合以提升性能（hugegraph #1552）
-#### BUG修复
+#### BUG 修复
-- 修复带权最短路径算法（weighted shortest path）NPE问题 （hugegraph #1250）
+- 修复带权最短路径算法（weighted shortest path）NPE 问题（hugegraph #1250）
- 增加 Raft 相关的安全操作白名单（hugegraph #1257）
- 修复 RocksDB 实例未正确关闭的问题（hugegraph #1264）
- 在清空数据 truncate 操作之后，显示的发起写快照 Raft Snapshot（hugegraph #1275）
@@ -114,7 +114,7 @@ weight: 2
- 修复 has() + within() 查询时结果异常问题（hugegraph #1680）
- 升级 Log4j 版本到 2.17 以修复安全漏洞（hugegraph #1686 #1698 #1702）
- 修复 HBase 后端 shard scan 中 startkey 包含空串时 NPE 问题（hugegraph #1691）
-- 修复 paths 算法在深层环路遍历时性能下降问题 （hugegraph #1694）
+- 修复 paths 算法在深层环路遍历时性能下降问题（hugegraph #1694）
- 改进 personalrank 算法的参数默认值及错误检查（hugegraph #1695）
- 修复 RESTful 接口 P.within 条件不生效问题（hugegraph #1704）
- 修复启用权限时无法动态创建图的问题（hugegraph #1708）
@@ -200,12 +200,12 @@ weight: 2
### Tools
- 支持 HTTPS 协议（hugegraph-tools #71）
-- 移除 --protocol 参数，直接从URL中自动提取（hugegraph-tools #72）
+- 移除 --protocol 参数，直接从 URL 中自动提取（hugegraph-tools #72）
- 支持将数据 dump 到 HDFS 文件系统（hugegraph-tools #73）
- 修复 trust store file 路径问题（hugegraph-tools #75）
- 支持权限信息的备份恢复（hugegraph-tools #76）
- 支持无参数的 Printer 打印（hugegraph-tools #79）
- 修复 MacOS free_memory 计算问题（hugegraph-tools #82）
-- 支持备份恢复时指定线程数hugegraph-tools #83）
+- 支持备份恢复时指定线程数 hugegraph-tools #83）
- 支持动态创建图、克隆图、删除图等命令（hugegraph-tools #95)
diff --git a/content/cn/docs/changelog/hugegraph-0.2-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.2-release-notes.md
index 2795c5a2..4c974aad 100644
--- a/content/cn/docs/changelog/hugegraph-0.2-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.2-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.2 Release Notes"
linkTitle: "Release-0.2.4"
-weight: 11
+draft: true
+weight: 23
---
### API & Java Client
diff --git a/content/cn/docs/changelog/hugegraph-0.2.4-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.2.4-release-notes.md
index 7f058072..e826bc01 100644
--- a/content/cn/docs/changelog/hugegraph-0.2.4-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.2.4-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.2.4 Release Notes"
linkTitle: "Release-0.2.4"
-weight: 12
+draft: true
+weight: 22
---
### API & Java Client
diff --git a/content/cn/docs/changelog/hugegraph-0.3.3-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.3.3-release-notes.md
index e21cea39..b114d1e2 100644
--- a/content/cn/docs/changelog/hugegraph-0.3.3-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.3.3-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.3.3 Release Notes"
linkTitle: "Release-0.3.3"
-weight: 10
+draft: true
+weight: 21
---
### API & Java Client
diff --git a/content/cn/docs/changelog/hugegraph-0.4.4-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.4.4-release-notes.md
index 23b381e2..93c12089 100644
--- a/content/cn/docs/changelog/hugegraph-0.4.4-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.4.4-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.4.4 Release Notes"
linkTitle: "Release-0.4.4"
-weight: 9
+draft: true
+weight: 20
---
### API & Java Client
diff --git a/content/cn/docs/changelog/hugegraph-0.5.6-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.5.6-release-notes.md
index e45dfac8..0353b6c9 100644
--- a/content/cn/docs/changelog/hugegraph-0.5.6-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.5.6-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.5 Release Notes"
linkTitle: "Release-0.5.6"
-weight: 8
+draft: true
+weight: 19
---
### API & Java Client
diff --git a/content/cn/docs/changelog/hugegraph-0.6.1-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.6.1-release-notes.md
index 903a4723..57dae14f 100644
--- a/content/cn/docs/changelog/hugegraph-0.6.1-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.6.1-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.6 Release Notes"
linkTitle: "Release-0.6.1"
-weight: 7
+draft: true
+weight: 18
---
### API & Java Client
diff --git a/content/cn/docs/changelog/hugegraph-0.7.4-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.7.4-release-notes.md
index fed41a4a..11586475 100644
--- a/content/cn/docs/changelog/hugegraph-0.7.4-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.7.4-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.7 Release Notes"
linkTitle: "Release-0.7.4"
-weight: 6
+draft: true
+weight: 17
---
### API & Java Client
diff --git a/content/cn/docs/changelog/hugegraph-0.8.0-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.8.0-release-notes.md
index a1fdfbfa..ad50701f 100644
--- a/content/cn/docs/changelog/hugegraph-0.8.0-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.8.0-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.8 Release Notes"
linkTitle: "Release-0.8.0"
-weight: 5
+draft: true
+weight: 16
---
### API & Client
diff --git a/content/cn/docs/changelog/hugegraph-0.9.2-release-notes.md
b/content/cn/docs/changelog/hugegraph-0.9.2-release-notes.md
index b8213596..d6cdfa4d 100644
--- a/content/cn/docs/changelog/hugegraph-0.9.2-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-0.9.2-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.9 Release Notes"
linkTitle: "Release-0.9.2"
-weight: 4
+draft: true
+weight: 15
---
### API & Client
diff --git a/content/cn/docs/changelog/hugegraph-1.0.0-release-notes.md
b/content/cn/docs/changelog/hugegraph-1.0.0-release-notes.md
index f9fd16b3..5ddce660 100644
--- a/content/cn/docs/changelog/hugegraph-1.0.0-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-1.0.0-release-notes.md
@@ -1,7 +1,7 @@
---
title: "HugeGraph 1.0.0 Release Notes"
linkTitle: "Release-1.0.0"
-weight: 1
+weight: 11
---
### OLTP API & Client 更新
diff --git a/content/cn/docs/changelog/hugegraph-1.2.0-release-notes.md
b/content/cn/docs/changelog/hugegraph-1.2.0-release-notes.md
index 02eb2e5a..ea0c2d35 100644
--- a/content/cn/docs/changelog/hugegraph-1.2.0-release-notes.md
+++ b/content/cn/docs/changelog/hugegraph-1.2.0-release-notes.md
@@ -1,7 +1,7 @@
---
title: "HugeGraph 1.2.0 Release Notes"
linkTitle: "Release-1.2.0"
-weight: 1
+weight: 10
---
### Java version statement
diff --git a/content/cn/docs/config/config-authentication.md
b/content/cn/docs/config/config-authentication.md
index 65516a24..a76de93f 100644
--- a/content/cn/docs/config/config-authentication.md
+++ b/content/cn/docs/config/config-authentication.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph 内置用户权限与扩展权限配置及使用"
-linkTitle: "Config Authentication"
+linkTitle: "权限配置"
weight: 3
---
@@ -73,13 +73,15 @@ gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
在鉴权配置完成后，需在首次执行 `init-store.sh` 时命令行中输入 `admin` 密码 (非 docker 部署模式下)
-如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式，需要删除相关图数据并重新启动
HugeGraph，若图已有业务数据，暂时**无法直接转换**鉴权模式 (对于该功能的改进将在下个版本发布，修改方式可参考 [PR
2411](https://github.com/apache/incubator-hugegraph/pull/2411))。
+如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式，需要删除相关图数据并重新启动 HugeGraph,
若图已有业务数据，暂时**无法直接转换**鉴权模式 (hugegraph 版本 <= 1.2.0)
+> 对于该功能的改进已经在最新版本发布 (Docker latest 可用)，可参考 [PR
2411](https://github.com/apache/incubator-hugegraph/pull/2411), 此时可无缝切换。
```bash
# stop the hugeGraph firstly
bin/stop-hugegraph.sh
# delete the store data (here we use the default path for rocksdb)
+# Note: no need to delete data in the latest code (fixed in
https://github.com/apache/incubator-hugegraph/pull/2411)
rm -rf rocksdb-data/
# init store again
@@ -88,4 +90,46 @@ bin/init-store.sh
# start hugeGraph again
bin/start-hugegraph.sh
-```
\ No newline at end of file
+```
+
+### 使用 Docker 时开启鉴权模式
+
+对于镜像 `hugegraph/hugegraph` 大于等于 `1.2.0` 的版本，我们可以在启动 `docker` 镜像的同时开启鉴权模式
+
+具体做法如下：
+
+#### 1. 采用 docker run
+
+在 `docker run` 中添加环境变量 `PASSWORD=123456`（密码可以自由设置）即可开启鉴权模式：：
+
+```bash
+docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080
hugegraph/hugegraph:1.2.0
+```
+
+#### 2. 采用 docker-compose
+
+使用 `docker-compose` 在环境变量中设置 `PASSWORD=123456`即可
+
+```yaml
+version: '3'
+services:
+ server:
+ image: hugegraph/hugegraph:1.2.0
+ container_name: server
+ ports:
+ - 8080:8080
+ environment:
+ - PASSWORD=123456
+```
+
+#### 3. 进入容器后重新开启鉴权模式
+
+首先进入容器：
+
+```bash
+docker exec -it server bash
+# 用于快速修改配置, 修改前的文件被保存在conf-bak文件夹下
+bin/enable-auth.sh
+```
+
+之后参照 [基于鉴权模式启动](#基于鉴权模式启动) 即可
diff --git a/content/cn/docs/config/config-computer.md
b/content/cn/docs/config/config-computer.md
index 4ba628d5..0b270c9e 100644
--- a/content/cn/docs/config/config-computer.md
+++ b/content/cn/docs/config/config-computer.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Computer 配置"
-linkTitle: "Config Computer"
+linkTitle: "图计算 Computer 配置"
weight: 5
---
diff --git a/content/cn/docs/config/config-guide.md
b/content/cn/docs/config/config-guide.md
index 63b3c6ce..9febc796 100644
--- a/content/cn/docs/config/config-guide.md
+++ b/content/cn/docs/config/config-guide.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph 配置"
-linkTitle: "Config Guide"
+linkTitle: "参数配置"
weight: 1
---
diff --git a/content/cn/docs/config/config-https.md
b/content/cn/docs/config/config-https.md
index f1cf1fc1..5aa128ba 100644
--- a/content/cn/docs/config/config-https.md
+++ b/content/cn/docs/config/config-https.md
@@ -1,6 +1,6 @@
---
title: "配置 HugeGraphServer 使用 https 协议"
-linkTitle: "Config Https"
+linkTitle: "配置 HTTPS"
weight: 4
---
diff --git a/content/cn/docs/config/config-option.md
b/content/cn/docs/config/config-option.md
index 6481a6bb..a18be14b 100644
--- a/content/cn/docs/config/config-option.md
+++ b/content/cn/docs/config/config-option.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph 配置项"
-linkTitle: "Config Options"
+linkTitle: "配置项列表"
weight: 2
---
diff --git a/content/cn/docs/guides/architectural.md
b/content/cn/docs/guides/architectural.md
index c9c23dba..09ed9569 100644
--- a/content/cn/docs/guides/architectural.md
+++ b/content/cn/docs/guides/architectural.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph Architecture Overview"
-linkTitle: "Architecture Overview"
+linkTitle: "架构概览"
weight: 1
---
diff --git a/content/cn/docs/guides/backup-restore.md
b/content/cn/docs/guides/backup-restore.md
index 0b4e8ac9..540c637f 100644
--- a/content/cn/docs/guides/backup-restore.md
+++ b/content/cn/docs/guides/backup-restore.md
@@ -1,6 +1,6 @@
---
title: "Backup Restore"
-linkTitle: "Backup Restore"
+linkTitle: "备份 & 恢复"
weight: 4
---
diff --git a/content/cn/docs/guides/desgin-concept.md
b/content/cn/docs/guides/desgin-concept.md
index 8e56ba1d..3a678f09 100644
--- a/content/cn/docs/guides/desgin-concept.md
+++ b/content/cn/docs/guides/desgin-concept.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph Design Concepts"
-linkTitle: "Design Concepts"
+linkTitle: "设计理念(legacy)"
weight: 2
---
diff --git a/content/cn/docs/images/images-server/31docker-option.jpg
b/content/cn/docs/images/images-server/31docker-option.jpg
new file mode 100644
index 00000000..67db0fcc
Binary files /dev/null and
b/content/cn/docs/images/images-server/31docker-option.jpg differ
diff --git a/content/cn/docs/performance/api-preformance/_index.md
b/content/cn/docs/performance/api-preformance/_index.md
index 3935893c..94c00c1b 100644
--- a/content/cn/docs/performance/api-preformance/_index.md
+++ b/content/cn/docs/performance/api-preformance/_index.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-API Performance"
-linkTitle: "HugeGraph-API Performance"
+linkTitle: "HugeGraph-API 性能"
weight: 2
---
diff --git a/content/cn/docs/performance/hugegraph-benchmark-0.5.6.md
b/content/cn/docs/performance/hugegraph-benchmark-0.5.6.md
index bb3db47c..b096c49f 100644
--- a/content/cn/docs/performance/hugegraph-benchmark-0.5.6.md
+++ b/content/cn/docs/performance/hugegraph-benchmark-0.5.6.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph BenchMark Performance"
-linkTitle: "HugeGraph BenchMark Performance"
+linkTitle: "HugeGraph 基准测试"
weight: 1
---
diff --git a/content/cn/docs/performance/hugegraph-loader-performance.md
b/content/cn/docs/performance/hugegraph-loader-performance.md
index ef397f22..ef755d50 100644
--- a/content/cn/docs/performance/hugegraph-loader-performance.md
+++ b/content/cn/docs/performance/hugegraph-loader-performance.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Loader Performance"
-linkTitle: "HugeGraph-Loader Performance"
+linkTitle: "HugeGraph-Loader 性能"
weight: 3
---
diff --git a/content/cn/docs/quickstart/hugegraph-client.md
b/content/cn/docs/quickstart/hugegraph-client.md
index d51db5fe..230df999 100644
--- a/content/cn/docs/quickstart/hugegraph-client.md
+++ b/content/cn/docs/quickstart/hugegraph-client.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Client Quick Start"
-linkTitle: "Develop with HugeGraph-Client"
+linkTitle: "使用 HugeGraph-Client 开发"
weight: 4
---
@@ -8,6 +8,8 @@ weight: 4
HugeGraph-Client 向 HugeGraph-Server 发出 HTTP 请求，获取并解析 Server 的执行结果。目前仅提供了 Java
版，用户可以使用 HugeGraph-Client 编写 Java 代码操作 HugeGraph，比如元数据和图数据的增删改查，或者执行 gremlin 语句。
+> 现在已经支持[基于 Go 语言的 HugeGraph Client SDK
工具](https://github.com/apache/incubator-hugegraph-toolchain/blob/master/hugegraph-client-go/README.md)
(version >=1.2.0)
+
### 2 环境要求
- java 11 (兼容 java 8)
diff --git a/content/cn/docs/quickstart/hugegraph-computer.md
b/content/cn/docs/quickstart/hugegraph-computer.md
index d3232bc1..305b3217 100644
--- a/content/cn/docs/quickstart/hugegraph-computer.md
+++ b/content/cn/docs/quickstart/hugegraph-computer.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Computer Quick Start"
-linkTitle: "Analysis with HugeGraph-Computer"
+linkTitle: "使用 Computer 进行 OLAP 分析"
weight: 6
---
diff --git a/content/cn/docs/quickstart/hugegraph-hubble.md
b/content/cn/docs/quickstart/hugegraph-hubble.md
index be518913..2143083f 100644
--- a/content/cn/docs/quickstart/hugegraph-hubble.md
+++ b/content/cn/docs/quickstart/hugegraph-hubble.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Hubble Quick Start"
-linkTitle: "Visual with HugeGraph-Hubble"
+linkTitle: "使用 Hubble 实现图可视化"
weight: 3
---
@@ -36,16 +36,50 @@ HugeGraph 是一款面向分析型，支持批量操作的图数据库系统，
有三种方式可以部署`hugegraph-hubble`
+- 使用 docker (便于**测试**)
- 下载 toolchain 二进制包
- 源码编译
-- 使用 docker (便于**测试**)
-#### 2.1 下载 toolchain 二进制包
+#### 2.1 使用 Docker (便于**测试**)
+
+> **特别注意**: docker 模式下，若 hubble 和 server 在同一宿主机，hubble 页面中设置 server 的
`hostname` **不能设置**为 `localhost/127.0.0.1`，因这会指向 hubble **容器内部**而非宿主机，导致无法连接到
server.
+>
+> 若 hubble 和 server 在同一 docker 网络下，**推荐**直接使用`container_name` (如下例的 `server`)
作为主机名。或者也可以使用 **宿主机 IP** 作为主机名，此时端口号为宿主机给 server 配置的端口
+
+我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动
[hubble](https://hub.docker.com/r/hugegraph/hubble).
+
+或者使用 docker-compose 启动 hubble，另外如果 hubble 和 server 在同一个 docker 网络下，可以使用 server
的 contain_name 进行访问，而不需要宿主机的 ip
+
+使用`docker-compose up -d`，`docker-compose.yml`如下：
+
+```yaml
+version: '3'
+services:
+ server:
+ image: hugegraph/hugegraph
+ container_name: server
+ ports:
+ - 8080:8080
+
+ hubble:
+ image: hugegraph/hubble
+ container_name: hubble
+ ports:
+ - 8088:8088
+```
+
+> 注意：
+>
+> 1. `hugegraph-hubble` 的 docker 镜像是一个便捷发布版本，用于快速测试试用
hubble，并非**ASF官方发布物料包的方式**。你可以从 [ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
+>
+> 2. **生产环境**推荐使用 `release tag`(如 `1.2.0`) 稳定版。使用 `latest` tag 默认对应 master
最新代码。
+
+#### 2.2 下载 toolchain 二进制包
`hubble`项目在`toolchain`项目中，首先下载`toolchain`的 tar 包
```bash
-wget
https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-{version}.tar.gz
+wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}.tar.gz
tar -xvf apache-hugegraph-toolchain-incubating-{version}.tar.gz
cd
apache-hugegraph-toolchain-incubating-{version}.tar.gz/apache-hugegraph-hubble-incubating-{version}
```
@@ -69,7 +103,7 @@ starting HugeGraphHubble ..............timed out with http
status 502
然后使用浏览器访问 `ip:8088` 可看到`hubble`页面，通过`bin/stop-hubble.sh`则可以停止服务
-#### 2.2 源码编译
+#### 2.3 源码编译
**注意：** 编译 hubble 需要用户本地环境有安装 `Nodejs V16.x` 与 `yarn` 环境
@@ -115,39 +149,6 @@ cd apache-hugegraph-hubble-incubating*
bin/start-hubble.sh -d
```
-#### 2.3 使用 Docker (便于**测试**)
-
-> **特别注意**: docker 模式下，若 hubble 和 server 在同一宿主机，hubble 页面中设置 graph 的
`hostname` **不能设置**为 `localhost/127.0.0.1`，因这会指向 hubble **容器内部**而非宿主机，导致无法连接到
server.
->
-> 若 hubble 和 server 在同一 docker 网络下，**推荐**直接使用`container_name` (如下例的 `graph`)
作为主机名。或者也可以使用 **宿主机 IP** 作为主机名，此时端口号为宿主机给 server 配置的端口
-
-我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动
[hubble](https://hub.docker.com/r/hugegraph/hubble).
-
-或者使用 docker-compose 启动 hubble，另外如果 hubble 和 graph 在同一个 docker 网络下，可以使用 graph 的
contain_name 进行访问，而不需要宿主机的 ip
-
-使用`docker-compose up -d`，`docker-compose.yml`如下：
-
-```yaml
-version: '3'
-services:
- server:
- image: hugegraph/hugegraph
- container_name: graph
- ports:
- - 8080:8080
-
- hubble:
- image: hugegraph/hubble
- container_name: hubble
- ports:
- - 8088:8088
-```
-
-> 注意：
->
-> 1. hugegraph-hubble 的 docker 镜像是一个便捷版本，用于快速启动 hubble，并不是**官方发布物料包方式**。你可以从
[ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
->
-> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
### 3 平台使用流程
diff --git a/content/cn/docs/quickstart/hugegraph-loader.md
b/content/cn/docs/quickstart/hugegraph-loader.md
index d4c36b2a..ed533d44 100644
--- a/content/cn/docs/quickstart/hugegraph-loader.md
+++ b/content/cn/docs/quickstart/hugegraph-loader.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Loader Quick Start"
-linkTitle: "Load data with HugeGraph-Loader"
+linkTitle: "使用 Loader/Spark 实时导入数据"
weight: 2
---
@@ -24,49 +24,12 @@ HugeGraph-Loader 是 HugeGraph 的数据导入组件，能够将多种数据源
有两种方式可以获取 HugeGraph-Loader：
+- 使用 Docker 镜像 (便于**测试**)
- 下载已编译的压缩包
- 克隆源码编译安装
-- 使用 Docker 镜像 (便于**测试**)
-
-#### 2.1 下载已编译的压缩包
-
-下载最新版本的 HugeGraph-Toolchain Release 包，里面包含了 loader + tool + hubble
全套工具，如果你已经下载，可跳过重复步骤
-
-```bash
-wget
https://downloads.apache.org/incubator/hugegraph/{version}//apache-hugegraph-toolchain-incubating-{version}.tar.gz
-tar zxf *hugegraph*.tar.gz
-```
-
-#### 2.2 克隆源码编译安装
-克隆最新版本的 HugeGraph-Loader 源码包：
-
-```bash
-# 1. get from github
-git clone https://github.com/apache/hugegraph-toolchain.git
-# 2. get from direct (e.g. here is 1.0.0, please choose the latest version)
-wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}-src.tar.gz
-```
-
-由于 Oracle ojdbc license 的限制，需要手动安装 ojdbc 到本地 maven 仓库。
-访问[Oracle jdbc
下载](https://www.oracle.com/database/technologies/appdev/jdbc-drivers-archive.html)
页面。选择 Oracle Database 12c Release 2 (12.2.0.1) drivers，如下图所示。
-
-打开链接后，选择“ojdbc8.jar”
-
-把 ojdbc8 安装到本地 maven 仓库，进入`ojdbc8.jar`所在目录，执行以下命令。
-```
-mvn install:install-file -Dfile=./ojdbc8.jar -DgroupId=com.oracle
-DartifactId=ojdbc8 -Dversion=12.2.0.1 -Dpackaging=jar
-```
-
-编译生成 tar 包：
-
-```bash
-cd hugegraph-loader
-mvn clean package -DskipTests
-```
-
-#### 2.3 使用 Docker 镜像 (便于**测试**)
+#### 2.1 使用 Docker 镜像 (便于**测试**)
我们可以使用 `docker run -itd --name loader hugegraph/loader`部署 loader
服务。对于需要加载的数据，则可以通过挂载 `-v /path/to/data/file:/loader/file` 或者`docker
cp`的方式将文件复制到 loader 容器内部。
@@ -78,7 +41,7 @@ version: '3'
services:
server:
image: hugegraph/hugegraph
- container_name: graph
+ container_name: server
ports:
- 8080:8080
@@ -103,7 +66,50 @@ services:
>
> 1. hugegraph-loader 的 docker 镜像是一个便捷版本，用于快速启动 loader，并不是**官方发布物料包方式**。你可以从
> [ASF Release Distribution
> Policy](https://infra.apache.org/release-distribution.html#dockerhub)
> 中得到更多细节。
>
-> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
+> 2. 推荐使用 `release tag`(如 `1.2.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
+
+#### 2.2 下载已编译的压缩包
+
+下载最新版本的 `HugeGraph-Toolchain` Release 包，里面包含了 `loader + tool + hubble`
全套工具，如果你已经下载，可跳过重复步骤
+
+```bash
+wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}.tar.gz
+tar zxf *hugegraph*.tar.gz
+```
+
+#### 2.3 克隆源码编译安装
+
+克隆最新版本的 HugeGraph-Loader 源码包：
+
+```bash
+# 1. get from github
+git clone https://github.com/apache/hugegraph-toolchain.git
+
+# 2. get from direct url (please choose the **latest release** version)
+wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}-src.tar.gz
+```
+
+<details>
+<summary>点击展开/折叠 手动安装 ojdbc 方法</summary>
+
+由于 Oracle ojdbc license 的限制，需要手动安装 ojdbc 到本地 maven 仓库。
+访问 [Oracle jdbc
下载](https://www.oracle.com/database/technologies/appdev/jdbc-drivers-archive.html)
页面。选择 Oracle Database 12c Release 2 (12.2.0.1) drivers，如下图所示。
+
+打开链接后，选择“ojdbc8.jar”
+
+把 ojdbc8 安装到本地 maven 仓库，进入`ojdbc8.jar`所在目录，执行以下命令。
+```
+mvn install:install-file -Dfile=./ojdbc8.jar -DgroupId=com.oracle
-DartifactId=ojdbc8 -Dversion=12.2.0.1 -Dpackaging=jar
+```
+
+</details>
+
+编译生成 tar 包：
+
+```bash
+cd hugegraph-loader
+mvn clean package -DskipTests
+```
### 3 使用流程
@@ -1064,17 +1070,17 @@ edge_created.json edge_knows.json schema.groovy
struct.json vertex_person.cs
其他的参数可以参照 [3.4.1 参数说明](#341-参数说明)
```bash
-docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
example/file/struct.json -s example/file/schema.groovy -h graph -p 8080
+docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
example/file/struct.json -s example/file/schema.groovy -h server -p 8080
```
如果导入用户自定义的数据集，按照刚才的例子，则使用：
```bash
-docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
/loader/dataset/struct.json -s /loader/dataset/schema.groovy -h graph -p 8080
+docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
/loader/dataset/struct.json -s /loader/dataset/schema.groovy -h server -p 8080
```
-> 如果 `loader` 和 `server`位于同一 docker 网络，则可以指定 `-h {server_container_name}`,
否则需要指定 `server`的宿主机的 ip (在我们的例子中， `server_container_name` 为 `graph`).
+> 如果 `loader` 和 `server`位于同一 docker 网络，则可以指定 `-h {server_container_name}`,
否则需要指定 `server`的宿主机的 ip (在我们的例子中， `server_container_name` 为 `server`).
然后我们可以观察到结果：
@@ -1120,7 +1126,7 @@ meter metrics
使用 `docker exec -it loader bash`进入容器内部，并执行命令
```bash
-sh bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s
example/file/schema.groovy -h graph -p 8080
+sh bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s
example/file/schema.groovy -h server -p 8080
```
执行的结果如 [4.5.1](#451-使用-docker-exec-直接导入数据) 所示
diff --git a/content/cn/docs/quickstart/hugegraph-server.md
b/content/cn/docs/quickstart/hugegraph-server.md
index 79f2c25b..195134c9 100644
--- a/content/cn/docs/quickstart/hugegraph-server.md
+++ b/content/cn/docs/quickstart/hugegraph-server.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Server Quick Start"
-linkTitle: "Install/Build HugeGraph-Server"
+linkTitle: "安装/构建 HugeGraph-Server"
weight: 1
---
@@ -28,13 +28,52 @@ java -version
有四种方式可以部署 HugeGraph-Server 组件：
-- 方式 1：下载 tar 包
-- 方式 2：源码编译
-- 方式 3：使用 Docker 容器 (便于**测试**)
+- 方式 1：使用 Docker 容器 (便于**测试**)
+- 方式 2：下载 tar 包
+- 方式 3：源码编译
- 方式 4：使用 tools 工具部署 (Outdated)
+#### 3.1 使用 Docker 容器 (便于**测试**)
+<!-- 3.1 is linked by other place. if change 3.1's title, please check -->
+
+可参考 [Docker
部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/README.md)。
+
+我们可以使用 `docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph`
去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`.
+
+可选项：
+
+1. 可以使用 `docker exec -it server bash` 进入容器完成一些操作
+2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true"
hugegraph/hugegraph` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考
[5.1.1](/cn/docs/quickstart/hugegraph-server/#511-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE)
+3. 可以使用 `-e PASSWORD=123456` 设置是否开启鉴权模式以及 admin 的密码，具体步骤可以参考 [Config
Authentication](/cn/docs/config/config-authentication#使用-docker-时开启鉴权模式)
-#### 3.1 下载 tar 包
+如果使用 docker desktop，则可以按照如下的方式设置可选项：
+<div style="text-align: center;">
+ <img src="/docs/images/images-server/31docker-option.jpg" alt="image"
style="width:33%;">
+</div>
+
+
+另外，如果我们希望能够在一个文件中管理除了 `server` 之外的其他 Hugegraph 相关的实例，我们也可以使用
`docker-compose`完成部署，使用命令 `docker-compose up -d`，（当然只配置 `server` 也是可以的）以下是一个样例的
`docker-compose.yml`:
+
+```yaml
+version: '3'
+services:
+ server:
+ image: hugegraph/hugegraph
+ container_name: server
+ # environment:
+ # - PRELOAD=true 为可选参数，为 True 时可以在启动的时候预加载一个内置的样例图
+ # - PASSWORD=123456 为可选参数，设置的时候可以开启鉴权模式，并设置密码
+ ports:
+ - 8080:8080
+```
+
+> 注意：
+>
+> 1. hugegraph 的 docker 镜像是一个便捷版本，用于快速启动 hugegraph，并不是**官方发布物料包方式**。你可以从 [ASF
Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
+>
+> 2. 推荐使用 `release tag`(如 `1.2.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
+
+#### 3.2 下载 tar 包
```bash
# use the latest version, here is 1.2.0 for example
@@ -42,7 +81,7 @@ wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph
tar zxf *hugegraph*.tar.gz
```
-#### 3.2 源码编译
+#### 3.3 源码编译
源码编译前请确保安装了 wget 命令
@@ -86,38 +125,6 @@ mvn package -DskipTests
执行成功后，在 hugegraph 目录下生成 `*hugegraph-*.tar.gz` 文件，就是编译生成的 tar 包。
-#### 3.3 使用 Docker 容器 (便于**测试**)
-<!-- 3.1 is linked by other place. if change 3.1's title, please check -->
-
-可参考 [Docker
部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/README.md)。
-
-我们可以使用 `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph`
去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`.
-
-可选项：
-
-1. 可以使用 `docker exec -it graph bash` 进入容器完成一些操作
-2. 可以使用 `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true"
hugegraph/hugegraph` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考
[5.1.1](/cn/docs/quickstart/hugegraph-server/#511-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE)
-
-另外，如果我们希望能够在一个文件中管理除了 `server` 之外的其他 Hugegraph 相关的实例，我们也可以使用
`docker-compose`完成部署，使用命令 `docker-compose up -d`，（当然只配置 `server` 也是可以的）以下是一个样例的
`docker-compose.yml`:
-
-```yaml
-version: '3'
-services:
- graph:
- image: hugegraph/hugegraph
- # environment:
- # - PRELOAD=true
- # PRELOAD 为可选参数，为 True 时可以在启动的时候预加载一个内置的样例图
- ports:
- - 8080:8080
-```
-
-> 注意：
->
-> 1. hugegraph 的 docker 镜像是一个便捷版本，用于快速启动 hugegraph，并不是**官方发布物料包方式**。你可以从 [ASF
Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
->
-> 2. 推荐使用 `release tag`(如 `1.2.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
-
#### 3.4 使用 tools 工具部署 (Outdated)
HugeGraph-Tools 提供了一键部署的命令行工具，用户可以使用该工具快速地一键下载、解压、配置并启动 HugeGraph-Server 和
HugeGraph-Hubble，最新的 HugeGraph-Toolchain 中已经包含所有的这些工具，直接下载它解压就有工具包集合了
@@ -450,9 +457,9 @@ Connecting to HugeGraphServer
(http://127.0.0.1:8080/graphs)......OK
version: "3"
services:
- graph:
+ server:
image: hugegraph/hugegraph
- container_name: cas-graph
+ container_name: cas-server
ports:
- 8080:8080
environment:
@@ -507,7 +514,7 @@ volumes:
1. 使用`docker run`
- 使用 `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true
hugegraph/hugegraph:latest`
+ 使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true
hugegraph/hugegraph:latest`
2. 使用`docker-compose`
@@ -516,9 +523,9 @@ volumes:
```yaml
version: '3'
services:
- graph:
+ server:
image: hugegraph/hugegraph:latest
- container_name: graph
+ container_name: server
environment:
- PRELOAD=true
volumes:
diff --git a/content/cn/docs/quickstart/hugegraph-tools.md
b/content/cn/docs/quickstart/hugegraph-tools.md
index da8c640c..6e03d457 100644
--- a/content/cn/docs/quickstart/hugegraph-tools.md
+++ b/content/cn/docs/quickstart/hugegraph-tools.md
@@ -1,6 +1,6 @@
---
title: "HugeGraph-Tools Quick Start"
-linkTitle: "Manage with HugeGraph-Tools"
+linkTitle: "使用 HugeGraph-Tools 导出/管理图"
weight: 5
---
diff --git a/content/en/docs/changelog/hugegraph-0.10.4-release-notes.md
b/content/en/docs/changelog/hugegraph-0.10.4-release-notes.md
index 2055c9a0..cb635b42 100644
--- a/content/en/docs/changelog/hugegraph-0.10.4-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.10.4-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.10 Release Notes"
linkTitle: "Release-0.10.4"
draft: true
-weight: 3
+weight: 14
---
### API & Client
diff --git a/content/en/docs/changelog/hugegraph-0.11.2-release-notes.md
b/content/en/docs/changelog/hugegraph-0.11.2-release-notes.md
index 9802d28c..21876997 100644
--- a/content/en/docs/changelog/hugegraph-0.11.2-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.11.2-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.11 Release Notes"
linkTitle: "Release-0.11.2"
draft: true
-weight: 2
+weight: 13
---
### API & Client
diff --git a/content/en/docs/changelog/hugegraph-0.12.0-release-notes.md
b/content/en/docs/changelog/hugegraph-0.12.0-release-notes.md
index 1ccf5fc5..e0914ae6 100644
--- a/content/en/docs/changelog/hugegraph-0.12.0-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.12.0-release-notes.md
@@ -1,7 +1,8 @@
---
title: "HugeGraph 0.12 Release Notes"
linkTitle: "Release-0.12.0"
-weight: 2
+draft: true
+weight: 12
---
### API & Client
diff --git a/content/en/docs/changelog/hugegraph-0.2-release-notes.md
b/content/en/docs/changelog/hugegraph-0.2-release-notes.md
index 7f8027b7..4c974aad 100644
--- a/content/en/docs/changelog/hugegraph-0.2-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.2-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.2 Release Notes"
linkTitle: "Release-0.2.4"
draft: true
-weight: 11
+weight: 23
---
### API & Java Client
diff --git a/content/en/docs/changelog/hugegraph-0.2.4-release-notes.md
b/content/en/docs/changelog/hugegraph-0.2.4-release-notes.md
index 185b42d4..e826bc01 100644
--- a/content/en/docs/changelog/hugegraph-0.2.4-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.2.4-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.2.4 Release Notes"
linkTitle: "Release-0.2.4"
draft: true
-weight: 12
+weight: 22
---
### API & Java Client
diff --git a/content/en/docs/changelog/hugegraph-0.3.3-release-notes.md
b/content/en/docs/changelog/hugegraph-0.3.3-release-notes.md
index 850e2897..b114d1e2 100644
--- a/content/en/docs/changelog/hugegraph-0.3.3-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.3.3-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.3.3 Release Notes"
linkTitle: "Release-0.3.3"
draft: true
-weight: 10
+weight: 21
---
### API & Java Client
diff --git a/content/en/docs/changelog/hugegraph-0.4.4-release-notes.md
b/content/en/docs/changelog/hugegraph-0.4.4-release-notes.md
index 7f2985f8..93c12089 100644
--- a/content/en/docs/changelog/hugegraph-0.4.4-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.4.4-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.4.4 Release Notes"
linkTitle: "Release-0.4.4"
draft: true
-weight: 9
+weight: 20
---
### API & Java Client
diff --git a/content/en/docs/changelog/hugegraph-0.5.6-release-notes.md
b/content/en/docs/changelog/hugegraph-0.5.6-release-notes.md
index 9b6cfbee..e151bcda 100644
--- a/content/en/docs/changelog/hugegraph-0.5.6-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.5.6-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.5 Release Notes"
linkTitle: "Release-0.5.6"
draft: true
-weight: 8
+weight: 19
---
### API & Java Client
diff --git a/content/en/docs/changelog/hugegraph-0.6.1-release-notes.md
b/content/en/docs/changelog/hugegraph-0.6.1-release-notes.md
index 1a86ac67..57dae14f 100644
--- a/content/en/docs/changelog/hugegraph-0.6.1-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.6.1-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.6 Release Notes"
linkTitle: "Release-0.6.1"
draft: true
-weight: 7
+weight: 18
---
### API & Java Client
diff --git a/content/en/docs/changelog/hugegraph-0.7.4-release-notes.md
b/content/en/docs/changelog/hugegraph-0.7.4-release-notes.md
index 5210b3bb..394c0872 100644
--- a/content/en/docs/changelog/hugegraph-0.7.4-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.7.4-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.7 Release Notes"
linkTitle: "Release-0.7.4"
draft: true
-weight: 6
+weight: 17
---
### API & Java Client
diff --git a/content/en/docs/changelog/hugegraph-0.8.0-release-notes.md
b/content/en/docs/changelog/hugegraph-0.8.0-release-notes.md
index 3a2fa7ec..ad50701f 100644
--- a/content/en/docs/changelog/hugegraph-0.8.0-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.8.0-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.8 Release Notes"
linkTitle: "Release-0.8.0"
draft: true
-weight: 5
+weight: 16
---
### API & Client
diff --git a/content/en/docs/changelog/hugegraph-0.9.2-release-notes.md
b/content/en/docs/changelog/hugegraph-0.9.2-release-notes.md
index fc1c5915..1dab91e0 100644
--- a/content/en/docs/changelog/hugegraph-0.9.2-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-0.9.2-release-notes.md
@@ -2,7 +2,7 @@
title: "HugeGraph 0.9 Release Notes"
linkTitle: "Release-0.9.2"
draft: true
-weight: 4
+weight: 15
---
### API & Client
diff --git a/content/en/docs/changelog/hugegraph-1.0.0-release-notes.md
b/content/en/docs/changelog/hugegraph-1.0.0-release-notes.md
index 8add3d01..4dd1d16d 100644
--- a/content/en/docs/changelog/hugegraph-1.0.0-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-1.0.0-release-notes.md
@@ -1,7 +1,7 @@
---
title: "HugeGraph 1.0.0 Release Notes"
linkTitle: "Release-1.0.0"
-weight: 1
+weight: 11
---
### OLTP API & Client Changes
diff --git a/content/en/docs/changelog/hugegraph-1.2.0-release-notes.md
b/content/en/docs/changelog/hugegraph-1.2.0-release-notes.md
index 822c0d4b..dd385ce1 100644
--- a/content/en/docs/changelog/hugegraph-1.2.0-release-notes.md
+++ b/content/en/docs/changelog/hugegraph-1.2.0-release-notes.md
@@ -1,7 +1,7 @@
---
title: "HugeGraph 1.2.0 Release Notes"
linkTitle: "Release-1.2.0"
-weight: 1
+weight: 10
---
### Java version statement
diff --git a/content/en/docs/config/config-authentication.md
b/content/en/docs/config/config-authentication.md
index 8aa005c1..cc7b3a1a 100644
--- a/content/en/docs/config/config-authentication.md
+++ b/content/en/docs/config/config-authentication.md
@@ -77,17 +77,20 @@ and then modify the `authenticator` configuration item in
the configuration file
### Switching authentication mode
-After the authentication configuration completed, enter the **admin password**
on the **command line** when executing `init store. sh` for the first time.
(For non-Docker mode)
+After the authentication configuration completed, enter the **admin password**
on the **command line** when executing `init store.sh` for the first time. (For
non-Docker mode)
If deployed based on Docker image or if HugeGraph has already been initialized
and needs to be converted to authentication mode,
relevant graph data needs to be deleted and HugeGraph needs to be restarted.
If there is already business data in the diagram,
-it is temporarily **not possible** to directly convert the authentication mode
(improvements/support for this feature will be released in the next version.
Could refer [PR 2411](https://github.com/apache/incubator-hugegraph/pull/2411)).
+it is temporarily **not possible** to directly convert the authentication mode
(version<=1.2.0 )
+
+> Improvements for this feature have been included in the latest release
(available in latest docker image), please refer to [PR
2411](https://github.com/apache/incubator-hugegraph/pull/2411). Seamless
switching is now available.
```bash
# stop the hugeGraph firstly
bin/stop-hugegraph.sh
# delete the store data (here we use the default path for rocksdb)
+# there is no need to delete in the latest version (fixed in
https://github.com/apache/incubator-hugegraph/pull/2411)
rm -rf rocksdb-data/
# init store again
@@ -96,4 +99,46 @@ bin/init-store.sh
# start hugeGraph again
bin/start-hugegraph.sh
-```
\ No newline at end of file
+```
+
+### Use docker to enble authentication mode
+
+For versions of the hugegraph/hugegraph image equal to or greater than 1.2.0,
you can enable authentication mode while starting the Docker image.
+
+The steps are as follows:
+
+#### 1. Use docker run
+
+To enable authentication mode, add the environment variable `PASSWORD=123456`
(you can freely set the password) in the `docker run` command:
+
+```bash
+docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080
hugegraph/hugegraph:1.2.0
+```
+
+#### 2. Use docker-compose
+
+Use `docker-compose` and set he environment variable `PASSWORD=123456`:
+
+```yaml
+version: '3'
+services:
+ server:
+ image: hugegraph/hugegraph:1.2.0
+ container_name: server
+ ports:
+ - 8080:8080
+ environment:
+ - PASSWORD=123456
+```
+
+#### 3. Enter the container to enable authentication mode
+
+Enter the container first:
+
+```bash
+docker exec -it server bash
+# Modify the config quickly, the modified file are save in the conf-bak folder
+bin/enable-auth.sh
+```
+
+Then follow [Switching authentication mode](#switching-authentication-mode)
diff --git a/content/en/docs/images/images-server/31docker-option.jpg
b/content/en/docs/images/images-server/31docker-option.jpg
new file mode 100644
index 00000000..67db0fcc
Binary files /dev/null and
b/content/en/docs/images/images-server/31docker-option.jpg differ
diff --git a/content/en/docs/quickstart/hugegraph-client.md
b/content/en/docs/quickstart/hugegraph-client.md
index d321c93a..f2d9c0fd 100644
--- a/content/en/docs/quickstart/hugegraph-client.md
+++ b/content/en/docs/quickstart/hugegraph-client.md
@@ -8,6 +8,8 @@ weight: 4
HugeGraph-Client sends HTTP request to HugeGraph-Server to obtain and parse
the execution result of Server. Currently only the HugeGraph-Client for Java is
provided. You can use HugeGraph-Client to write Java code to operate HugeGraph,
such as adding, deleting, modifying, and querying schema and graph data, or
executing gremlin statements.
+> Now we support [HugeGraph client SDK tool based on Go
language](https://github.com/apache/incubator-hugegraph-toolchain/blob/master/hugegraph-client-go/README.en.md)
(version >=1.2.0)
+
### 2 What You Need
- Java 11 (also support Java 8)
diff --git a/content/en/docs/quickstart/hugegraph-hubble.md
b/content/en/docs/quickstart/hugegraph-hubble.md
index c844942d..97d6ffc3 100644
--- a/content/en/docs/quickstart/hugegraph-hubble.md
+++ b/content/en/docs/quickstart/hugegraph-hubble.md
@@ -36,16 +36,50 @@ For Gremlin tasks that need to traverse the whole graph,
index creation and reco
There are three ways to deplot `hugegraph-hubble`
+- Use Docker (Convenient for Test/Dev)
- Download the Toolchain binary package
- Source code compilation
-- Use Docker (Convenient for Test/Dev)
-#### 2.1 Download the Toolchain binary package
+#### 2.1 Use docker (Convenient for Test/Dev)
+
+> **Special Note**: If you are starting `hubble` with Docker, and `hubble` and
the server are on the same host. When configuring the hostname for the graph on
the Hubble web page, please do not directly set it to `localhost/127.0.0.1`.
This will refer to the `hubble` container internally rather than the host
machine, resulting in a connection failure to the server.
+>
+> If `hubble` and `server` is in the same docker network, we **recommend**
using the `container_name` (in our example, it is `server`) as the hostname,
and `8080` as the port. Or you can use the **host IP** as the hostname, and the
port is configured by the host for the server.
+
+We can use `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` to
quick start [hubble](https://hub.docker.com/r/hugegraph/hubble).
+
+Alternatively, you can use Docker Compose to start `hubble`. Additionally, if
`hubble` and the graph are in the same Docker network, you can access the graph
using the container name of the graph, eliminating the need for the host
machine's IP address.
+
+Use `docker-compose up -d`，`docker-compose.yml` is following:
+
+```yaml
+version: '3'
+services:
+ server:
+ image: hugegraph/hugegraph
+ container_name: server
+ ports:
+ - 8080:8080
+
+ hubble:
+ image: hugegraph/hubble
+ container_name: hubble
+ ports:
+ - 8088:8088
+```
+
+> Note:
+>
+> 1. The docker image of hugegraph-hubble is a convenience release to start
hugegraph-hubble quickly, but not **official distribution** artifacts. You can
find more details from [ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
+>
+> 2. Recommand to use `release tag`(like `1.2.0`) for the stable version. Use
`latest` tag to experience the newest functions in development.
+
+#### 2.2 Download the Toolchain binary package
`hubble` is in the `toolchain` project. First, download the binary tar tarball
```bash
-wget
https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-{version}.tar.gz
+wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}.tar.gz
tar -xvf apache-hugegraph-toolchain-incubating-{version}.tar.gz
cd
apache-hugegraph-toolchain-incubating-{version}.tar.gz/apache-hugegraph-hubble-incubating-{version}
```
@@ -69,7 +103,7 @@ starting HugeGraphHubble ..............timed out with http
status 502
Then use a web browser to access `ip:8088` and you can see the `Hubble` page.
You can stop the service using bin/stop-hubble.sh.
-#### 2.2 Source code compilation
+#### 2.3 Source code compilation
**Note**: Compiling Hubble requires the user's local environment to have
Node.js V16.x and yarn installed.
@@ -115,40 +149,6 @@ Run `hubble`
bin/start-hubble.sh -d
```
-#### 2.3 Use docker (Convenient for Test/Dev)
-
-> **Special Note**: If you are starting `hubble` with Docker, and `hubble` and
the server are on the same host. When configuring the hostname for the graph on
the Hubble web page, please do not directly set it to `localhost/127.0.0.1`.
This will refer to the `hubble` container internally rather than the host
machine, resulting in a connection failure to the server.
->
-> If `hubble` and `server` is in the same docker network, we **recommend**
using the `container_name` (in our example, it is `graph`) as the hostname, and
`8080` as the port. Or you can use the **host IP** as the hostname, and the
port is configured by the host for the server.
-
-We can use `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` to
quick start [hubble](https://hub.docker.com/r/hugegraph/hubble).
-
-Alternatively, you can use Docker Compose to start `hubble`. Additionally, if
`hubble` and the graph are in the same Docker network, you can access the graph
using the container name of the graph, eliminating the need for the host
machine's IP address.
-
-Use `docker-compose up -d`，`docker-compose.yml` is following:
-
-```yaml
-version: '3'
-services:
- server:
- image: hugegraph/hugegraph
- container_name: graph
- ports:
- - 8080:8080
-
- hubble:
- image: hugegraph/hubble
- container_name: hubble
- ports:
- - 8088:8088
-```
-
-> Note:
->
-> 1. The docker image of hugegraph-hubble is a convenience release to start
hugegraph-hubble quickly, but not **official distribution** artifacts. You can
find more details from [ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
->
-> 2. Recommand to use `release tag`(like `1.0.0`) for the stable version. Use
`latest` tag to experience the newest functions in development.
-
### 3 Platform Workflow
The module usage process of the platform is as follows:
diff --git a/content/en/docs/quickstart/hugegraph-loader.md
b/content/en/docs/quickstart/hugegraph-loader.md
index bd7ed387..02ba802c 100644
--- a/content/en/docs/quickstart/hugegraph-loader.md
+++ b/content/en/docs/quickstart/hugegraph-loader.md
@@ -23,11 +23,42 @@ It will be explained in detail below.
There are two ways to get HugeGraph-Loader:
+- Use docker image (Convenient for Test/Dev)
- Download the compiled tarball
- Clone source code then compile and install
-- Use docker image (Convenient for Test/Dev)
-#### 2.1 Download the compiled archive
+#### 2.1 Use Docker image (Convenient for Test/Dev)
+
+We can deploy the loader service using `docker run -itd --name loader
hugegraph/loader`. For the data that needs to be loaded, it can be copied into
the loader container either by mounting `-v /path/to/data/file:/loader/file` or
by using `docker cp`.
+
+Alternatively, to start the loader using docker-compose, the command is
`docker-compose up -d`. An example of the docker-compose.yml is as follows:
+
+```yaml
+version: '3'
+
+services:
+ server:
+ image: hugegraph/hugegraph
+ container_name: server
+ ports:
+ - 8080:8080
+
+ loader:
+ image: hugegraph/loader
+ container_name: loader
+ # mount your own data here
+ # volumes:
+ # - /path/to/data/file:/loader/file
+```
+
+The specific data loading process can be referenced under [4.5 User Docker to
load data](#45-use-docker-to-load-data)
+
+> Note:
+> 1. The docker image of hugegraph-loader is a convenience release to start
hugegraph-loader quickly, but not **official distribution** artifacts. You can
find more details from [ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
+>
+> 2. Recommand to use `release tag`(like `1.2.0`) for the stable version. Use
`latest` tag to experience the newest functions in development.
+
+#### 2.2 Download the compiled archive
Download the latest version of the HugeGraph-Toolchain release package:
@@ -36,7 +67,7 @@ wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph
tar zxf *hugegraph*.tar.gz
```
-#### 2.2 Clone source code to compile and install
+#### 2.3 Clone source code to compile and install
Clone the latest version of HugeGraph-Loader source package:
@@ -48,6 +79,9 @@ git clone https://github.com/apache/hugegraph-toolchain.git
wget
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}-src.tar.gz
```
+<details>
+<summary>click to fold/collapse hwo to install ojdbc</summary>
+
Due to the license limitation of the `Oracle OJDBC`, you need to manually
install ojdbc to the local maven repository.
Visit the [Oracle jdbc
downloads](https://www.oracle.com/database/technologies/appdev/jdbc-drivers-archive.html)
page. Select Oracle Database 12c Release 2 (12.2.0.1) drivers, as shown in the
following figure.
@@ -58,6 +92,8 @@ Install ojdbc8 to the local maven repository, enter the
directory where `ojdbc8.
mvn install:install-file -Dfile=./ojdbc8.jar -DgroupId=com.oracle
-DartifactId=ojdbc8 -Dversion=12.2.0.1 -Dpackaging=jar
```
+</details>
+
Compile and generate tar package:
```bash
@@ -65,43 +101,6 @@ cd hugegraph-loader
mvn clean package -DskipTests
```
-#### 2.3 Use Docker image (Convenient for Test/Dev)
-
-We can deploy the loader service using `docker run -itd --name loader
hugegraph/loader`. For the data that needs to be loaded, it can be copied into
the loader container either by mounting `-v /path/to/data/file:/loader/file` or
by using `docker cp`.
-
-Alternatively, to start the loader using docker-compose, the command is
`docker-compose up -d`. An example of the docker-compose.yml is as follows:
-
-```yaml
-version: '3'
-
-services:
- server:
- image: hugegraph/hugegraph
- container_name: graph
- ports:
- - 8080:8080
-
- hubble:
- image: hugegraph/hubble
- container_name: hubble
- ports:
- - 8088:8088
-
- loader:
- image: hugegraph/loader
- container_name: loader
- # mount your own data here
- # volumes:
- # - /path/to/data/file:/loader/file
-```
-
-The specific data loading process can be referenced under [4.5 User Docker to
load data](#45-use-docker-to-load-data)
-
-> Note:
-> 1. The docker image of hugegraph-loader is a convenience release to start
hugegraph-loader quickly, but not **official distribution** artifacts. You can
find more details from [ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
->
-> 2. Recommand to use `release tag`(like `1.0.0`) for the stable version. Use
`latest` tag to experience the newest functions in development.
-
### 3 How to use
The basic process of using HugeGraph-Loader is divided into the following
steps:
- Write graph schema
@@ -1061,16 +1060,16 @@ If you need to import your custom dataset, you just
need to modify the paths for
"You can refer to [3.4.1 Parameter description](#341-parameter-description)
for the rest of the parameters.
```bash
-docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
example/file/struct.json -s example/file/schema.groovy -h graph -p 8080
+docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
example/file/struct.json -s example/file/schema.groovy -h server -p 8080
```
If loading a custom dataset, following the previous example, you would use:
```bash
-docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
/loader/dataset/struct.json -s /loader/dataset/schema.groovy -h graph -p 8080
+docker exec -it loader bin/hugegraph-loader.sh -g hugegraph -f
/loader/dataset/struct.json -s /loader/dataset/schema.groovy -h server -p 8080
```
-> If `loader` and `server` are in the same Docker network, you can specify `-h
{server_container_name}`; otherwise, you need to specify the IP of the `server`
host (in our example, `server_container_name` is `graph`).
+> If `loader` and `server` are in the same Docker network, you can specify `-h
{server_container_name}`; otherwise, you need to specify the IP of the `server`
host (in our example, `server_container_name` is `server`).
Then we can obverse the result:
@@ -1116,7 +1115,7 @@ Besides using `docker exec` directly for data import, we
can also enter the cont
Enter the container by `docker exec -it loader bash` and execute the command:
```bash
-sh bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s
example/file/schema.groovy -h graph -p 8080
+sh bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s
example/file/schema.groovy -h server -p 8080
```
The results of the execution will be similar to those shown in
[4.5.1](#451-use-docker-exec-to-load-data-directly).
diff --git a/content/en/docs/quickstart/hugegraph-server.md
b/content/en/docs/quickstart/hugegraph-server.md
index 64eb4381..c3cbf04c 100644
--- a/content/en/docs/quickstart/hugegraph-server.md
+++ b/content/en/docs/quickstart/hugegraph-server.md
@@ -24,13 +24,52 @@ Consider use Java 11 to run `HugeGraph-Server` (also
compatible with Java 8 now)
There are four ways to deploy HugeGraph-Server components:
-- Method 1: Download the binary tarball
-- Method 2: Source code compilation
-- Method 3: Use Docker container (Convenient for Test/Dev)
+- Method 1 Use Docker container (Convenient for Test/Dev)
+- Method 2: Download the binary tarball
+- Method 3: Source code compilation
- Method 4: One-click deployment
+#### 3.1 Use Docker container (Convenient for Test/Dev)
-#### 3.1 Download the binary tar tarball
+<!-- 3.1 is linked by other place. if change 3.1's title, please check -->
+You can refer to [Docker deployment
guide](https://hub.docker.com/r/hugegraph/hugegraph).
+
+We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to
quickly start an inner `HugeGraph server` with `RocksDB` in background.
+
+Optional:
+1. use `docker exec -it graph bash` to enter the container to do some
operations.
+2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true"
hugegraph/hugegraph` to start with a **built-in** example graph. We can use
`RESTful API` to verify the result. The detailed step can refer to
[5.1.7](#517-create-an-example-graph-when-startup)
+3. use `-e PASSWORD=123456` to enable auth mode and set the passoword for
admin. You cna find more details from [Config
Authentication](/docs/config/config-authentication#Use-docker-to-enble-authentication-mode)
+
+If you use docker desktop, you can set the option like:
+<div style="text-align: center;">
+ <img src="/docs/images/images-server/31docker-option.jpg" alt="image"
style="width:33%;">
+</div>
+
+Also, if we want to manage the other Hugegraph related instances in one file,
we can use `docker-compose` to deploy, with the command `docker-compose up -d`
(you can config only `server`). Here is an example `docker-compose.yml`:
+
+```yaml
+version: '3'
+services:
+ server:
+ image: hugegraph/hugegraph
+ container_name: server
+ # environment:
+ # - PRELOAD=true
+ # PRELOAD is a option to preload a build-in sample graph when initializing.
+ # - PASSWORD=123456
+ # PASSWORD is an option to enable auth mode with the password you set.
+ ports:
+ - 8080:8080
+```
+
+> Note:
+>
+> 1. The docker image of hugegraph is a convenience release to start hugegraph
quickly, but not **official distribution** artifacts. You can find more details
from [ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
+>
+> 2. Recommand to use `release tag`(like `1.2.0`) for the stable version. Use
`latest` tag to experience the newest functions in development.
+
+#### 3.2 Download the binary tar tarball
You could download the binary tarball from the download page of ASF site like
this:
```bash
@@ -43,7 +82,7 @@ shasum -a 512 apache-hugegraph-incubating-{version}.tar.gz
curl
https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-incubating-{version}.tar.gz.sha512
```
-#### 3.2 Source code compilation
+#### 3.3 Source code compilation
Please ensure that the wget command is installed before compiling the source
code
We could get HugeGraph **source code** by 2 ways: (So as the other HugeGraph
repos/modules)
@@ -97,37 +136,6 @@ 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.
-#### 3.3 Use Docker container (Convenient for Test/Dev)
-
-<!-- 3.1 is linked by other place. if change 3.1's title, please check -->
-You can refer to [Docker deployment
guide](https://hub.docker.com/r/hugegraph/hugegraph).
-
-We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to
quickly start an inner `HugeGraph server` with `RocksDB` in background.
-
-Optional:
-1. use `docker exec -it graph bash` to enter the container to do some
operations.
-2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true"
hugegraph/hugegraph` to start with a **built-in** example graph. We can use
`RESTful API` to verify the result. The detailed step can refer to
[5.1.1](http://127.0.0.1:1313/docs/quickstart/hugegraph-server/#511-create-example-graph-when-starting-server)
-
-Also, if we want to manage the other Hugegraph related instances in one file,
we can use `docker-compose` to deploy, with the command `docker-compose up -d`
(you can config only `server`). Here is an example `docker-compose.yml`:
-
-```yaml
-version: '3'
-services:
- graph:
- image: hugegraph/hugegraph
- # environment:
- # - PRELOAD=true
- # PRELOAD is a option to preload a build-in sample graph when initializing.
- ports:
- - 8080:8080
-```
-
-> Note:
->
-> 1. The docker image of hugegraph is a convenience release to start hugegraph
quickly, but not **official distribution** artifacts. You can find more details
from [ASF Release Distribution
Policy](https://infra.apache.org/release-distribution.html#dockerhub).
->
-> 2. Recommand to use `release tag`(like `1.2.0`) for the stable version. Use
`latest` tag to experience the newest functions in development.
-
#### 3.4 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 `HugeGraph-Hubble` with one click.
@@ -464,7 +472,7 @@ version: "3"
services:
graph:
image: hugegraph/hugegraph
- container_name: cas-graph
+ container_name: cas-server
ports:
- 8080:8080
environment:
@@ -519,7 +527,7 @@ Set the environment variable `PRELOAD=true` when starting
Docker in order to loa
1. Use `docker run`
- Use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true
hugegraph/hugegraph:latest`
+ Use `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true
hugegraph/hugegraph:latest`
2. Use `docker-compose`
@@ -528,9 +536,9 @@ Set the environment variable `PRELOAD=true` when starting
Docker in order to loa
```yaml
version: '3'
services:
- graph:
+ server:
image: hugegraph/hugegraph:latest
- container_name: graph
+ container_name: server
environment:
- PRELOAD=true
ports:
