add explorer

docs-2.0/nebula-explorer/about-explorer/ex-ug-what-is-explorer.md

@@ -0,0 +1,32 @@
+# What is Nebula Graph Explorer
+
+Nebula Graph Explorer (Explorer in short) is a browser-based visualization tool. It is used with the Nebula Graph kernel to visualize interaction with graph data. Even if there is no experience in graph database, you can quickly become a graph exploration expert.
+
+!!! enterpriseonly
+
+    Explorer is only available in the enterprise version.
+
+## Scenarios
+
+You can use Explorer in one of these scenarios:
+
+- You need to quickly find neighbor relationships from complex relationships, analyze suspicious targets, and display graph data in a visual manner.
+- For large-scale data sets, the data needs to be filtered, analyzed, and explored in a visual manner.
+
+## Features
+
+Explorer has these features:
+
+- Easy to use and user-friendly: Explorer can be deployed in simple steps. And use simple visual interaction, no need to conceive nGQL sentences, easy to realize graph exploration.
+
+- Flexible: Explorer supports querying data through VID, Tag, Subgraph.
+
+- Multiple operations: Explorer supports operations such as expanding operations on multiple points, querying the common neighbors of multiple points, and querying the path between the start vertex and the end vertex.
+
+- Various display: Explorer supports modifying the color and icon of the vertex in the canvas to highlight key nodes. You can also freely choose the data display mode in `dagre`, `force`, and `circular`.
+
+## Authentication
+
+Authentication is not enabled in Nebula Graph by default. Users can log into Studio with the `root` account and any password.
+
+When Nebula Graph enables authentication, users can only sign into Studio with the specified account. For more information, see [Authentication](../../7.data-security/1.authentication/1.authentication.md).

docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md

@@ -0,0 +1,47 @@
+# Connect to Nebula Graph
+
+After successfully launching Explorer, you need to configure to connect to Nebula Graph. This topic describes how Explorer connects to the Nebula Graph database.
+
+## Prerequisites
+
+Before connecting to the Nebula Graph database, you need to confirm the following information:
+
+- The Nebula Graph services and Explorer are started. For more information, see [Deploy Explorer](../deploy-connect/ex-ug-connect.md).
+
+- You have the local IP address and the port used by the Graph service of Nebula Graph. The default port is `9669`.
+
+- You have a Nebula Graph account and its password.
+
+  !!! note
+
+        If authentication is enabled in Nebula Graph and different role-based accounts are created, you must use the assigned account to connect to Nebula Graph. If authentication is disabled, you can use the `root` and any password to connect to Nebula Graph. For more information, see [Nebula Graph Database Manual](https://docs.nebula-graph.io/{{nebula.release}}/).
+
+## Procedure
+
+To connect Explorer to Nebula Graph, follow these steps:
+
+1. On the **Config Server** page of Explorer, configure these fields:
+
+   - **Host**: Enter the IP address and the port of the Graph service of Nebula Graph. The valid format is `IP:port`. The default port is `9669`.  
+
+    !!! note
+
+        When Nebula Graph and Explorer are deployed on the same machine, you must enter the IP address of the machine, but not `127.0.0.1` or `localhost`, in the **Host** field.
+
+   - **Username** and **Password**: Fill in the log in account according to the authentication settings of Nebula Graph.
+
+      - If authentication is not enabled, you can use `root` and any password as the username and its password.
+
+      - If authentication is enabled and no account information has been created, you can only log in as GOD role and use `root` and `nebula` as the username and its password.
+
+      - If authentication is enabled and different users are created and assigned roles, users in different roles log in with their accounts and passwords.
+
+   ![The Config Server page shows the fields to be configured for connection](../figs/st-ug-050.png "Config Server")
+
+2. After the configuration, click the **Connect** button.
+
+   If you can see the interface as shown in the below, it means you have successfully connected to the Nebula Graph database.
+
+   ![The Console page shows that the connection is successful](../figs/st-ug-051.png "Nebula Graph is connected")
+
+One session continues for up to 30 minutes. If you do not operate Explorer within 30 minutes, the active session will time out and you must connect to Nebula Graph again.

docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md

@@ -0,0 +1,128 @@
+# Deploy Explorer
+
+This topic describes how to deploy Explorer locally by RPM, and tar package.
+
+## RPM-based Explorer
+
+### Prerequisites
+
+Before you deploy Explorer, you must do a check of these:
+
+- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md).
+
+- Before the installation starts, the following ports are not occupied.
+
+   | Port | Description |
+   | ---- | ---- |
+   | 7002 | Web service provided by Explorer |
+   | 8080 | Nebula-http-gateway service |
+
+- The Linux distribution is CentOS, installed `lsof` and [Node.js](https://nodejs.org/en/) of version above v10.16.0+.
+
+### Install
+
+1. Select and download the RPM package according to your needs. It is recommended to select the latest version. Common links are as follows:
+
+  !!! enterpriseonly
+
+        Explorer is only available in the enterprise version. Click [Pricing](https://nebula-graph.io/pricing/) to see more.
+
+2. Use `sudo rpm -i <rpm>` to install RPM package.
+
+   For example, install Explorer, use the following command:
+   ```bash
+   $ sudo rpm -i nebula-graph-explorer-<version>.x86_64.rpm
+   ```
+### Uninstall
+
+Users can uninstall Explorer using the following command:
+
+```bash
+$ sudo rpm -e nebula-graph-explorer-<version>.x86_64
+```
+
+### Exception handling
+
+If the automatic start fails during the installation process or you want to manually start or stop the service, use the following command:
+
+- Start the service manually.
+
+   ```bash
+   $ sudo sh ./scripts/start.sh
+   ```
+
+- Stop the service manually
+
+   ```bash
+   $ sudo sh ./scripts/stop.sh
+   ```
+
+## tar-based Explorer
+
+### Prerequisites
+
+Before you deploy Explorer, you must do a check of these:
+
+- The Nebula Graph services are deployed and started. For more information, see [Nebula Graph Database Manual](../../2.quick-start/1.quick-start-workflow.md).
+
+- Before the installation starts, the following ports are not occupied.
+
+   | Port | Description |
+   | ---- | ---- |
+   | 7002 | Web service provided by Explorer |
+   | 8080 | Nebula-http-gateway service |
+
+- The Linux distribution is CentOS, installed `lsof` and [Node.js](https://nodejs.org/en/) of version above v10.16.0+.
+
+### Install
+
+1. Select and download the tar package according to your needs. It is recommended to select the latest version. Common links are as follows:
+
+  !!! enterpriseonly
+
+        Explorer is only available in the enterprise version. Click [Pricing](https://nebula-graph.io/pricing/) to see more.
+
+2. Use `tar -xvf` to decompress the tar package.
+
+   ```bash
+   tar -xvf nebula-graph-explorer-<version>.tar.gz
+   ```
+
+### Procedure
+
+!!! Note
+
+    The root directory `nebula-graph-explorer` has two installation packages: nebula-graph-explorer and nebula-http-gateway. You need to deploy and start the services separately on the same machine to complete the deployment of Explorer.'
+
+1. Deploy and start nebula-http-gateway.
+
+   ```bash
+   $ cd nebula-http-gateway
+   $ nohup ./nebula-httpd &
+   ```
+
+2. Deploy and start nebula-graph-explorer.
+
+   ```bash
+   $ cd nebula-graph-explorer
+   $ npm run start
+   ```
+
+### Stop Service
+
+You can use `kill pid` to stop the service:
+```bash
+$ kill $(lsof -t -i :8070) # stop nebula-http-gateway
+$ cd nebula-graph-explorer
+$ npm run stop # stop nebula-graph-explorer
+```
+
+## Next to do
+
+When Explorer is started, use `http://ip address:7002` to get access to Explorer.
+
+Seeing the following login interface, Explorer is successfully connected to Nebula Graph.
+
+![Nebula Graph Explorer](../figs/ex-ug-001.png)
+
+After entering the Explorer login interface, you need to connect to Nebula Graph. For more information, refer to [Connecting to the Nebula Graph](../deploy-connect/ex-ug-connect.md).

docs-2.0/nebula-explorer/deploy-connect/ex-ug-reset-connection.md

@@ -0,0 +1,7 @@
+# Reset connection
+
+When Explorer is still connected to a Nebula Graph database, in the toolbar, select Settings ![icon](../figs/nav-setup.png) > clear connect, as shown in the below:
+
+![clean](../figs/st-ug-004.png)
+
+After that, if the **configuration database** page is displayed on the browser, it means that Explorer has successfully disconnected from the Nebula Graph.