doc: sync doc about enable auth for docker image (#324)

1. sync with [2403](apache/incubator-hugegraph#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]>
apache · Feb 1, 2024 · d2b63d9 · d2b63d9
1 parent b2bda6d
commit d2b63d9
Show file tree

Hide file tree

Showing 54 changed files with 431 additions and 305 deletions.
diff --git a/content/cn/_index.html b/content/cn/_index.html
@@ -54,7 +54,7 @@ <h1 ><span style="font-size:50px;font-weight:bold">Apache</span>
 
 {{< 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
@@ -1,5 +1,5 @@
 ---
 title: "CHANGELOGS"
 linkTitle: "CHANGELOGS"
-weight: 9
+weight: 10
 ---
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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
 
-```
+```
+
+### 使用 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git 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
@@ -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
@@ -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
@@ -1,13 +1,15 @@
 ---
 title: "HugeGraph-Client Quick Start"
-linkTitle: "Develop with HugeGraph-Client"
+linkTitle: "使用 HugeGraph-Client 开发"
 weight: 4
 ---
 
 ### 1 HugeGraph-Client 概述
 
 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
@@ -1,6 +1,6 @@
 ---
 title: "HugeGraph-Computer Quick Start"
-linkTitle: "Analysis with HugeGraph-Computer"
+linkTitle: "使用 Computer 进行 OLAP 分析"
 weight: 6
 ---