You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: hugegraph-server/hugegraph-dist/docker/README.md
+19-18Lines changed: 19 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# Deploy Hugegraph server with docker
2
2
3
3
> Note:
4
-
>
4
+
>
5
5
> 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
+
>
7
7
> 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.
8
8
9
9
## 1. Deploy
@@ -12,11 +12,11 @@ We can use docker to quickly start an inner HugeGraph server with RocksDB in the
12
12
13
13
1. Using docker run
14
14
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.
16
16
17
17
2. Using docker compose
18
18
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:
20
20
21
21
```yaml
22
22
version: '3'
@@ -35,12 +35,12 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
35
35
36
36
1. Using docker run
37
37
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.
40
40
41
-
2. Using docker compose
41
+
2. Using docker compose
42
42
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:
44
44
45
45
```yaml
46
46
version: '3'
@@ -57,17 +57,17 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
57
57
58
58
3. Using start-hugegraph.sh
59
59
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`.
61
61
62
62
## 3. Enable Authentication
63
63
64
64
1. Using docker run
65
65
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`.
67
67
68
68
2. Using docker compose
69
69
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:
71
71
72
72
```yaml
73
73
version: '3'
@@ -79,37 +79,38 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
79
79
- 8080:8080
80
80
environment:
81
81
- AUTH=true
82
-
- PASSWORD=123456
82
+
- PASSWORD=xxx
83
83
```
84
84
85
85
## 4. Running Open-Telemetry-Collector
86
86
87
87
> CAUTION:
88
-
>
88
+
>
89
89
> 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**
90
90
>
91
+
91
92
1. Start Open-Telemetry-Collector
92
93
93
94
```bash
94
95
cd hugegraph-server/hugegraph-dist/docker/example
95
96
docker-compose -f docker-compose-trace.yaml -p hugegraph-trace up -d
0 commit comments