Update st-ug-deploy.md (#997)

* Update st-ug-deploy.md * Update st-ug-deploy.md
vesoft-inc · Sep 24, 2021 · 512ea1b · 512ea1b
1 parent 5464083
commit 512ea1b
Showing 1 changed file with 89 additions and 89 deletions.
diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
@@ -9,89 +9,6 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云
 
     用户也可以在 [Studio](https://playground.nebula-graph.com.cn/explore) 在线试用部分功能。
 
-## Docker 部署 Studio
-### 前提条件
-
-在部署 Docker 版 Studio 之前，用户需要确认以下信息：
-
-- Nebula Graph 服务已经部署并启动。详细信息，参考[Nebula Graph安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。
-
-- 在即将运行 Docker 版 Studio 的机器上安装并启动 Docker Compose。详细信息参考 [Docker Compose 文档](https://docs.docker.com/compose/install/ "点击前往 Docker 文档中心")。
-- 确保在安装开始前，以下端口处于未被使用状态。
-
-   | 端口号 | 说明 |
-   | ---- | ---- |
-   | 7001 | Studio提供的web服务 |
-   | 8080 | Nebula-http-gateway，Client的HTTP服务 |
-   | 5699 | Nebula importer文件导入工具，数据导入服务 |
-
-- （可选）在中国大陆从 Docker Hub 拉取 Docker 镜像的速度可能比较慢，用户可以使用 `registry-mirrors` 参数配置加速镜像。例如，如果要使用 Docker 中国区官方镜像、网易镜像和中国科技大学的镜像，则按以下格式配置 `registry-mirrors` 参数：
-
-   ```json
-   {
-   "registry-mirrors": [
-     "https://registry.docker-cn.com",
-     "http://hub-mirror.c.163.com",
-     "https://docker.mirrors.ustc.edu.cn"
-     ]
-   }
-   ```
-
-   配置文件的路径和方法因操作系统和/或 Docker Desktop 版本而异。详细信息参考 [Docker Daemon 配置文档](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file "点击前往 Docker 文档中心")。
-
-### 操作步骤
-
-在命令行工具中按以下步骤依次运行命令，部署并启动 Docker 版 Studio，这里我们用 Nebula Graph 版本为 2.5 的进行演示：
-
-1. 下载 Studio 的部署配置文件。
-
-   | 安装包 | Nebula Graph版本 |
-   | ----- | ----- |
-   | [nebula-graph-studio-v3.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/nebula-graph-studio-v3.tar.gz) | 2.5.0 |
-
-2. 创建`nebula-graph-studio-v3`目录，并将安装包解压至目录中。
-
-   ```bash
-   mkdir nebula-graph-studio-v3 && tar -zxvf nebula-graph-studio-v3.tar.gz -C nebula-graph-studio-v3
-   ```
-
-3. 解压后进入 `nebula-graph-studio-v3` 目录。
-
-   ```bash
-   cd nebula-graph-studio-v3
-   ```
-
-4. 拉取 Studio 的 Docker 镜像。
-
-   ```bash
-   docker-compose pull
-   ```
-
-5. 构建并启动 Studio 服务。其中，`-d` 表示在后台运行服务容器。
-
-   ```bash
-   docker-compose up -d
-   ```
-
-   当屏幕返回以下信息时，表示 Docker 版 Studio 已经成功启动。
-
-   ```bash
-   Creating docker_importer_1 ... done
-   Creating docker_client_1   ... done
-   Creating docker_web_1      ... done
-   Creating docker_nginx_1    ... done
-   ```
-
-6. 启动成功后，在浏览器地址栏输入 `http://ip address:7001`。
-
-  !!! Note
-
-        在运行 Docker 版 Studio 的机器上，用户可以运行 `ifconfig` 或者 `ipconfig` 获取本机 IP 地址。如果使用这台机器访问 Studio，可以在浏览器地址栏里输入 `http://localhost:7001`。
-
-   如果在浏览器窗口中能看到以下登录界面，表示已经成功部署并启动 Studio。
-
-   ![Nebula Graph Studio 登录界面](../figs/st-ug-001-1.png "Nebula Graph Studio 登录界面")
-
 ## RPM 部署 Studio
 
 ### 前提条件
@@ -126,14 +43,14 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云
 
    | 安装包 | 检验和 | Nebula版本 |
    | ----- | ----- | ----- |
-   | [nebula-graph-studio-3.0.0-1.x86_64.rpm](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/3.0.0/nebula-graph-studio-3.0.0-1.x86_64.rpm) |  [nebula-graph-studio-3.0.0-1.x86_64.rpm.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/3.0.0/nebula-graph-studio-3.0.0-1.x86_64.rpm.sha256) | 2.5.0 |
+   | [nebula-graph-studio-{{studio.release}}-1.x86_64.rpm](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.rpm) |  [nebula-graph-studio-{{studio.release}}-1.x86_64.rpm.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.rpm.sha256) | {{ nebula.release }} |
 
 2. 使用`sudo rpm -i <rpm>`命令安装RPM包。
 
-   例如，安装Studio 3.0.0 版本需要运行以下命令：
+   例如，安装Studio {{studio.release}} 版本需要运行以下命令：
 
    ```bash
-   $ sudo rpm -i nebula-graph-studio-3.0.0-1.x86_64.rpm
+   $ sudo rpm -i nebula-graph-studio-{{studio.release}}-1.x86_64.rpm
    ```
 
    当屏幕返回以下信息时，表示 PRM 版 Studio 已经成功启动。
@@ -157,7 +74,7 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云
 用户可以使用以下的命令卸载 Studio。
 
 ```bash
-$ sudo rpm -e nebula-graph-studio-3.0.0-1.x86_64
+$ sudo rpm -e nebula-graph-studio-{{studio.release}}-1.x86_64
 ```
 
 ### 异常处理
@@ -222,12 +139,12 @@ $ npm run start
 
    | 安装包 | Studio 版本 |
    | --- | --- |
-   | [nebula-graph-studio-3.0.0-1.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/3.0.0/nebula-graph-studio-3.0.0-1.x86_64.tar.gz) | 3.0.0 |
+   | [nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz) | {{studio.release}} |
 
 2. 使用 `tar -xvf` 解压 tar 包。
 
    ```bash
-   tar -xvf nebula-graph-studio-3.0.0-1.x86_64.tar.gz
+   tar -xvf nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz
    ```
 
 ### 部署
@@ -274,6 +191,89 @@ $ cd nebula-graph-studio
 $ npm run stop # stop nebula-graph-studio
 ```
 
+## Docker 部署 Studio
+### 前提条件
+
+在部署 Docker 版 Studio 之前，用户需要确认以下信息：
+
+- Nebula Graph 服务已经部署并启动。详细信息，参考[Nebula Graph安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。
+
+- 在即将运行 Docker 版 Studio 的机器上安装并启动 Docker Compose。详细信息参考 [Docker Compose 文档](https://docs.docker.com/compose/install/ "点击前往 Docker 文档中心")。
+- 确保在安装开始前，以下端口处于未被使用状态。
+
+   | 端口号 | 说明 |
+   | ---- | ---- |
+   | 7001 | Studio提供的web服务 |
+   | 8080 | Nebula-http-gateway，Client的HTTP服务 |
+   | 5699 | Nebula importer文件导入工具，数据导入服务 |
+
+- （可选）在中国大陆从 Docker Hub 拉取 Docker 镜像的速度可能比较慢，用户可以使用 `registry-mirrors` 参数配置加速镜像。例如，如果要使用 Docker 中国区官方镜像、网易镜像和中国科技大学的镜像，则按以下格式配置 `registry-mirrors` 参数：
+
+   ```json
+   {
+   "registry-mirrors": [
+     "https://registry.docker-cn.com",
+     "http://hub-mirror.c.163.com",
+     "https://docker.mirrors.ustc.edu.cn"
+     ]
+   }
+   ```
+
+   配置文件的路径和方法因操作系统和/或 Docker Desktop 版本而异。详细信息参考 [Docker Daemon 配置文档](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file "点击前往 Docker 文档中心")。
+
+### 操作步骤
+
+在命令行工具中按以下步骤依次运行命令，部署并启动 Docker 版 Studio，这里我们用 Nebula Graph 版本为 2.5 的进行演示：
+
+1. 下载 Studio 的部署配置文件。
+
+   | 安装包 | Nebula Graph版本 |
+   | ----- | ----- |
+   | [nebula-graph-studio-v3.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/nebula-graph-studio-v3.tar.gz) | {{nebula.release}} |
+
+2. 创建`nebula-graph-studio-v3`目录，并将安装包解压至目录中。
+
+   ```bash
+   mkdir nebula-graph-studio-v3 && tar -zxvf nebula-graph-studio-v3.tar.gz -C nebula-graph-studio-v3
+   ```
+
+3. 解压后进入 `nebula-graph-studio-v3` 目录。
+
+   ```bash
+   cd nebula-graph-studio-v3
+   ```
+
+4. 拉取 Studio 的 Docker 镜像。
+
+   ```bash
+   docker-compose pull
+   ```
+
+5. 构建并启动 Studio 服务。其中，`-d` 表示在后台运行服务容器。
+
+   ```bash
+   docker-compose up -d
+   ```
+
+   当屏幕返回以下信息时，表示 Docker 版 Studio 已经成功启动。
+
+   ```bash
+   Creating docker_importer_1 ... done
+   Creating docker_client_1   ... done
+   Creating docker_web_1      ... done
+   Creating docker_nginx_1    ... done
+   ```
+
+6. 启动成功后，在浏览器地址栏输入 `http://ip address:7001`。
+
+  !!! Note
+
+        在运行 Docker 版 Studio 的机器上，用户可以运行 `ifconfig` 或者 `ipconfig` 获取本机 IP 地址。如果使用这台机器访问 Studio，可以在浏览器地址栏里输入 `http://localhost:7001`。
+
+   如果在浏览器窗口中能看到以下登录界面，表示已经成功部署并启动 Studio。
+
+   ![Nebula Graph Studio 登录界面](../figs/st-ug-001-1.png "Nebula Graph Studio 登录界面")
+
 ## 后续操作
 
 进入 Studio 登录界面后，用户需要连接 Nebula Graph。详细信息，参考[连接数据库](st-ug-connect.md)。