Skip to content
This repository was archived by the owner on Dec 28, 2025. It is now read-only.

Commit 18d0dff

Browse files
authored
docs: docker starts up by default by setting a password (apache#417)
1 parent c6cb941 commit 18d0dff

File tree

9 files changed

+29
-19
lines changed

9 files changed

+29
-19
lines changed

content/cn/docs/config/config-authentication.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,15 @@ bin/start-hugegraph.sh
120120

121121
#### 1. 采用 docker run
122122

123-
`docker run` 中添加环境变量 `PASSWORD=123456`(密码可以自由设置)即可开启鉴权模式::
123+
`docker run` 中添加环境变量 `PASSWORD=xxx`(密码可以自由设置)即可开启鉴权模式::
124124

125125
```bash
126-
docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0
126+
docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0
127127
```
128128

129129
#### 2. 采用 docker-compose
130130

131-
使用 `docker-compose` 在环境变量中设置 `PASSWORD=123456`即可
131+
使用 `docker-compose` 在环境变量中设置 `PASSWORD=xxx`即可
132132

133133
```yaml
134134
version: '3'
@@ -139,7 +139,7 @@ services:
139139
ports:
140140
- 8080:8080
141141
environment:
142-
- PASSWORD=123456
142+
- PASSWORD=xxx
143143
```
144144
145145
#### 3. 进入容器后重新开启鉴权模式

content/cn/docs/config/config-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ store=hugegraph_mysql
353353
jdbc.driver=com.mysql.cj.jdbc.Driver
354354
jdbc.url=jdbc:mysql://127.0.0.1:3306
355355
jdbc.username=root
356-
jdbc.password=123456
356+
jdbc.password=xxx
357357
jdbc.reconnect_max_times=3
358358
jdbc.reconnect_interval=3
359359
jdbc.ssl_mode=false

content/cn/docs/quickstart/hugegraph/hugegraph-server.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ Core 模块是 Tinkerpop 接口的实现,Backend 模块用于管理数据存
3939

4040
可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/README.md)
4141

42-
我们可以使用 `docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0` 去快速启动一个内置了 `RocksDB``Hugegraph server`.
42+
我们可以使用 `docker run -itd --name=server -p 8080:8080 -e PASSWORD=xxx hugegraph/hugegraph:1.5.0` 去快速启动一个内置了 `RocksDB``Hugegraph server`.
4343

4444
可选项:
4545

4646
1. 可以使用 `docker exec -it server bash` 进入容器完成一些操作
4747
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)
48-
3. 可以使用 `-e PASSWORD=123456` 设置是否开启鉴权模式以及 admin 的密码,具体步骤可以参考 [Config Authentication](/cn/docs/config/config-authentication#使用-docker-时开启鉴权模式)
48+
3. 可以使用 `-e PASSWORD=xxx` 设置是否开启鉴权模式以及 admin 的密码,具体步骤可以参考 [Config Authentication](/cn/docs/config/config-authentication#使用-docker-时开启鉴权模式)
4949

5050
如果使用 docker desktop,则可以按照如下的方式设置可选项:
5151
<div style="text-align: center;">
@@ -61,9 +61,11 @@ services:
6161
server:
6262
image: hugegraph/hugegraph:1.5.0
6363
container_name: server
64-
# environment:
64+
environment:
65+
- PASSWORD=xxx
66+
# - PASSWORD=xxx 为可选参数,设置的时候可以开启鉴权模式,并设置密码
67+
# - PRELOAD=true
6568
# - PRELOAD=true 为可选参数,为 True 时可以在启动的时候预加载一个内置的样例图
66-
# - PASSWORD=123456 为可选参数,设置的时候可以开启鉴权模式,并设置密码
6769
ports:
6870
- 8080:8080
6971
```
@@ -631,6 +633,7 @@ volumes:
631633
container_name: server
632634
environment:
633635
- PRELOAD=true
636+
- PASSWORD=xxx
634637
volumes:
635638
- /path/to/yourscript:/hugegraph/scripts/example.groovy
636639
ports:

content/cn/docs/quickstart/toolchain/hugegraph-hubble.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ services:
6565
server:
6666
image: hugegraph/hugegraph:1.5.0
6767
container_name: server
68+
environment:
69+
- PASSWORD=xxx
6870
ports:
6971
- 8080:8080
7072

content/cn/docs/quickstart/toolchain/hugegraph-loader.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ services:
4242
server:
4343
image: hugegraph/hugegraph:1.5.0
4444
container_name: server
45+
environment:
46+
- PASSWORD=xxx
4547
ports:
4648
- 8080:8080
4749

content/en/docs/config/config-authentication.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,15 +127,15 @@ The steps are as follows:
127127

128128
#### 1. Use docker run
129129

130-
To enable authentication mode, add the environment variable `PASSWORD=123456` (you can freely set the password) in the `docker run` command:
130+
To enable authentication mode, add the environment variable `PASSWORD=xxx` (you can freely set the password) in the `docker run` command:
131131

132132
```bash
133-
docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0
133+
docker run -itd -e PASSWORD=xxx --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0
134134
```
135135

136136
#### 2. Use docker-compose
137137

138-
Use `docker-compose` and set the environment variable `PASSWORD=123456`:
138+
Use `docker-compose` and set the environment variable `PASSWORD=xxx`:
139139

140140
```yaml
141141
version: '3'
@@ -146,7 +146,7 @@ services:
146146
ports:
147147
- 8080:8080
148148
environment:
149-
- PASSWORD=123456
149+
- PASSWORD=xxx
150150
```
151151
152152
#### 3. Enter the container to enable authentication mode

content/en/docs/config/config-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ store=hugegraph_mysql
351351
jdbc.driver=com.mysql.cj.jdbc.Driver
352352
jdbc.url=jdbc:mysql://127.0.0.1:3306
353353
jdbc.username=root
354-
jdbc.password=123456
354+
jdbc.password=xxx
355355
jdbc.reconnect_max_times=3
356356
jdbc.reconnect_interval=3
357357
jdbc.ssl_mode=false

content/en/docs/quickstart/hugegraph/hugegraph-server.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ There are four ways to deploy HugeGraph-Server components:
4242
<!-- 3.1 is linked by another place. if change 3.1's title, please check -->
4343
You can refer to [Docker deployment guide](https://hub.docker.com/r/hugegraph/hugegraph).
4444

45-
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.
45+
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.
4646

4747
Optional:
4848
1. use `docker exec -it graph bash` to enter the container to do some operations.
4949
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)
50-
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)
50+
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)
5151

5252
If you use docker desktop, you can set the option like:
5353
<div style="text-align: center;">
@@ -62,11 +62,11 @@ services:
6262
server:
6363
image: hugegraph/hugegraph:1.5.0
6464
container_name: server
65-
# environment:
65+
environment:
66+
- PASSWORD=xxx
67+
# PASSWORD is an option to enable auth mode with the password you set.
6668
# - PRELOAD=true
6769
# PRELOAD is a option to preload a build-in sample graph when initializing.
68-
# - PASSWORD=123456
69-
# PASSWORD is an option to enable auth mode with the password you set.
7070
ports:
7171
- 8080:8080
7272
```
@@ -605,6 +605,7 @@ Set the environment variable `PRELOAD=true` when starting Docker to load data du
605605
container_name: server
606606
environment:
607607
- PRELOAD=true
608+
- PASSWORD=xxx
608609
ports:
609610
- 8080:8080
610611
```

content/en/docs/quickstart/toolchain/hugegraph-hubble.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ services:
7676
server:
7777
image: hugegraph/hugegraph:1.5.0
7878
container_name: server
79+
environment:
80+
- PASSWORD=xxx
7981
ports:
8082
- 8080:8080
8183

0 commit comments

Comments
 (0)