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 6f240806 refine rest-server.property documentation (#368)
6f240806 is described below
commit 6f240806b7ae1907ce51c48f815de708e1e9a037
Author: John <[email protected]>
AuthorDate: Fri Aug 2 15:50:42 2024 +0800
refine rest-server.property documentation (#368)
---
content/cn/docs/config/config-guide.md | 5 +++--
content/en/docs/config/config-guide.md | 5 +++--
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/content/cn/docs/config/config-guide.md
b/content/cn/docs/config/config-guide.md
index 9febc796..bd64bdf7 100644
--- a/content/cn/docs/config/config-guide.md
+++ b/content/cn/docs/config/config-guide.md
@@ -154,6 +154,7 @@ rest-server.properties 文件的默认内容如下：
```properties
# bind url
+# could use '0.0.0.0' or specified (real)IP to expose external network access
restserver.url=http://127.0.0.1:8080
# gremlin server url, need to be consistent with host and port in
gremlin-server.yaml
#gremlinserver.url=http://127.0.0.1:8182
@@ -170,7 +171,7 @@ server.id=server-1
server.role=master
```
-- restserver.url：RestServer 提供服务的 url，根据实际环境修改；
+- restserver.url：RestServer 提供服务的 url，根据实际环境修改。如果其他 IP
地址无法访问，可以尝试修改为特定的地址；或修改为 `http://0.0.0.0` 来监听来自任何 IP
地址的请求，这种方案较为便捷，但需要留意服务可被访问的网络范围；
- graphs：RestServer 启动时也需要打开图，该项为 map 结构，key 是图的名字，value 是该图的配置文件路径；
> 注意：gremlin-server.yaml 和 rest-server.properties 都包含 graphs 配置项，而
> `init-store` 命令是根据 gremlin-server.yaml 的 graphs 下的图进行初始化的。
@@ -375,4 +376,4 @@ curl http://127.0.0.1:8080/graphs/hugegraph_mysql_backend
curl http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
{"name":"hugegraph_rocksdb","backend":"rocksdb"}
-```
\ No newline at end of file
+```
diff --git a/content/en/docs/config/config-guide.md
b/content/en/docs/config/config-guide.md
index f335bf99..f17662ab 100644
--- a/content/en/docs/config/config-guide.md
+++ b/content/en/docs/config/config-guide.md
@@ -152,6 +152,7 @@ The default content of the `rest-server.properties` file is
as follows:
```properties
# bind url
+# could use '0.0.0.0' or specified (real)IP to expose external network access
restserver.url=http://127.0.0.1:8080
# gremlin server url, need to be consistent with host and port in
gremlin-server.yaml
#gremlinserver.url=http://127.0.0.1:8182
@@ -168,7 +169,7 @@ server.id=server-1
server.role=master
```
-- `restserver.url`: The URL at which the RestServer provides its services.
Modify it according to the actual environment.
+- `restserver.url`: The URL at which the RestServer provides its services.
Modify it according to the actual environment. If you can't connet to server
from other IP address, try to modify it as specific IP; or modify it as
`http://0.0.0.0` to listen all network interfaces as a convenient solution, but
need to take care of the network area that might access.
- `graphs`: The RestServer also needs to open graphs when it starts. This
option is a map structure where the key is the name of the graph and the value
is the configuration file path for that graph.
> Note: Both `gremlin-server.yaml` and `rest-server.properties` contain the
> `graphs` configuration option, and the `init-store` command initializes
> based on the graphs specified in the `graphs` section of
> `gremlin-server.yaml`.
@@ -373,4 +374,4 @@ curl http://127.0.0.1:8080/graphs/hugegraph_mysql_backend
curl http://127.0.0.1:8080/graphs/hugegraph_rocksdb_backend
{"name":"hugegraph_rocksdb","backend":"rocksdb"}
-```
\ No newline at end of file
+```
