You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hugegraph.apache.org by "SunnyBoy-WYH (via GitHub)" <gi...@apache.org> on 2023/12/27 14:13:39 UTC
[PR] chore(doc): update hugegraph doc about install [incubator-hugegraph-doc]
SunnyBoy-WYH opened a new pull request, #316:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/316
update install doc
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] chore(doc): update hugegraph doc about install [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #316:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/316#discussion_r1437558192
##########
content/cn/docs/quickstart/hugegraph-server.md:
##########
@@ -160,6 +177,24 @@ HugeGraphServer 启动时会连接后端存储并尝试检查后端存储版本
由于各种后端所需的配置（hugegraph.properties）及启动步骤略有不同，下面逐一对各后端的配置及启动做介绍。
+如果想要使用 HugeGraph 鉴权模式，在后面正式启动 HugeGraph 之前应按照 [HugeGraph 鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置
+
+如果已经初始化 HugeGraph 并需要转换为鉴权模式，则需要删除相关图数据并重新启动 HugeGraph。若图已有业务数据，则无法转换鉴权模式，对于该功能的支持将在下个版本中支持。
+
+```bash
+# stop the hugeGraph firstly
+bin/stop-hugegraph.sh
+
+# delete the store data
Review Comment:
```suggestion
# delete the store data (here we use the default path for rocksdb)
```
##########
content/cn/docs/quickstart/hugegraph-server.md:
##########
@@ -160,6 +177,24 @@ HugeGraphServer 启动时会连接后端存储并尝试检查后端存储版本
由于各种后端所需的配置（hugegraph.properties）及启动步骤略有不同，下面逐一对各后端的配置及启动做介绍。
+如果想要使用 HugeGraph 鉴权模式，在后面正式启动 HugeGraph 之前应按照 [HugeGraph 鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置
Review Comment:
```suggestion
如果想要使用 HugeGraph 鉴权模式，在后面正式启动 Server 之前应按照 [Server 鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置
```
##########
content/cn/docs/quickstart/hugegraph-server.md:
##########
@@ -160,6 +177,24 @@ HugeGraphServer 启动时会连接后端存储并尝试检查后端存储版本
由于各种后端所需的配置（hugegraph.properties）及启动步骤略有不同，下面逐一对各后端的配置及启动做介绍。
+如果想要使用 HugeGraph 鉴权模式，在后面正式启动 HugeGraph 之前应按照 [HugeGraph 鉴权配置](https://hugegraph.apache.org/cn/docs/config/config-authentication/) 进行配置
+
+如果已经初始化 HugeGraph 并需要转换为鉴权模式，则需要删除相关图数据并重新启动 HugeGraph。若图已有业务数据，则无法转换鉴权模式，对于该功能的支持将在下个版本中支持。
Review Comment:
```suggestion
如果已经初始化 HugeGraph 并需要转换为鉴权模式，则需要删除相关图数据并重新启动 HugeGraph。若图已有业务数据，暂时无法直接转换鉴权模式 (对于该功能的改进/支持将在下个版本中发布)
```
##########
content/cn/docs/quickstart/hugegraph-server.md:
##########
Review Comment:
似乎部分内容是重复的? 需要去重一下, 另外 auth 相关的内容应该是在 auth 的文档页面告诉用户, 这里只做一个链接引用为宜, 搬过去好一点
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] chore(doc): update hugegraph doc about install [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #316:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/316#discussion_r1439213838
##########
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/cn/docs/config/config-authentication/) configuration before you start Server later.
Review Comment:
```suggestion
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.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] chore(doc): update hugegraph doc about install [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin merged PR #316:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/316
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] chore(doc): update hugegraph doc about install [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #316:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/316#discussion_r1439009648
##########
content/cn/docs/config/config-authentication.md:
##########
Review Comment:
这里还需要在配置 Auth 后补充一下, 如何初始化 `admin` 密码
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
Re: [PR] chore(doc): update hugegraph doc about install [incubator-hugegraph-doc]
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on code in PR #316:
URL: https://github.com/apache/incubator-hugegraph-doc/pull/316#discussion_r1439212540
##########
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`配置项指向该实现。
+
+
+### 基于鉴权模式启动
+
+在鉴权配置完成后，对于非 docker 部署模式，首次执行 init-store.sh 时支持在命令行输入 admin 账户密码。
+
+如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式，需要删除相关图数据并重新启动 HugeGraph，若图已有业务数据，暂时无法直接转换鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。
Review Comment:
```suggestion
如果基于 docker 镜像部署或者已经初始化 HugeGraph 并需要转换为鉴权模式，需要删除相关图数据并重新启动 HugeGraph，若图已有业务数据，暂时**无法直接转换**鉴权模式 (对于该功能的改进/支持将在下个版本中发布)。
```
##########
content/en/docs/config/config-authentication.md:
##########
@@ -74,3 +74,27 @@ 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 is completed, for non Docker deployment modes,
+it is supported to enter the admin account password on the command line when executing init store. sh for the first time.
+
+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).
Review Comment:
```suggestion
it is temporarily **not possible** to directly convert the authentication mode (improvements/support for this feature will be released in the next version).
```
##########
content/en/docs/config/config-authentication.md:
##########
@@ -74,3 +74,27 @@ 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 is completed, for non Docker deployment modes,
+it is supported to enter the admin account password on the command line when executing init store. sh for the first time.
Review Comment:
```suggestion
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)
```
##########
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`配置项指向该实现。
+
+
+### 基于鉴权模式启动
+
+在鉴权配置完成后，对于非 docker 部署模式，首次执行 init-store.sh 时支持在命令行输入 admin 账户密码。
Review Comment:
```suggestion
在鉴权配置完成后，需在首次执行 `init-store.sh` 时命令行中输入 `admin` 密码 (非 docker 部署模式下)
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org