diff --git a/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md b/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md index 9d5beb395f5..8c3d5c285ee 100644 --- a/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md +++ b/docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md @@ -24,9 +24,9 @@ Nebula Explorer （简称 Explorer）是一款可以通过 Web 访问的图形 - 多种操作：支持对多个点进行拓展操作、查询多个点的共同邻居、查询起点到终点之间的路径等操作。 -- 多样展示：用户可以在层次图（dagre）、力导向图（force）、环形图（circular）中自由选择数据的展示方式。 +- 多样展示：支持修改画布中点的颜色和 icon，突出关键节点。也可以在层次图（dagre）、力导向图（force）、环形图（circular）中自由选择数据的展示方式。 -- 便于筛选：支持基于自定义条件灵活筛选需要展示的数据。 + ## 身份验证 diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md index 21e30be7c07..9aba10eaf7b 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md @@ -33,7 +33,7 @@ - 如果已启用身份验证，但是未创建账号信息，用户只能以 GOD 角色登录，必须填写 `root` 及对应的密码 `nebula`。 - 如果已启用身份验证，同时又创建了不同的用户并分配了角色，不同角色的用户使用自己的账号和密码登录。 - ![Nebula Graph Explorer 的登录页面](../figs/ex-ug-002.png "配置数据库") + ![Nebula Graph Explorer 的登录页面](../figs/ex-ug-002-1.png "配置数据库") 2. 完成设置后，点击 **连接** 按钮。 如果能看到如下图所示的界面，表示已经成功连接到 Nebula Graph 数据库。 diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index 202bb2e34a9..b564b1c9fe8 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -1,8 +1,10 @@ # 部署 Explorer -本文介绍如何在本地通过 RPM 部署 Explorer。 +本文介绍如何在本地通过 RPM 和 tar 包部署 Explorer。 -## 前提条件 +## RPM 部署 + +### 前提条件 在部署 Explorer 之前，用户需要确认以下信息： @@ -15,36 +17,32 @@ | 7002 | Explorer 提供的 web 服务 | | 8070 | Nebula-http-gateway 的 HTTP 服务 | -## 安装 - -1. 根据需要下载 RPM 包，建议选择最新版本。常用链接如下： +### 安装 - | 安装包 | 检验和 | Nebula Graph内核版本 | - | ----- | ----- | ----- | - | [nebula-graph-explorer-{{ explorer.base100 }}-1.rpm]() | [nebula-graph-explorer-{{ explorer.base100 }}-1.rpm.sha256]() | {{ nebula.release }} | +1. 根据需要下载 RPM 包，建议选择最新版本。 -!!! enterpriseonly + !!! enterpriseonly - Explorer 仅在企业版提供，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 + Explorer 仅在企业版提供，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 2. 使用`sudo rpm -i `命令安装RPM包。 - 例如，安装 Explorer {{ explorer.base100 }} 版本需要运行以下命令： + 例如，安装 Explorer 需要运行以下命令： ```bash - $ sudo rpm -i nebula-graph-explorer-{{ explorer.base100 }}-1.x86_64.rpm + $ sudo rpm -i nebula-graph-explorer-*.x86_64.rpm ``` -## 卸载 +### 卸载 使用以下的命令卸载 Explorer 。 ```bash -$ sudo rpm -e nebula-graph-explorer-{{ explorer.base100 }}-1.x86_64.rpm +$ sudo rpm -e nebula-graph-explorer-*.x86_64.rpm ``` -## 异常处理 +### 异常处理 如果在安装过程中自动启动失败或是需要手动启动或停止服务，请使用以下命令. @@ -60,6 +58,67 @@ $ sudo rpm -e nebula-graph-explorer-{{ explorer.base100 }}-1.x86_64.rpm $ sudo sh ./scripts/stop.sh ``` +## tar 包部署 + +### 前提条件 + +在部署 Explorer 之前，用户需要确认以下信息： + +- Nebula Graph 服务已经部署并启动。详细信息参考[Nebula Graph安装部署](../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。 + +- 使用的 Linux 上安装有版本为 v10.12.0 以上的Node.js。 + +- 以下端口未被使用。 + + | 端口号 | 说明 | + | ---- | ---- | + | 7002 | Explorer 提供的 web 服务 | + | 8070 | Nebula-http-gateway 的 HTTP 服务 | + +### 安装 + +1. 根据需要下载 tar 包，建议选择最新版本。 + + !!! enterpriseonly + + Explorer 仅在企业版提供，点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。 + +2. 使用 `tar -xvf` 解压 tar 包。 + + ```bash + tar -xvf nebula-graph-explorer-*.tar.gz + ``` + +### 部署 + +!!! Note + + 根目录 nebula-graph-explorer 下一共有两个安装包：nebula-graph-explorer 和 nebula-http-gateway。用户需要在同一台机器上分别部署并启动服务，才能完成 Explorer 的部署。 + +1. 部署 nebula-http-gateway 并启动。 + + ```bash + $ cd nebula-http-gateway + $ nohup ./nebula-httpd & + ``` + +2. 部署 nebula-graph-explorer + + ```bash + $ cd nebula-graph-explorer + $ npm run start + ``` + +### 停止服务 + +用户可以采用`kill pid`的方式来关停服务： + +```bash +$ kill $(lsof -t -i :8070) # 停止 nebula-http-gateway +$ cd nebula-graph-explorer +$ npm run stop # 停止 nebula-graph-explorer +``` + ## 后续操作 启动成功后，在浏览器地址栏输入 `http://:7002`。 diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-reset-connection.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-reset-connection.md index e2ec713123a..39fa8635d17 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-reset-connection.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-reset-connection.md @@ -1,7 +1,7 @@ # 清除链接 Explorer 还连接在某个 Nebula Graph 数据库时，在工具栏中，选择 设置 ![icon](../figs/nav-setup.png) > 清空连接，如下图所示： -![清除链接](../figs/ex-ug-004.png) +![清除链接](../figs/ex-ug-004-1.png) 之后，如果浏览器上显示 **配置数据库** 页面，表示 Explorer 已经成功断开了与 Nebula Graph 数据库的连接。 diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-002-1.png b/docs-2.0/nebula-explorer/figs/ex-ug-002-1.png new file mode 100644 index 00000000000..b1abe08cbd6 Binary files /dev/null and b/docs-2.0/nebula-explorer/figs/ex-ug-002-1.png differ diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-004-1.png b/docs-2.0/nebula-explorer/figs/ex-ug-004-1.png new file mode 100644 index 00000000000..2f3b14bcb93 Binary files /dev/null and b/docs-2.0/nebula-explorer/figs/ex-ug-004-1.png differ diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-009-1.png b/docs-2.0/nebula-explorer/figs/ex-ug-009-1.png new file mode 100644 index 00000000000..b3bad34b06b Binary files /dev/null and b/docs-2.0/nebula-explorer/figs/ex-ug-009-1.png differ diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-009.png b/docs-2.0/nebula-explorer/figs/ex-ug-009.png deleted file mode 100644 index 40df3004b36..00000000000 Binary files a/docs-2.0/nebula-explorer/figs/ex-ug-009.png and /dev/null differ diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-011-1.png b/docs-2.0/nebula-explorer/figs/ex-ug-011-1.png new file mode 100644 index 00000000000..a2d84b76730 Binary files /dev/null and b/docs-2.0/nebula-explorer/figs/ex-ug-011-1.png differ diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-011.png b/docs-2.0/nebula-explorer/figs/ex-ug-011.png deleted file mode 100644 index 02d000c4b3c..00000000000 Binary files a/docs-2.0/nebula-explorer/figs/ex-ug-011.png and /dev/null differ diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-012-1.png b/docs-2.0/nebula-explorer/figs/ex-ug-012-1.png new file mode 100644 index 00000000000..cbdd815524c Binary files /dev/null and b/docs-2.0/nebula-explorer/figs/ex-ug-012-1.png differ diff --git a/docs-2.0/nebula-explorer/figs/ex-ug-012.png b/docs-2.0/nebula-explorer/figs/ex-ug-012.png deleted file mode 100644 index 2906e69d149..00000000000 Binary files a/docs-2.0/nebula-explorer/figs/ex-ug-012.png and /dev/null differ diff --git a/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md b/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md index ed61e33087c..94522babaf6 100644 --- a/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md +++ b/docs-2.0/nebula-explorer/operation-guide/ex-ug-canvas.md @@ -25,7 +25,7 @@ Explorer 支持批量选中多个点边，并查看选中点边的数据，详 ## 快速操作 -用户可以选择一个或多个点和边，在空白处点击右键可以进行对点进行扩展、查找两个点之间的路径、在页面中显示或隐藏其属性等操作。用户选择的点和边数据会影响到可以执行的操作，具体操作的说明参见[图探索拓展](../operation-guide/ex-ug-garph-exploration.md)。 +用户可以选择一个或多个点和边，在空白处点击右键可以进行对点进行扩展、查找两个点之间的路径、在页面中显示或隐藏其属性等操作。用户选择的点和边数据会影响到可以执行的操作，具体操作的说明参见[图探索拓展](../operation-guide/ex-ug-graph-exploration.md)。 ![quick](../figs/ex-ug-026-1.png) 点击 **适合选中尺寸** 可以将选中的数据，移动到画布的中心，方便用户查看。 diff --git a/docs-2.0/nebula-explorer/operation-guide/ex-ug-graph-exploration.md b/docs-2.0/nebula-explorer/operation-guide/ex-ug-graph-exploration.md index 12eb160bdd4..b780fdc410f 100644 --- a/docs-2.0/nebula-explorer/operation-guide/ex-ug-graph-exploration.md +++ b/docs-2.0/nebula-explorer/operation-guide/ex-ug-graph-exploration.md @@ -11,6 +11,10 @@ 在菜单栏，点击 ![expand](../figs/rightclickmenu-expand.png) 图标，打开 **拓展** 窗口。用户可以双击某一点，对该点进行拓展。也可以框选画布中的多个点，在如下操作栏中修改边类型，选择边的流入流出方向，修改点的颜色，规定拓展步数和自定义过滤条件。 +!!! Note + + 面板内配置修改后会保存当前配置，当双击或者右键快捷拓展时候会以当前配置进行拓展。 + ![expand](../figs/ex-ug-013-1.png) ## 共同邻居 diff --git a/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md b/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md index d3095e8d1f4..280b57485cc 100644 --- a/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md +++ b/docs-2.0/nebula-explorer/operation-guide/ex-ug-page-overview.md @@ -15,13 +15,13 @@ Explorer 的主页面分为五个部分： ## 标签栏 -- 导出图形：支持导出当前视图的 CSV 文件或 SVG（图片）文件。 +- 导出图形：支持导出当前视图的 CSV 文件或 PNG（图片）文件。 ## 侧边栏 侧边栏包括四个部分，用户可以点击按钮对图进行探索、修改画布上点的内容等等。 -- 查询探索：在进行探索之前，用户需要在查询数据并显示在画布中。 +- 查询探索：在进行探索之前，用户需要查询数据并显示在画布中。 - 画布操作：包括框选画布中的点、拖动画布、选中多条点边功能。 @@ -38,10 +38,9 @@ Explorer 的主页面分为五个部分： ### 画布操作 - 框选模式：单击![frameSelect](../figs/nav-frameSelect.png) 图标，支持框选画布中的点和边。 - -- 拖动画布：单击![moveCanvas](../figs/nav-moveCanvas.png) 图标，支持拖动画布的位置。 - - 选中多条点边：单击![singleSelect](../figs/nav-singleSelect.png) 图标，可以方便的点击画布中的点和边，单击空白处取消选择。 +- 拖动画布：单击![moveCanvas](../figs/nav-moveCanvas.png) 图标，支持拖动画布的位置。 +更多详细信息参考 [画布操作](../operation-guide/ex-ug-canvas.md)。 ### 图探索扩展 @@ -49,6 +48,7 @@ Explorer 的主页面分为五个部分： - 共同邻居：单击 ![commonNeighbor](../figs/rightclickmenu-commonNeighbor.png)图标，选择页面上 2 个点并查看它们的共同邻居。 - 路径查询：单击 ![findPath](../figs/rightclickmenu-findPath.png)图标，可以查询起点到终点之间的 `all paths` 、 `Shortest path` 或者是 `Noloop path` 的路径。 - 查看属性：单击 ![propertyView](../figs/nav-propertyView.png)图标，选择是否显示画板中的点或边的属性值。 +更多详细信息参考 [图探索拓展](../operation-guide/ex-ug-graph-exploration.md)。 ### 删除及撤销 @@ -69,7 +69,7 @@ Explorer 的主页面分为五个部分： - 点边概览：默认隐藏，在当前画布选中点和边时才显示。点击如图标识，用户可以打开菜单，查看当前子图中选中的点和边的详细数据。 - ![review](../figs/ex-ug-027.png) + ![review](../figs/ex-ug-027-1.png) 更多详细操作参考 [画布操作](../operation-guide/ex-ug-canvas.md)。 @@ -82,6 +82,7 @@ Explorer 的主页面分为五个部分： | 图标 | ![force](../figs/Thumbnail-graphView.png) | ![dagre](../figs/Thumbnail-treeView.png) | ![circular](../figs/Thumbnail-sphereView.png) | | ---- | ---- |----| ----| | 展示模式 | force（力导向图） | dagre（层次图） | circular（环形图） | + ## 关系列表 点击右侧的 ![unfold](../figs/sidebar-unfold.png)图标，用户可以打开菜单，查看画板中 Tag 和 Edge 的数量、搜索 Tag 和 Edge ，同时也支持修改点的颜色和图标。 \ No newline at end of file diff --git a/docs-2.0/nebula-explorer/operation-guide/ex-ug-query-exploration.md b/docs-2.0/nebula-explorer/operation-guide/ex-ug-query-exploration.md index 31e12c946cd..c95a02d513f 100644 --- a/docs-2.0/nebula-explorer/operation-guide/ex-ug-query-exploration.md +++ b/docs-2.0/nebula-explorer/operation-guide/ex-ug-query-exploration.md @@ -10,14 +10,14 @@ 用户可以通过输入VID或者生成VID的数据查询，一行仅支持一个数据。同时也支持随机导入数据和文件导入数据。确认添加后，数据会显示在画布中。以下给出示例： -![VID](../figs/ex-ug-009.png) +![VID](../figs/ex-ug-009-1.png) ## Tag 查询 基于 Tag 查询，必选值为 Tag 和索引。用户可以对输出的结果进行数量上的限制和结果进行过滤。以下查询 10 个年龄大于 30 岁，且不等于 40 岁的球员，示例如下： -![Tag](../figs/ex-ug-011.png) +![Tag](../figs/ex-ug-011-1.png) ## 子图查询 基于子图查询，必选值为 VID 。用户可以查看一个或多个点的子图，支持规定子图的步数、边类型及流入流出的方向。以下给出 VID 值为 101 ，步数为 4 ，边类型为 server 和 like 的入边的示例： -![Query](../figs/ex-ug-012.png) \ No newline at end of file +![Query](../figs/ex-ug-012-1.png) \ No newline at end of file