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 c1aa9bb9 chore(doc): update hugegraph doc about install (#316)
c1aa9bb9 is described below
commit c1aa9bb905b297b02e5af04ec01bf857a76684b0
Author: SunnyBoy-WYH <[email protected]>
AuthorDate: Tue Jan 2 15:49:10 2024 +0800
chore(doc): update hugegraph doc about install (#316)
* Apply suggestions from code review
---------
Co-authored-by: imbajin <[email protected]>
---
content/cn/docs/config/config-authentication.md | 22 ++++++++++++++++++++++
content/cn/docs/quickstart/hugegraph-server.md | 2 ++
content/en/docs/config/config-authentication.md | 23 +++++++++++++++++++++++
content/en/docs/quickstart/hugegraph-server.md | 2 ++
4 files changed, 49 insertions(+)
diff --git a/content/cn/docs/config/config-authentication.md
b/content/cn/docs/config/config-authentication.md
index 4e41447b..7c70daef 100644
--- a/content/cn/docs/config/config-authentication.md
+++ b/content/cn/docs/config/config-authentication.md
@@ -67,3 +67,25 @@ gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
### 自定义用户认证系统
如果需要支持更加灵活的用户系统，可自定义 authenticator 进行扩展，自定义 authenticator
实现接口`org.apache.hugegraph.auth.HugeAuthenticator`即可，然后修改配置文件中`authenticator`配置项指向该实现。
+
+
+### 基于鉴权模式启动
+
+在鉴权配置完成后，需在首次执行 `init-store.sh` 时命令行中输入 `admin` 密码 (非 docker 部署模式下)
+
+如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式，需要删除相关图数据并重新启动
HugeGraph，若图已有业务数据，暂时**无法直接转换**鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。
+
+```bash
+# stop the hugeGraph firstly
+bin/stop-hugegraph.sh
+
+# delete the store data (here we use the default path for rocksdb)
+rm -rf rocksdb-data/
+
+# init store again
+bin/init-store.sh
+
+# start hugeGraph again
+bin/start-hugegraph.sh
+
+```
\ No newline at end of file
diff --git a/content/cn/docs/quickstart/hugegraph-server.md
b/content/cn/docs/quickstart/hugegraph-server.md
index 83b10d60..3db60f99 100644
--- a/content/cn/docs/quickstart/hugegraph-server.md
+++ b/content/cn/docs/quickstart/hugegraph-server.md
@@ -160,6 +160,8 @@ HugeGraphServer 启动时会连接后端存储并尝试检查后端存储版本
由于各种后端所需的配置（hugegraph.properties）及启动步骤略有不同，下面逐一对各后端的配置及启动做介绍。
+如果想要使用 HugeGraph 鉴权模式，在后面正式启动 Server 之前应按照 [Server
鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置。
+
##### 5.1.1 RocksDB
<details>
diff --git a/content/en/docs/config/config-authentication.md
b/content/en/docs/config/config-authentication.md
index 3dbf046d..7615daab 100644
--- a/content/en/docs/config/config-authentication.md
+++ b/content/en/docs/config/config-authentication.md
@@ -74,3 +74,26 @@ For detailed API calls and explanations regarding
permissions, please refer to t
If you need to support a more flexible user system, you can customize the
authenticator for extension.
Simply implement the `org.apache.hugegraph.auth.HugeAuthenticator` interface
with your custom authenticator,
and then modify the `authenticator` configuration item in the configuration
file to point to your implementation.
+
+### 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)
+
+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).
+
+```bash
+# stop the hugeGraph firstly
+bin/stop-hugegraph.sh
+
+# delete the store data (here we use the default path for rocksdb)
+rm -rf rocksdb-data/
+
+# init store again
+bin/init-store.sh
+
+# start hugeGraph again
+bin/start-hugegraph.sh
+
+```
\ No newline at end of file
diff --git a/content/en/docs/quickstart/hugegraph-server.md
b/content/en/docs/quickstart/hugegraph-server.md
index 29a5aa07..6c0044ba 100644
--- a/content/en/docs/quickstart/hugegraph-server.md
+++ b/content/en/docs/quickstart/hugegraph-server.md
@@ -173,6 +173,8 @@ If you need to access HugeGraphServer externally, please
modify the `restserver.
Since the configuration (hugegraph.properties) and startup steps required by
various backends are slightly different, the following will introduce the
configuration and startup of each backend one by one.
+If you want to use HugeGraph authentication mode, you should follow the
[Server Authentication
Configuration](https://hugegraph.apache.org/docs/config/config-authentication/)
configuration before you start Server later.
+
##### 5.1.1 Memory
<details>
