Skip to content

Commit

Permalink
doc: sync the en version
Browse files Browse the repository at this point in the history
  • Loading branch information
aroundabout committed Nov 1, 2023
1 parent 549854f commit 1215b98
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 20 deletions.
2 changes: 1 addition & 1 deletion content/cn/docs/config/config-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ Initialization finished.
$ ./bin/start-hugegraph.sh

Starting HugeGraphServer...
Connecting to HugeGraphServer (http://127.0.0.1:18080/graphs)...OK
Connecting to HugeGraphServer (http://127.0.0.1:8080/graphs)...OK
Started [pid 21614]
```

Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ HugeGraph 是一款面向分析型,支持批量操作的图数据库系统,

> **特别注意**: docker 模式下,若 hubble 和 server 在同一宿主机,hubble 页面中设置 graph 的 `hostname` **不能设置**`localhost/127.0.0.1`,因这会指向 hubble **容器内部**而非宿主机,导致无法连接到 server.
>
> 若 hubble 和 server 在同一 docker 网络下,**推荐**直接使用`container_name` (如下例的 `graph`)作为主机名. 或者也可以使用**宿主机IP** 作为主机名,此时端口号为宿主机给 server 配置的端口
> 若 hubble 和 server 在同一 docker 网络下,**推荐**直接使用`container_name` (如下例的 `graph`) 作为主机名。或者也可以使用 **宿主机 IP** 作为主机名,此时端口号为宿主机给 server 配置的端口
我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble).

Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ _说明_
另外也可以通过访问 `localhost:8080/swagger-ui/index.html` 查看 api。

<div style="text-align: center;">
<img src="/cn/docs/images/images-server/621swaggerui示例.png" alt="image">
<img src="/docs/images/images-server/621swaggerui示例.png" alt="image">
</div>

### 7 停止 Server
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/config/config-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ Initialization finished.
$ ./bin/start-hugegraph.sh

Starting HugeGraphServer...
Connecting to HugeGraphServer (http://127.0.0.1:18080/graphs)...OK
Connecting to HugeGraphServer (http://127.0.0.1:8080/graphs)...OK
Started [pid 21614]
```

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 10 additions & 4 deletions content/en/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ There are three ways to deplot `hugegraph-hubble`

#### 2.1 Use docker (recommended)

> **Special Note**: If you are starting `hubble` with Docker, and `hubble` and the server are on the same host. When configuring the hostname for the graph on the Hubble web page, please do not directly set it to `localhost/127.0.0.1`. This will refer to the `hubble` container internally rather than the host machine, resulting in a connection failure to the server. If `hubble` and `server` is in the same docker network, you can use the `container_name` as the hostname, and `8080` as the port. Or you can use the ip of the host as the hostname, and the port is configured by the host for the server.
> **Special Note**: If you are starting `hubble` with Docker, and `hubble` and the server are on the same host. When configuring the hostname for the graph on the Hubble web page, please do not directly set it to `localhost/127.0.0.1`. This will refer to the `hubble` container internally rather than the host machine, resulting in a connection failure to the server.
>
> If `hubble` and `server` is in the same docker network, we **recommend** using the `container_name` (in our example, it is `graph`) 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).

Expand All @@ -56,7 +58,7 @@ services:
image: hugegraph/hugegraph
container_name: graph
ports:
- 18080:8080
- 8080:8080

hubble:
image: hugegraph/hubble
Expand Down Expand Up @@ -160,12 +162,13 @@ Under the graph management module, click [Create graph], and realize the connect
</div>


Create graph by filling in the content as follows:
Create graph by filling in the content as follows:

<center>
<img src="/docs/images/images-hubble/311图创建2.png" alt="image">
</center>

> **Special Note**: If you are starting `hubble` with Docker, and `hubble` and the server are on the same host. When configuring the hostname for the graph on the Hubble web page, please do not directly set it to `localhost/127.0.0.1`. If `hubble` and `server` is in the same docker network, we **recommend** using the `container_name` (in our example, it is `graph`) 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.

##### 4.1.2 Graph Access
Realize the information access of the graph space. After entering, you can perform operations such as multidimensional query analysis, metadata management, data import, and algorithm analysis of the graph.
Expand Down Expand Up @@ -275,7 +278,7 @@ List mode:
</center>


Graph mode
Graph mode:

<center>
<img src="/docs/images/images-hubble/3241边创建2.png" alt="image">
Expand All @@ -295,6 +298,9 @@ Graph mode:
Displays vertex and edge indices for vertex types and edge types.

#### 4.3 Data Import

> **Note**:currently, we recommend to use [hugegraph-loader](/en/docs/quickstart/hugegraph-loader) to load data

The usage process of data import is as follows:

<center>
Expand Down
31 changes: 19 additions & 12 deletions content/en/docs/quickstart/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,20 @@ We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to qu

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.
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.1](http://127.0.0.1:1313/docs/quickstart/hugegraph-server/#511-create-example-graph-when-starting-server)

Also, we can use `docker-compose` to deploy, with `docker-compose up -d`. Here is an example `docker-compose.yml`:
Also, if we want to manage the other Hugegraph related instances in one file, we can use `docker-compose` to deploy, with the command `docker-compose up -d` (you can config only `server`). Here is an example `docker-compose.yml`:

```yaml
version: '3'
services:
graph:
image: hugegraph/hugegraph
#environment:
# environment:
# - PRELOAD=true
# PRELOAD is a option to preload a build-in sample graph when initializing.
ports:
- 18080:8080
- 8080:8080
```
#### 3.2 Download the binary tar tarball
Expand Down Expand Up @@ -162,11 +163,11 @@ Set the environment variable `PRELOAD=true` when starting Docker in order to loa

1. Use `docker run`

Use `docker run -itd --name=graph -p 18080:8080 -e PRELOAD=true hugegraph/hugegraph:latest`
Use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:latest`

2. Use `docker-compose`

Create `docker-compose.yml` as following
Create `docker-compose.yml` as following. We should set the environment variable `PRELOAD=true`. [`example.groovy`](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-dist/src/assembly/static/scripts/example.groovy) is a predefined script to preload the sample data. If needed, we can mount a new `example.groovy` to change the preload data.

```yaml
version: '3'
Expand All @@ -177,7 +178,7 @@ Set the environment variable `PRELOAD=true` when starting Docker in order to loa
environment:
- PRELOAD=true
ports:
- 18080:8080
- 8080:8080
```
Use `docker-compose up -d` to start the container
Expand Down Expand Up @@ -246,7 +247,7 @@ rocksdb.data_path=.
rocksdb.wal_path=.
```

Initialize the database (required only on first startup)
Initialize the database (required on first startup or a new configuration was manually added under 'conf/graphs/')

```bash
cd *hugegraph-${version}
Expand Down Expand Up @@ -288,7 +289,7 @@ cassandra.password=
#cassandra.keyspace.replication=3
```

Initialize the database (required only on first startup)
Initialize the database (required on first startup or a new configuration was manually added under 'conf/graphs/')


```bash
Expand Down Expand Up @@ -350,7 +351,7 @@ cassandra.password=

Since the scylladb database itself is an "optimized version" based on cassandra, if the user does not have scylladb installed, they can also use cassandra as the backend storage directly. They only need to change the backend and serializer to scylladb, and the host and post point to the seeds and port of the cassandra cluster. Yes, but it is not recommended to do so, it will not take advantage of scylladb itself.

Initialize the database (required only on first startup)
Initialize the database (required on first startup or a new configuration was manually added under 'conf/graphs/')

```bash
cd *hugegraph-${version}
Expand Down Expand Up @@ -390,7 +391,7 @@ hbase.port=2181
#hbase.edge_partitions=30
```

Initialize the database (required only on first startup)
Initialize the database (required on first startup or a new configuration was manually added under 'conf/graphs/')

```bash
cd *hugegraph-${version}
Expand Down Expand Up @@ -436,7 +437,7 @@ jdbc.reconnect_interval=3
jdbc.ssl_mode=false
```

Initialize the database (required only on first startup)
Initialize the database (required on first startup or a new configuration was manually added under 'conf/graphs/')

```bash
cd *hugegraph-${version}
Expand Down Expand Up @@ -580,6 +581,12 @@ response body:

For detailed API, please refer to [RESTful-API](/docs/clients/restful-api)

You can also visit `localhost:8080/swagger-ui/index.html` to check the api.

<div style="text-align: center;">
<img src="/docs/images/images-server/621swaggerui示例.png" alt="image">
</div>

### 7 Stop Server

```bash
Expand Down

0 comments on commit 1215b98

Please sign in to comment.