Skip to content

doc(docker): add docker usage into README files; add a docker-compose file #1

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

doc(docker): add docker usage into README files; add a docker-compose file #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
879a31b
doc(docker): add docker usage into README files; add a docker-compose…
Ethereal-O Jun 18, 2025
5c264eb
Update vermeer/docker-compose.yaml
Ethereal-O Jun 20, 2025
217adc3
Update vermeer/README.md
Ethereal-O Jun 20, 2025
c31bec7
Update vermeer/README.zh-CN.md
Ethereal-O Jun 20, 2025
f41ca5c
Update docker-compose.yaml
Ethereal-O Jun 20, 2025
f4c96d9
Update README.zh-CN.md
Ethereal-O Jun 20, 2025
a3839cb
Update README.md
Ethereal-O Jun 20, 2025
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
22 changes: 22 additions & 0 deletions vermeer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@
## Introduction
Vermeer is a high-performance distributed graph computing platform based on memory, supporting more than 15 graph algorithms, custom algorithm extensions, and custom data source access.

## Run with Docker

Pull the image:
```
docker pull hugegraph/vermeer:latest
```

Create local configuration files, for example, `${HOME}/master.ini` and `${HOME}/worker.ini`.

Run with Docker. The `--env` flag specifies the file name.

```
master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master
worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker
Comment on lines +18 to +19
Copy link

@coderabbitai coderabbitai bot Jul 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Volume mount scope & env naming inconsistency

  • Mounting the entire ${HOME} directory may leak unrelated files; limit the mount to a dedicated config folder, e.g. ${HOME}/vermeer_conf:/go/bin/config.
  • The example uses --env=worker, whereas later in the README it switches to --env=worker01. Align the examples to avoid confusion.

请运行以下脚本以确认 vermeer/README.md 中的 docker run 示例及 --env 参数用法是否一致：

🏁 Script executed:

#!/bin/bash
# 查找 docker run 挂载示例
grep -n "docker run" vermeer/README.md

# 查找所有 --env 参数用法
grep -n -- "--env=" vermeer/README.md

Length of output: 468

请限制 Docker 挂载范围并统一 --env 参数

为了避免泄露不相关文件，并消除示例中的命名混淆，请在 vermeer/README.md 中做如下调整：

• 将第 18–19 行的挂载路径

- docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master
- docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker
+ docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=master
+ docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=worker

改为只挂载专用配置目录 ${HOME}/vermeer_conf。

• 将第 32 行的 --env=worker01 改为与前面一致的 --env=worker，或反之全局统一为 worker01：

- worker: ./vermeer --env=worker01
+ worker: ./vermeer --env=worker
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master
worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker
master: docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=master
worker: docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=worker
worker: ./vermeer --env=worker
🤖 Prompt for AI Agents 
In vermeer/README.md at lines 18 to 19, change the Docker volume mount path from
the broad ${HOME}/ to a more restricted directory ${HOME}/vermeer_conf to limit
file exposure. Also, ensure the --env parameter is consistent by changing the
value at line 32 from --env=worker01 to --env=worker, matching the earlier
usage, or alternatively update all occurrences to use worker01 for uniformity.

```

We've also provided a `docker-compose` file. Once you've created `${HOME}/master.ini` and `${HOME}/worker.ini`, and updated the `master_peer` in `worker.ini` to `172.20.0.10:6689`, you can run it using the following command:

```
docker-compose up -d
```

## Start

```
Expand Down
20 changes: 20 additions & 0 deletions vermeer/README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@
## 简介
Vermeer是一个基于内存的高性能分布式图计算平台，支持15+图算法。支持自定义算法扩展，支持自定义数据源接入。

## 基于 Docker 运行

拉取镜像
```
docker pull hugegraph/vermeer:latest
```

创建好本地配置文件，例如`${HOME}/master.ini`与`${HOME}/worker.ini`

基于docker运行，其中`--env`指定的是文件名称。
```
master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master
worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker
Comment on lines +17 to +18
Copy link

@coderabbitai coderabbitai bot Jul 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

挂载路径过宽且示例与后文 env 不一致

  1. -v ${HOME}/:/go/bin/config 会把整个用户主目录暴露到容器，风险较大，建议仅挂载配置目录，例如 ${HOME}/vermeer_conf:/go/bin/config。
  2. 这里的 --env=worker 与下方 “运行” 小节中的 --env=worker01 不一致，容易造成混淆，请统一命名。

下面运行脚本验证 vermeer/README.zh-CN.md 中的挂载路径和 --env 参数是否如评论中所述不一致：

🏁 Script executed:

#!/usr/bin/env bash
# 查找挂载 HOME 目录的命令
rg -n -- '-v \$\{HOME\}/' vermeer/README.zh-CN.md

# 查找所有 --env 标志及其参数
rg -n -- '--env' vermeer/README.zh-CN.md

Length of output: 515

请修正 README 示例的挂载路径和 --env 参数一致性

  • 挂载路径过宽：第 17–18 行使用 -v ${HOME}/:/go/bin/config 会暴露整个用户主目录，建议改为仅挂载配置目录，例如 
    docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=master
docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=worker
  • 参数命名不统一：第 18 行 Docker 示例中使用 --env=worker，而第 30 行原生运行示例使用 --env=worker01，容易混淆。请统一为同一标识（如都用 worker01 或都用 worker），并同步更新所有示例。
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

17-17: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents 
In vermeer/README.zh-CN.md around lines 17 to 18, update the Docker run commands
to mount only the specific configuration directory instead of the entire home
directory by changing the volume mount from '-v ${HOME}/:/go/bin/config' to '-v
${HOME}/vermeer_conf:/go/bin/config'. Also, ensure the '--env' parameter is
consistent across all examples by using the same identifier (either 'worker' or
'worker01') in both lines and update all related examples accordingly.

```

我们也提供了`docker-compose`文件，当创建好`${HOME}/master.ini`与`${HOME}/worker.ini`，将`worker.ini`中的`master_peer`修改为`172.20.0.10:6689`后，即可通过以下命令运行：
```
docker-compose up -d
```

## 运行

```
Expand Down
29 changes: 29 additions & 0 deletions vermeer/docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
version: '3.8'

services:
vermeer-master:
image: hugegraph/vermeer
container_name: vermeer-master
volumes:
- ${HOME}/:/go/bin/config # Change here to your actual config path
command: --env=master
networks:
vermeer_network:
ipv4_address: 172.20.0.10 # Assign a static IP for the master

vermeer-worker:
image: hugegraph/vermeer
container_name: vermeer-worker
volumes:
- ${HOME}/:/go/bin/config # Change here to your actual config path
command: --env=worker
networks:
vermeer_network:
ipv4_address: 172.20.0.11 # Assign a static IP for the worker

networks:
vermeer_network:
driver: bridge
ipam:
config:
- subnet: 172.20.0.0/24 # Define the subnet for your network
Loading