Skip to content

Commit

Permalink
fix #315: revise the ports and volumes description of the docker in t…
Browse files Browse the repository at this point in the history
…he docs (#376)

* revise docker doc

* add volume desc

* add alert
  • Loading branch information
qishipengqsp authored Jan 12, 2024
1 parent 85fd6d6 commit bf14747
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 27 deletions.
31 changes: 18 additions & 13 deletions docs/en-US/source/3.quick-start/1.preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,22 +64,27 @@ TuGraph can be installed quickly via Docker Image or locally via RPM /deb packag
3. Start docker

```shell
docker run -d -p 7070:7070 -p 9090:9090 -p 7687:7687 --name tugraph_demo tugraph/tugraph-runtime-centos7 lgraph_server
# 7070 is default http port,for web accessing.
# 9090 is default RPC port,for RPC client accessing.
docker run -it -d -p 7001:7001 -p 7070:7070 -p 7687:7687 -p 8000:8000 -p 8888:8888 -p 8889:8889 -p 9090:9090 \
-v /root/tugraph/data:/var/lib/lgraph/data -v /root/tugraph/log:/var/log/lgraph_log \
--name tugraph_demo tugraph/tugraph-runtime-centos7:${VERSION} /bin/bash
docker exec -d tugraph_demo bash /setup.sh
# 7001 is default http port,for tugraph-db-browser accessing.
# 7070 is default http port,for legacy tugraph-web accessing.
# 7687 is bolt port, for neo4j client accessing.
# 9090 is default RPC port,for RPC client accessing.
# The default data directory is /var/lib/lgraph/data and the default log directory is /var/log/lgraph_log,
# which is configured in the tugraph configuration file at /usr/local/etc/lgraph.json inside the docker.
# This command mounts the data directory and log directory to /root/tugraph/ on the host for persistence,
# which you can modify according to your actual situation.
```

4. Open by browser

`http://x.x.x.x:7070`
Accessing tugraph-db-browser: `http://x.x.x.x:7001`. Default account is `admin` and default password is `73@TuGraph`.
The page will be redirected to the password modification page for the first login. Please modify the password according to the page prompt.

> Default account `admin`,Default password `73@TuGraph`

5. Start
```shell
docker run -dt -p 7070:7070 -p 9090:9090 -p 7687:7687 --name tugraph_demo tugraph/tugraph-runtime-centos7
docker exec -it tugraph_demo bash
# start the service
lgraph_server -d start
```
**Note**:
Access `http://x.x.x.x:7070` if you want to access legacy tugraph-web, with default account `admin` and default password `73@TuGraph`.
But please note that legacy web is no longer maintained, it is recommended to use tugraph-db-browser.
32 changes: 18 additions & 14 deletions docs/zh-CN/source/3.quick-start/1.preparation.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,22 +63,26 @@ TuGraph 可以通过 Docker Image 快速安装,或者通过 rpm/deb 包本地

3. 启动docker
```shell
docker run -d -p 7070:7070 -p 9090:9090 -p 7687:7687 --name tugraph_demo tugraph/tugraph-runtime-centos7 lgraph_server
# 7070是默认的http端口,web访问使用。
docker run -it -d -p 7001:7001 -p 7070:7070 -p 7687:7687 -p 8000:8000 -p 8888:8888 -p 8889:8889 -p 9090:9090 \
-v /root/tugraph/data:/var/lib/lgraph/data -v /root/tugraph/log:/var/log/lgraph_log \
--name tugraph_demo tugraph/tugraph-runtime-centos7:${VERSION} /bin/bash
docker exec -d tugraph_demo bash /setup.sh
# 7001是默认的http端口,访问tugraph-db-browser使用。
# 7070是默认的http端口,访问legacy tugraph-web访问使用。
# 7687是bolt端口,bolt client访问使用。
# 9090是默认的rpc端口,rpc client访问使用。
# 7687是bolt端口,neo4j client访问使用。
# 根据/usr/local/etc/lgraph.json的tugraph启动的默认配置,
# /var/lib/lgraph/data是容器内的默认数据目录,/var/log/lgraph_log是容器内的默认日志目录
# 命令将数据目录和日志目录挂载到了宿主机的/root/tugraph/上进行持久化,您可以根据实际情况修改。
```

4. web 访问
4. 前端访问

`http://x.x.x.x:7070`
访问tugraph-db-browser: `http://x.x.x.x:7001`,默认用户名为 `admin`,密码为 `73@TuGraph`
首次登录会默认跳转修改密码页面,请尽快修改默认密码避免安全风险。

> 默认用户名为 `admin`,密码为 `73@TuGraph`

5. 手动启动方式
```shell
docker run -dt -p 7070:7070 -p 9090:9090 -p 7687:7687 --name tugraph_demo tugraph/tugraph-runtime-centos7
docker exec -it tugraph_demo bash
# 进入docker环境后执行如下命令启动服务
lgraph_server -d start
```
**注意**
如果需要使用legacy tugraph-web,访问`http://x.x.x.x:7070`,默认用户名为 `admin`,密码为 `73@TuGraph`
但请注意,legacy web是不再维护的版本,建议使用tugraph-db-browser。

0 comments on commit bf14747

Please sign in to comment.