Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docker): update server image desc #2702

Merged
merged 1 commit into from
Dec 9, 2024
+10 −9
Merged

fix(docker): update server image desc #2702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful

### 1. Docker Way (Convenient for Test)

We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to quickly start an inner
We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph:1.3.0` to quickly start an inner
HugeGraph server with `RocksDB` (in backgrounds) for **test/dev**.
You can visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or
the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example))
Expand All @@ -43,7 +43,7 @@ the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details.
>
> 1. The docker image of hugegraph is a convenience release, but not **official distribution** artifacts. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub).
>
> 2. Recommend to use `release tag` (like `1.5.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
> 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.

### 2. Download Way

Expand Down
15 changes: 8 additions & 7 deletions hugegraph-server/hugegraph-dist/docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
>
> 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).
>
> 2. Recommend to use `release tag` (like `1.5.0`) for the stable version. Use `latest` tag to experience the newest functions in development.
> 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.

## 1. Deploy

We can use docker to quickly start an inner HugeGraph server with RocksDB in the background.

1. Using docker run

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

2. Using docker compose

Expand All @@ -22,7 +22,7 @@ We can use docker to quickly start an inner HugeGraph server with RocksDB in the
version: '3'
services:
graph:
image: hugegraph/hugegraph
image: hugegraph/hugegraph:1.3.0
ports:
- 8080:8080
```
Expand All @@ -35,7 +35,7 @@ If you want to customize the preloaded data, please mount the groovy scripts (no

1. Using docker run

Use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true -v /path/to/script:/hugegraph-server/scripts/example.groovy hugegraph/hugegraph`
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`
to start hugegraph server.

2. Using docker compose
Expand All @@ -46,7 +46,7 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
version: '3'
services:
graph:
image: hugegraph/hugegraph
image: hugegraph/hugegraph:1.3.0
environment:
- PRELOAD=true
volumes:
Expand All @@ -63,7 +63,7 @@ If you want to customize the preloaded data, please mount the groovy scripts (no

1. Using docker run

Use `docker run -itd --name=graph -p 8080:8080 -e AUTH=true -e PASSWORD=123456 hugegraph/hugegraph` to enable the authentication and set the password with `-e AUTH=true -e PASSWORD=123456`.
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`.

2. Using docker compose

Expand All @@ -73,14 +73,15 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
version: '3'
services:
server:
image: hugegraph/hugegraph
image: hugegraph/hugegraph:1.3.0
container_name: graph
ports:
- 8080:8080
environment:
- AUTH=true
- PASSWORD=123456
```

## 4. Running Open-Telemetry-Collector

> CAUTION:
Expand Down
Loading