From a0b8d3861a5b064b64c3634b3f4a6c597df8e184 Mon Sep 17 00:00:00 2001 From: Tsukilc <153273766+Tsukilc@users.noreply.github.com> Date: Tue, 23 Sep 2025 21:17:45 +0800 Subject: [PATCH 1/5] chore(docs): docker starts up by default by setting a password --- content/cn/docs/quickstart/hugegraph/hugegraph-server.md | 2 +- content/en/docs/quickstart/hugegraph/hugegraph-server.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md index a61c8c682..0e38315d4 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md @@ -39,7 +39,7 @@ Core 模块是 Tinkerpop 接口的实现,Backend 模块用于管理数据存 可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/README.md)。 -我们可以使用 `docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`. +我们可以使用 `docker run -itd --name=server -p 8080:8080 -e PASSWORD=123456 hugegraph/hugegraph:1.5.0` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`. 可选项: diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-server.md b/content/en/docs/quickstart/hugegraph/hugegraph-server.md index 2a5791817..2e761a850 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-server.md @@ -42,7 +42,7 @@ There are four ways to deploy HugeGraph-Server components: 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:1.5.0` to quickly start an inner `HugeGraph server` with `RocksDB` in background. +We can use `docker run -itd --name=graph -e PASSWORD=123456 -p 8080:8080 hugegraph/hugegraph:1.5.0` 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. From 3823e40d2b0882126de534ce23b6089854d25635 Mon Sep 17 00:00:00 2001 From: Tsukilc <153273766+Tsukilc@users.noreply.github.com> Date: Wed, 24 Sep 2025 15:15:55 +0800 Subject: [PATCH 2/5] chore(docs): docker starts up by default by setting a password --- content/cn/docs/config/config-authentication.md | 2 +- content/cn/docs/quickstart/hugegraph/hugegraph-server.md | 4 ++-- content/en/docs/config/config-authentication.md | 2 +- content/en/docs/quickstart/hugegraph/hugegraph-server.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/cn/docs/config/config-authentication.md b/content/cn/docs/config/config-authentication.md index 0f0aa13cb..a386436b8 100644 --- a/content/cn/docs/config/config-authentication.md +++ b/content/cn/docs/config/config-authentication.md @@ -123,7 +123,7 @@ bin/start-hugegraph.sh 在 `docker run` 中添加环境变量 `PASSWORD=123456`(密码可以自由设置)即可开启鉴权模式:: ```bash -docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0 +docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0 ``` #### 2. 采用 docker-compose diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md index 0e38315d4..92ebe09ab 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md @@ -39,13 +39,13 @@ Core 模块是 Tinkerpop 接口的实现,Backend 模块用于管理数据存 可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/README.md)。 -我们可以使用 `docker run -itd --name=server -p 8080:8080 -e PASSWORD=123456 hugegraph/hugegraph:1.5.0` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`. +我们可以使用 `docker run -itd --name=server -p 8080:8080 -e PASSWORD=xxx hugegraph/hugegraph:1.5.0` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`. 可选项: 1. 可以使用 `docker exec -it server bash` 进入容器完成一些操作 2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `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. 可以使用 `-e PASSWORD=xxx` 设置是否开启鉴权模式以及 admin 的密码,具体步骤可以参考 [Config Authentication](/cn/docs/config/config-authentication#使用-docker-时开启鉴权模式) 如果使用 docker desktop,则可以按照如下的方式设置可选项:
diff --git a/content/en/docs/config/config-authentication.md b/content/en/docs/config/config-authentication.md index 46b945f05..49288b43a 100644 --- a/content/en/docs/config/config-authentication.md +++ b/content/en/docs/config/config-authentication.md @@ -130,7 +130,7 @@ The steps are as follows: 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.5.0 +docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0 ``` #### 2. Use docker-compose diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-server.md b/content/en/docs/quickstart/hugegraph/hugegraph-server.md index 2e761a850..2e0f092ae 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-server.md @@ -42,12 +42,12 @@ There are four ways to deploy HugeGraph-Server components: You can refer to [Docker deployment guide](https://hub.docker.com/r/hugegraph/hugegraph). -We can use `docker run -itd --name=graph -e PASSWORD=123456 -p 8080:8080 hugegraph/hugegraph:1.5.0` to quickly start an inner `HugeGraph server` with `RocksDB` in background. +We can use `docker run -itd --name=graph -e PASSWORD=xxx -p 8080:8080 hugegraph/hugegraph:1.5.0` 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:1.5.0` 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 password for admin. You can find more details from [Config Authentication](/docs/config/config-authentication#Use-docker-to-enble-authentication-mode) +3. use `-e PASSWORD=xxx` to enable auth mode and set the password for admin. You can 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:
From 960ced40b8ff4685ba586a2fac02a8e52cdec77a Mon Sep 17 00:00:00 2001 From: Tsukilc <153273766+Tsukilc@users.noreply.github.com> Date: Wed, 24 Sep 2025 16:07:22 +0800 Subject: [PATCH 3/5] chore(docs): change from 123456 to xxx --- content/cn/docs/config/config-authentication.md | 6 +++--- content/cn/docs/config/config-guide.md | 2 +- content/cn/docs/quickstart/hugegraph/hugegraph-server.md | 2 +- content/en/docs/config/config-authentication.md | 6 +++--- content/en/docs/config/config-guide.md | 2 +- content/en/docs/quickstart/hugegraph/hugegraph-server.md | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/content/cn/docs/config/config-authentication.md b/content/cn/docs/config/config-authentication.md index a386436b8..d11f7db7d 100644 --- a/content/cn/docs/config/config-authentication.md +++ b/content/cn/docs/config/config-authentication.md @@ -120,7 +120,7 @@ bin/start-hugegraph.sh #### 1. 采用 docker run -在 `docker run` 中添加环境变量 `PASSWORD=123456`(密码可以自由设置)即可开启鉴权模式:: +在 `docker run` 中添加环境变量 `PASSWORD=xxx`(密码可以自由设置)即可开启鉴权模式:: ```bash docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0 @@ -128,7 +128,7 @@ docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1 #### 2. 采用 docker-compose -使用 `docker-compose` 在环境变量中设置 `PASSWORD=123456`即可 +使用 `docker-compose` 在环境变量中设置 `PASSWORD=xxx`即可 ```yaml version: '3' @@ -139,7 +139,7 @@ services: ports: - 8080:8080 environment: - - PASSWORD=123456 + - PASSWORD=xxx ``` #### 3. 进入容器后重新开启鉴权模式 diff --git a/content/cn/docs/config/config-guide.md b/content/cn/docs/config/config-guide.md index 270a070b4..efb92c2c1 100644 --- a/content/cn/docs/config/config-guide.md +++ b/content/cn/docs/config/config-guide.md @@ -353,7 +353,7 @@ store=hugegraph_mysql jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://127.0.0.1:3306 jdbc.username=root -jdbc.password=123456 +jdbc.password=xxx jdbc.reconnect_max_times=3 jdbc.reconnect_interval=3 jdbc.ssl_mode=false diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md index 92ebe09ab..be59296bd 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md @@ -63,7 +63,7 @@ services: container_name: server # environment: # - PRELOAD=true 为可选参数,为 True 时可以在启动的时候预加载一个内置的样例图 - # - PASSWORD=123456 为可选参数,设置的时候可以开启鉴权模式,并设置密码 + # - PASSWORD=xxx 为可选参数,设置的时候可以开启鉴权模式,并设置密码 ports: - 8080:8080 ``` diff --git a/content/en/docs/config/config-authentication.md b/content/en/docs/config/config-authentication.md index 49288b43a..4ebde6303 100644 --- a/content/en/docs/config/config-authentication.md +++ b/content/en/docs/config/config-authentication.md @@ -127,7 +127,7 @@ 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: +To enable authentication mode, add the environment variable `PASSWORD=xxx` (you can freely set the password) in the `docker run` command: ```bash docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0 @@ -135,7 +135,7 @@ docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1 #### 2. Use docker-compose -Use `docker-compose` and set the environment variable `PASSWORD=123456`: +Use `docker-compose` and set the environment variable `PASSWORD=xxx`: ```yaml version: '3' @@ -146,7 +146,7 @@ services: ports: - 8080:8080 environment: - - PASSWORD=123456 + - PASSWORD=xxx ``` #### 3. Enter the container to enable authentication mode diff --git a/content/en/docs/config/config-guide.md b/content/en/docs/config/config-guide.md index b29046eb3..979c49332 100644 --- a/content/en/docs/config/config-guide.md +++ b/content/en/docs/config/config-guide.md @@ -351,7 +351,7 @@ store=hugegraph_mysql jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://127.0.0.1:3306 jdbc.username=root -jdbc.password=123456 +jdbc.password=xxx jdbc.reconnect_max_times=3 jdbc.reconnect_interval=3 jdbc.ssl_mode=false diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-server.md b/content/en/docs/quickstart/hugegraph/hugegraph-server.md index 2e0f092ae..139bbfd9c 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-server.md @@ -65,7 +65,7 @@ services: # environment: # - PRELOAD=true # PRELOAD is a option to preload a build-in sample graph when initializing. - # - PASSWORD=123456 + # - PASSWORD=xxx # PASSWORD is an option to enable auth mode with the password you set. ports: - 8080:8080 From ced23b660f1e4a579d855be9f29d547f626d84be Mon Sep 17 00:00:00 2001 From: Tsukilc <153273766+Tsukilc@users.noreply.github.com> Date: Wed, 24 Sep 2025 16:19:24 +0800 Subject: [PATCH 4/5] chore(docs): change docker-compose to use password default --- content/cn/docs/quickstart/hugegraph/hugegraph-server.md | 6 ++++-- content/en/docs/quickstart/hugegraph/hugegraph-server.md | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md index be59296bd..15d1d7ae4 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md @@ -61,9 +61,11 @@ services: server: image: hugegraph/hugegraph:1.5.0 container_name: server - # environment: - # - PRELOAD=true 为可选参数,为 True 时可以在启动的时候预加载一个内置的样例图 + environment: + - PASSWORD=xxx # - PASSWORD=xxx 为可选参数,设置的时候可以开启鉴权模式,并设置密码 + # - PRELOAD=true + # - PRELOAD=true 为可选参数,为 True 时可以在启动的时候预加载一个内置的样例图 ports: - 8080:8080 ``` diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-server.md b/content/en/docs/quickstart/hugegraph/hugegraph-server.md index 139bbfd9c..405377fc5 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-server.md @@ -62,11 +62,11 @@ services: server: image: hugegraph/hugegraph:1.5.0 container_name: server - # environment: + environment: + - PASSWORD=xxx + # PASSWORD is an option to enable auth mode with the password you set. # - PRELOAD=true # PRELOAD is a option to preload a build-in sample graph when initializing. - # - PASSWORD=xxx - # PASSWORD is an option to enable auth mode with the password you set. ports: - 8080:8080 ``` From 6ffa692fb23f6dc73a6982ee4843df3491e3b993 Mon Sep 17 00:00:00 2001 From: Tsukilc <153273766+Tsukilc@users.noreply.github.com> Date: Wed, 24 Sep 2025 16:23:07 +0800 Subject: [PATCH 5/5] chore(docs): change docker-compose to use password default --- content/cn/docs/quickstart/hugegraph/hugegraph-server.md | 1 + content/cn/docs/quickstart/toolchain/hugegraph-hubble.md | 2 ++ content/cn/docs/quickstart/toolchain/hugegraph-loader.md | 2 ++ content/en/docs/quickstart/hugegraph/hugegraph-server.md | 1 + content/en/docs/quickstart/toolchain/hugegraph-hubble.md | 2 ++ 5 files changed, 8 insertions(+) diff --git a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md index 15d1d7ae4..4a1b287f1 100644 --- a/content/cn/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/cn/docs/quickstart/hugegraph/hugegraph-server.md @@ -633,6 +633,7 @@ volumes: container_name: server environment: - PRELOAD=true + - PASSWORD=xxx volumes: - /path/to/yourscript:/hugegraph/scripts/example.groovy ports: diff --git a/content/cn/docs/quickstart/toolchain/hugegraph-hubble.md b/content/cn/docs/quickstart/toolchain/hugegraph-hubble.md index ecf3bed0d..64871ca1f 100644 --- a/content/cn/docs/quickstart/toolchain/hugegraph-hubble.md +++ b/content/cn/docs/quickstart/toolchain/hugegraph-hubble.md @@ -65,6 +65,8 @@ services: server: image: hugegraph/hugegraph:1.5.0 container_name: server + environment: + - PASSWORD=xxx ports: - 8080:8080 diff --git a/content/cn/docs/quickstart/toolchain/hugegraph-loader.md b/content/cn/docs/quickstart/toolchain/hugegraph-loader.md index a61093fba..b88a28ef5 100644 --- a/content/cn/docs/quickstart/toolchain/hugegraph-loader.md +++ b/content/cn/docs/quickstart/toolchain/hugegraph-loader.md @@ -42,6 +42,8 @@ services: server: image: hugegraph/hugegraph:1.5.0 container_name: server + environment: + - PASSWORD=xxx ports: - 8080:8080 diff --git a/content/en/docs/quickstart/hugegraph/hugegraph-server.md b/content/en/docs/quickstart/hugegraph/hugegraph-server.md index 405377fc5..bbed2963e 100644 --- a/content/en/docs/quickstart/hugegraph/hugegraph-server.md +++ b/content/en/docs/quickstart/hugegraph/hugegraph-server.md @@ -605,6 +605,7 @@ Set the environment variable `PRELOAD=true` when starting Docker to load data du container_name: server environment: - PRELOAD=true + - PASSWORD=xxx ports: - 8080:8080 ``` diff --git a/content/en/docs/quickstart/toolchain/hugegraph-hubble.md b/content/en/docs/quickstart/toolchain/hugegraph-hubble.md index 37a36d633..26b1a7d3d 100644 --- a/content/en/docs/quickstart/toolchain/hugegraph-hubble.md +++ b/content/en/docs/quickstart/toolchain/hugegraph-hubble.md @@ -76,6 +76,8 @@ services: server: image: hugegraph/hugegraph:1.5.0 container_name: server + environment: + - PASSWORD=xxx ports: - 8080:8080