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 18d0dffa docs: docker starts up by default by setting a password (#417)
18d0dffa is described below
commit 18d0dffaab07a570f5582ede3ac4dd6a9c016df4
Author: Tsukilc <[email protected]>
AuthorDate: Thu Sep 25 17:04:41 2025 +0800
docs: docker starts up by default by setting a password (#417)
---
content/cn/docs/config/config-authentication.md | 8 ++++----
content/cn/docs/config/config-guide.md | 2 +-
content/cn/docs/quickstart/hugegraph/hugegraph-server.md | 11 +++++++----
content/cn/docs/quickstart/toolchain/hugegraph-hubble.md | 2 ++
content/cn/docs/quickstart/toolchain/hugegraph-loader.md | 2 ++
content/en/docs/config/config-authentication.md | 8 ++++----
content/en/docs/config/config-guide.md | 2 +-
content/en/docs/quickstart/hugegraph/hugegraph-server.md | 11 ++++++-----
content/en/docs/quickstart/toolchain/hugegraph-hubble.md | 2 ++
9 files changed, 29 insertions(+), 19 deletions(-)
diff --git a/content/cn/docs/config/config-authentication.md
b/content/cn/docs/config/config-authentication.md
index 0f0aa13c..d11f7db7 100644
--- a/content/cn/docs/config/config-authentication.md
+++ b/content/cn/docs/config/config-authentication.md
@@ -120,15 +120,15 @@ bin/start-hugegraph.sh
#### 1. 采用 docker run
-在 `docker run` 中添加环境变量 `PASSWORD=123456`（密码可以自由设置）即可开启鉴权模式：：
+在 `docker run` 中添加环境变量 `PASSWORD=xxx`（密码可以自由设置）即可开启鉴权模式：：
```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
-使用 `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 270a070b..efb92c2c 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 a61c8c68..4a1b287f 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 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，则可以按照如下的方式设置可选项：
<div style="text-align: center;">
@@ -61,9 +61,11 @@ services:
server:
image: hugegraph/hugegraph:1.5.0
container_name: server
- # environment:
+ environment:
+ - PASSWORD=xxx
+ # - PASSWORD=xxx 为可选参数，设置的时候可以开启鉴权模式，并设置密码
+ # - PRELOAD=true
# - PRELOAD=true 为可选参数，为 True 时可以在启动的时候预加载一个内置的样例图
- # - PASSWORD=123456 为可选参数，设置的时候可以开启鉴权模式，并设置密码
ports:
- 8080:8080
```
@@ -631,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 ecf3bed0..64871ca1 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 a61093fb..b88a28ef 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/config/config-authentication.md
b/content/en/docs/config/config-authentication.md
index 46b945f0..4ebde630 100644
--- a/content/en/docs/config/config-authentication.md
+++ b/content/en/docs/config/config-authentication.md
@@ -127,15 +127,15 @@ 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=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
-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 b29046eb..979c4933 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 2a579181..bbed2963 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:
<!-- 3.1 is linked by another place. if change 3.1's title, please check -->
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=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:
<div style="text-align: center;">
@@ -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=123456
- # PASSWORD is an option to enable auth mode with the password you set.
ports:
- 8080:8080
```
@@ -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 37a36d63..26b1a7d3 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
