This is an automated email from the ASF dual-hosted git repository. jin pushed a commit to branch fix-docker in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
commit 68ac0f0a57d0f7a74790b2d7bf8b448aaed88e04 Author: imbajin <[email protected]> AuthorDate: Mon Dec 9 12:47:15 2024 +0800 fix: update image desc for all modules --- content/cn/docs/config/config-authentication.md | 4 ++-- content/cn/docs/quickstart/hugegraph-hubble.md | 6 +++--- content/cn/docs/quickstart/hugegraph-loader.md | 8 ++++---- content/cn/docs/quickstart/hugegraph-server.md | 12 ++++++------ content/en/docs/config/config-authentication.md | 8 ++++---- content/en/docs/quickstart/hugegraph-hubble.md | 6 +++--- content/en/docs/quickstart/hugegraph-loader.md | 6 +++--- content/en/docs/quickstart/hugegraph-server.md | 16 ++++++++-------- 8 files changed, 33 insertions(+), 33 deletions(-) diff --git a/content/cn/docs/config/config-authentication.md b/content/cn/docs/config/config-authentication.md index ac50e233..7e8f28f4 100644 --- a/content/cn/docs/config/config-authentication.md +++ b/content/cn/docs/config/config-authentication.md @@ -123,7 +123,7 @@ bin/start-hugegraph.sh 在 `docker run` 中添加环境变量 `PASSWORD=123456`（密码可以自由设置）即可开启鉴权模式：： ```bash -docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.2.0 +docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.3.0 ``` #### 2. 采用 docker-compose @@ -134,7 +134,7 @@ docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegrap version: '3' services: server: - image: hugegraph/hugegraph:1.2.0 + image: hugegraph/hugegraph:1.3.0 container_name: server ports: - 8080:8080 diff --git a/content/cn/docs/quickstart/hugegraph-hubble.md b/content/cn/docs/quickstart/hugegraph-hubble.md index b27bd4fc..6c8d58b0 100644 --- a/content/cn/docs/quickstart/hugegraph-hubble.md +++ b/content/cn/docs/quickstart/hugegraph-hubble.md @@ -53,7 +53,7 @@ weight: 3 > > 若 hubble 和 server 在同一 docker 网络下，**推荐**直接使用`container_name` (如下例的 `server`) > 作为主机名。或者也可以使用 **宿主机 IP** 作为主机名，此时端口号为宿主机给 server 配置的端口 -我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble). +我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble:1.3.0` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble). 或者使用 docker-compose 启动 hubble，另外如果 hubble 和 server 在同一个 docker 网络下，可以使用 server 的 contain_name 进行访问，而不需要宿主机的 ip @@ -63,13 +63,13 @@ weight: 3 version: '3' services: server: - image: hugegraph/hugegraph + image: hugegraph/hugegraph:1.3.0 container_name: server ports: - 8080:8080 hubble: - image: hugegraph/hubble + image: hugegraph/hubble:1.3.0 container_name: hubble ports: - 8088:8088 diff --git a/content/cn/docs/quickstart/hugegraph-loader.md b/content/cn/docs/quickstart/hugegraph-loader.md index ed533d44..dee0d000 100644 --- a/content/cn/docs/quickstart/hugegraph-loader.md +++ b/content/cn/docs/quickstart/hugegraph-loader.md @@ -31,7 +31,7 @@ HugeGraph-Loader 是 HugeGraph 的数据导入组件，能够将多种数据源 #### 2.1 使用 Docker 镜像 (便于**测试**) -我们可以使用 `docker run -itd --name loader hugegraph/loader`部署 loader 服务。对于需要加载的数据，则可以通过挂载 `-v /path/to/data/file:/loader/file` 或者`docker cp`的方式将文件复制到 loader 容器内部。 +我们可以使用 `docker run -itd --name loader hugegraph/loader:1.3.0`部署 loader 服务。对于需要加载的数据，则可以通过挂载 `-v /path/to/data/file:/loader/file` 或者`docker cp`的方式将文件复制到 loader 容器内部。 或者使用 docker-compose 启动 loader, 启动命令为 `docker-compose up -d`, 样例的 docker-compose.yml 如下所示： @@ -40,19 +40,19 @@ version: '3' services: server: - image: hugegraph/hugegraph + image: hugegraph/hugegraph:1.3.0 container_name: server ports: - 8080:8080 hubble: - image: hugegraph/hubble + image: hugegraph/hubble:1.3.0 container_name: hubble ports: - 8088:8088 loader: - image: hugegraph/loader + image: hugegraph/loader:1.3.0 container_name: loader # mount your own data here # volumes: diff --git a/content/cn/docs/quickstart/hugegraph-server.md b/content/cn/docs/quickstart/hugegraph-server.md index bf911176..5b406f9b 100644 --- a/content/cn/docs/quickstart/hugegraph-server.md +++ b/content/cn/docs/quickstart/hugegraph-server.md @@ -39,12 +39,12 @@ Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存 可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/README.md)。 -我们可以使用 `docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`. +我们可以使用 `docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph:1.3.0` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`. 可选项： 1. 可以使用 `docker exec -it server bash` 进入容器完成一些操作 -2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph` 在启动的时候预加载一个**内置的**样例图。可以通过 `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) +2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.3.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) 3. 可以使用 `-e PASSWORD=123456` 设置是否开启鉴权模式以及 admin 的密码，具体步骤可以参考 [Config Authentication](/cn/docs/config/config-authentication#使用-docker-时开启鉴权模式) 如果使用 docker desktop，则可以按照如下的方式设置可选项： @@ -59,7 +59,7 @@ Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存 version: '3' services: server: - image: hugegraph/hugegraph + image: hugegraph/hugegraph:1.3.0 container_name: server # environment: # - PRELOAD=true 为可选参数，为 True 时可以在启动的时候预加载一个内置的样例图 @@ -72,7 +72,7 @@ services: > > 1. hugegraph 的 docker 镜像是一个便捷版本，用于快速启动 hugegraph，并不是**官方发布物料包方式**。你可以从 [ASF > Release Distribution > Policy](https://infra.apache.org/release-distribution.html#dockerhub) > 中得到更多细节。 > -> 2. 推荐使用 `release tag`(如 `1.3.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。 +> 2. 推荐使用 `release tag`(如 `1.3.0/1.5.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。 #### 3.2 下载 tar 包 @@ -516,7 +516,7 @@ volumes: 1. 使用`docker run` - 使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:latest` + 使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:1.3.0` 2. 使用`docker-compose` @@ -526,7 +526,7 @@ volumes: version: '3' services: server: - image: hugegraph/hugegraph:latest + image: hugegraph/hugegraph:1.3.0 container_name: server environment: - PRELOAD=true diff --git a/content/en/docs/config/config-authentication.md b/content/en/docs/config/config-authentication.md index 9d4c1822..512c63df 100644 --- a/content/en/docs/config/config-authentication.md +++ b/content/en/docs/config/config-authentication.md @@ -26,7 +26,7 @@ user(name=xx) -belong-> group(name=xx) -access(read)-> target(graph=graph1, reso By default, HugeGraph does **not enable** user authentication, and it needs to be enabled by modifying the configuration file (Note: If used in a production environment or over the internet, -please use a **Java11** version and enable **auth-system** to avoid security risks.)" +please use a **Java11** version and enable **auth-system** to avoid security risks.) You need to modify the configuration file to enable this feature. HugeGraph provides built-in authentication mode: `StandardAuthenticator`. This mode supports multi-user authentication and fine-grained permission control. Additionally, developers can implement their own `HugeAuthenticator` interface to integrate with their existing authentication systems. @@ -119,7 +119,7 @@ bin/start-hugegraph.sh ``` -### Use docker to enble authentication mode +### Use docker to enable authentication mode For versions of the hugegraph/hugegraph image equal to or greater than 1.2.0, you can enable authentication mode while starting the Docker image. @@ -130,12 +130,12 @@ The steps are as follows: To enable authentication mode, add the environment variable `PASSWORD=123456` (you can freely set the password) in the `docker run` command: ```bash -docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.2.0 +docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.3.0 ``` #### 2. Use docker-compose -Use `docker-compose` and set he environment variable `PASSWORD=123456`: +Use `docker-compose` and set the environment variable `PASSWORD=123456`: ```yaml version: '3' diff --git a/content/en/docs/quickstart/hugegraph-hubble.md b/content/en/docs/quickstart/hugegraph-hubble.md index 13fb48d7..76d02021 100644 --- a/content/en/docs/quickstart/hugegraph-hubble.md +++ b/content/en/docs/quickstart/hugegraph-hubble.md @@ -64,7 +64,7 @@ There are three ways to deploy `hugegraph-hubble` > > If `hubble` and `server` is in the same docker network, we **recommend** > using the `container_name` (in our example, it is `server`) as the hostname, > and `8080` as the port. Or you can use the **host IP** as the hostname, and > the port is configured by the host for the server. -We can use `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` to quick start [hubble](https://hub.docker.com/r/hugegraph/hubble). +We can use `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble:1.3.0` to quick start [hubble](https://hub.docker.com/r/hugegraph/hubble). Alternatively, you can use Docker Compose to start `hubble`. Additionally, if `hubble` and the graph are in the same Docker network, you can access the graph using the container name of the graph, eliminating the need for the host machine's IP address. @@ -74,13 +74,13 @@ Use `docker-compose up -d`，`docker-compose.yml` is following: version: '3' services: server: - image: hugegraph/hugegraph + image: hugegraph/hugegraph:1.3.0 container_name: server ports: - 8080:8080 hubble: - image: hugegraph/hubble + image: hugegraph/hubble:1.3.0 container_name: hubble ports: - 8088:8088 diff --git a/content/en/docs/quickstart/hugegraph-loader.md b/content/en/docs/quickstart/hugegraph-loader.md index 02ba802c..36189057 100644 --- a/content/en/docs/quickstart/hugegraph-loader.md +++ b/content/en/docs/quickstart/hugegraph-loader.md @@ -29,7 +29,7 @@ There are two ways to get HugeGraph-Loader: #### 2.1 Use Docker image (Convenient for Test/Dev) -We can deploy the loader service using `docker run -itd --name loader hugegraph/loader`. For the data that needs to be loaded, it can be copied into the loader container either by mounting `-v /path/to/data/file:/loader/file` or by using `docker cp`. +We can deploy the loader service using `docker run -itd --name loader hugegraph/loader:1.3.0`. For the data that needs to be loaded, it can be copied into the loader container either by mounting `-v /path/to/data/file:/loader/file` or by using `docker cp`. Alternatively, to start the loader using docker-compose, the command is `docker-compose up -d`. An example of the docker-compose.yml is as follows: @@ -38,13 +38,13 @@ version: '3' services: server: - image: hugegraph/hugegraph + image: hugegraph/hugegraph:1.3.0 container_name: server ports: - 8080:8080 loader: - image: hugegraph/loader + image: hugegraph/loader:1.3.0 container_name: loader # mount your own data here # volumes: diff --git a/content/en/docs/quickstart/hugegraph-server.md b/content/en/docs/quickstart/hugegraph-server.md index 5b4f06ba..75d914e3 100644 --- a/content/en/docs/quickstart/hugegraph-server.md +++ b/content/en/docs/quickstart/hugegraph-server.md @@ -19,7 +19,7 @@ The Core Module is an implementation of the Tinkerpop interface; The Backend mod #### 2.1 Install Java 11 (JDK 11) -Consider using Java 11 to run `HugeGraph-Server` (compatible with Java 8 before 1.5.0), +You need to use Java 11 to run `HugeGraph-Server` (compatible with Java 8 before 1.5.0, but not recommended to use), and configure by yourself. **Be sure to execute the `java -version` command to check the jdk version before reading** @@ -42,12 +42,12 @@ There are four ways to deploy HugeGraph-Server components: <!-- 3.1 is linked by another place. if change 3.1's title, please check --> You can refer to [Docker deployment guide](https://hub.docker.com/r/hugegraph/hugegraph). -We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to quickly start an inner `HugeGraph server` with `RocksDB` in background. +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 background. Optional: 1. use `docker exec -it graph bash` to enter the container to do some operations. -2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph` 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) -3. use `-e PASSWORD=123456` to enable auth mode and set the passoword for admin. You cna find more details from [Config Authentication](/docs/config/config-authentication#Use-docker-to-enble-authentication-mode) +2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.3.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) +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) If you use docker desktop, you can set the option like: <div style="text-align: center;"> @@ -60,7 +60,7 @@ Also, if we want to manage the other Hugegraph related instances in one file, we version: '3' services: server: - image: hugegraph/hugegraph + image: hugegraph/hugegraph:1.3.0 container_name: server # environment: # - PRELOAD=true @@ -75,7 +75,7 @@ services: > > 1. The docker image of hugegraph is a convenience release to start hugegraph > quickly, but not **official distribution** artifacts. You can find more > details from [ASF Release Distribution > Policy](https://infra.apache.org/release-distribution.html#dockerhub). > -> 2. Recommand to use `release tag`(like `1.3.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. #### 3.2 Download the binary tar tarball @@ -536,7 +536,7 @@ Set the environment variable `PRELOAD=true` when starting Docker in order to loa 1. Use `docker run` - Use `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:latest` + Use `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:1.3.0` 2. Use `docker-compose` @@ -546,7 +546,7 @@ Set the environment variable `PRELOAD=true` when starting Docker in order to loa version: '3' services: server: - image: hugegraph/hugegraph:latest + image: hugegraph/hugegraph:1.3.0 container_name: server environment: - PRELOAD=true
