Skip to content

Commit 92272bd

Browse files
committed
chore(docs): change pwd from 123456 to xxx
1 parent d280fc7 commit 92272bd

1 file changed

Lines changed: 19 additions & 18 deletions

File tree

  • hugegraph-server/hugegraph-dist/docker

hugegraph-server/hugegraph-dist/docker/README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Deploy Hugegraph server with docker
22

33
> Note:
4-
>
4+
>
55
> 1. The docker image of hugegraph is a convenience release, not official distribution artifacts from ASF. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
6-
>
6+
>
77
> 2. Recommend to use `release tag` (like `1.3.0`/`1.5.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
88
99
## 1. Deploy
@@ -12,11 +12,11 @@ We can use docker to quickly start an inner HugeGraph server with RocksDB in the
1212

1313
1. Using docker run
1414

15-
Use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.3.0` to start hugegraph server.
15+
Use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.3.0` to start hugegraph server.
1616

1717
2. Using docker compose
1818

19-
Certainly we can only deploy server without other instance. Additionally, if we want to manage other HugeGraph-related instances with `server` in a single file, we can deploy HugeGraph-related instances via `docker-compose up -d`. The `docker-compose.yaml` is as below:
19+
Certainly we can only deploy server without other instance. Additionally, if we want to manage other HugeGraph-related instances with `server` in a single file, we can deploy HugeGraph-related instances via `docker-compose up -d`. The `docker-compose.yaml` is as below:
2020

2121
```yaml
2222
version: '3'
@@ -35,12 +35,12 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
3535

3636
1. Using docker run
3737

38-
Use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true -v /path/to/script:/hugegraph-server/scripts/example.groovy hugegraph/hugegraph:1.3.0`
39-
to start hugegraph server.
38+
Use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true -v /path/to/script:/hugegraph-server/scripts/example.groovy hugegraph/hugegraph:1.3.0`
39+
to start hugegraph server.
4040

41-
2. Using docker compose
41+
2. Using docker compose
4242

43-
We can also use `docker-compose up -d` to quickly start. The `docker-compose.yaml` is below. [example.groovy](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy) is a pre-defined script. If needed, we can mount a new `example.groovy` to preload different data:
43+
We can also use `docker-compose up -d` to quickly start. The `docker-compose.yaml` is below. [example.groovy](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/src/assembly/static/scripts/example.groovy) is a pre-defined script. If needed, we can mount a new `example.groovy` to preload different data:
4444

4545
```yaml
4646
version: '3'
@@ -57,17 +57,17 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
5757

5858
3. Using start-hugegraph.sh
5959

60-
If you deploy HugeGraph server without docker, you can also pass arguments using `-p`, like this: `bin/start-hugegraph.sh -p true`.
60+
If you deploy HugeGraph server without docker, you can also pass arguments using `-p`, like this: `bin/start-hugegraph.sh -p true`.
6161

6262
## 3. Enable Authentication
6363

6464
1. Using docker run
6565

66-
Use `docker run -itd --name=graph -p 8080:8080 -e AUTH=true -e PASSWORD=123456 hugegraph/hugegraph:1.3.0` to enable the authentication and set the password with `-e AUTH=true -e PASSWORD=123456`.
66+
Use `docker run -itd --name=graph -p 8080:8080 -e AUTH=true -e PASSWORD=xxx hugegraph/hugegraph:1.3.0` to enable the authentication and set the password with `-e AUTH=true -e PASSWORD=xxx`.
6767

6868
2. Using docker compose
6969

70-
Similarly, we can set the environment variables in the docker-compose.yaml:
70+
Similarly, we can set the environment variables in the docker-compose.yaml:
7171

7272
```yaml
7373
version: '3'
@@ -79,37 +79,38 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
7979
- 8080:8080
8080
environment:
8181
- AUTH=true
82-
- PASSWORD=123456
82+
- PASSWORD=xxx
8383
```
8484

8585
## 4. Running Open-Telemetry-Collector
8686

8787
> CAUTION:
88-
>
88+
>
8989
> The `docker-compose-trace.yaml` utilizes `Grafana` and `Grafana-Tempo`, both of them are licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.en.html), you should be aware of and use them with caution. Currently, we mainly provide this template for everyone to **test**
9090
>
91+
9192
1. Start Open-Telemetry-Collector
9293

9394
```bash
9495
cd hugegraph-server/hugegraph-dist/docker/example
9596
docker-compose -f docker-compose-trace.yaml -p hugegraph-trace up -d
9697
```
97-
98+
9899
2. Active Open-Telemetry-Agent
99100

100101
```bash
101102
./start-hugegraph.sh -y true
102103
```
103-
104+
104105
3. Stop Open-Telemetry-Collector
105106

106107
```bash
107108
cd hugegraph-server/hugegraph-dist/docker/example
108109
docker-compose -f docker-compose-trace.yaml -p hugegraph-trace stop
109110
```
110-
111+
111112
4. References
112113

113-
- [What is OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/)
114+
- [What is OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/)
114115

115-
- [Tempo in Grafana](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/)
116+
- [Tempo in Grafana](https://grafana.com/docs/tempo/latest/getting-started/tempo-in-grafana/)

0 commit comments

Comments
 (0)