diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-en.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-en.md new file mode 100644 index 00000000000..cd74da01a20 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-en.md @@ -0,0 +1,141 @@ +# Deploy Dashboard + +This topic will introduce how to install and deploy Dashboard in detail. + +## Prerequisites + +Before deploying Dashboard, you must do a check of these + +- Select and download Dashboard of the correct version. The version correspondence between Dashboard and Nebula Graph is as follows. + + | Dashboard version | Nebula Graph version | + | :-------------------------- | :--------------- | + | {{ dashboard_ent.release }} | 2.x | + +- The environment of [MySql](https://www.mysql.com/) is ready and a database named as `dashboard` is created. +- Before the installation starts, the following ports are not occupied. + + | Port | Description | + | ---- | ---- | + | 7005 | The port through which Dashboard provides the web service. | + | 8090 | The port of the nebula-http-gateway service. | + | 9090 | The port of the prometheus service. | + | 9200 | The port of the nebula-stats-exporter service. | + +- The license is ready. + + !!! enterpriseonly + + The license is only available in the Enterprise Edition. To obtain the license, send email to inquiry@vesoft.com. + +## Install and start + +1. Select and download the tar package according to your needs. It is recommended to select the latest version. + + !!! enterpriseonly + + For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/). + +2. Use `tar -xzvf` to decompress the tar package. + + ```bash + $ tar -xzvf nebula-graph-dashboard-.tar.gz + ``` + +3. Use `vim config/config.yaml` to modify the configuration. + + ```bash + # Information about the database + database: + dialect: mysql # The type of database used, which currently only supports MySql + host: 192.168.8.157 # The IP address of the connected MySql database + port: 3306 # The port of the connected MySql database + username: root # The username to log in MySql + password: nebula # The password to log in MySql + name: dashboard # The name of the corresponding database + autoMigrate: true # Auto database tables creation, the default value of which is true + # Information about the exporter port + exporter: + nodePort: 9100 # The port of the node-exporter service + nebulaPort: 9200 # The port of the nebula-stats-exporter service + # Information of services + proxy: + gateway: + target: "127.0.0.1:8090" # The IP address and port of the gateway service + prometheus: + target: "127.0.0.1:9090" # The IP address and port of the prometheus service + ``` + +4. Copy the license file to the `nebula-dashboard` directory. + + ```bash + $ cp -r + ``` + + For example: + ```bash + $ cp -r nebula.license /usr/local/nebula-dashboard + ``` + + !!! enterpriseonly + + The license is only available in the Enterprise Edition. To obtain the license, send email to inquiry@vesoft.com. + +5. Start Dashboard. + + You can use the following command to start the Dashboard with one click. + ```bash + $ bash ./scripts/start.sh + ``` + Or execute the following commands to start prometheus, webserver, exporter and gateway services to start Dashboard. + + ```bash + $ cd scripts + $ sudo ./dashboard.server start prometheus # Start prometheus service + $ sudo ./dashboard.server start webserver # Start webserver service + $ sudo ./dashboard.server start exporter # Start exporter service + $ sudo ./dashboard.server start gateway # Start gateway service + ``` + +## Manage Dashboard Service + +You can use the `dashboard.service` script to start, stop, and check the Dashboard services. + +### Syntax + +```bash +$ sudo /dashboard/scripts/dashboard.service +[-v] [-h] + +``` + +| Parameter | Description | +| :------------------------- | :------------------- | +| `dashboard_path` | Dashboard installation path. | +| `-v` | Display detailed debugging information. | +| `-h` | Display help information. | +| `start` | Start the target services. | +| `stop` | Stop the target services. | +| `status` | Check the status of the target services. | +| `prometheus` | Set the prometheus Service as the target service. | +| `webserver` | Set the webserver Service as the target service. | +| `exporter` | Set the exporter Service as the target service. | +| `gateway` | Set the gateway Service as the target service. | +| `all` | Set all the Dashboard services as the target services. | + +### Examples + +Dashboard is installed in the current directory, and you can use the following commands to manage services. +```bash +$ sudo /dashboard/scripts/dashboard.service start all #start all Dashboard service +$ sudo /dashboard/scripts/dashboard.service stop all #stop all Dashboard service +$ sudo /dashboard/scripts/dashboard.service status all #check all Dashboard service +``` + +## Next to do + +After Dashboard is successfully started, you can enter `http://:7005` in the address bar of a browser. + +If the following login interface is shown in the browser, then you have successfully deployed and started Dashboard. You can log into the GOD user of Dashboard with the default username `nebula` and password `nebula`. You can modify the password in [System Settings](../nebula-dashboard-ent/6.system-settings.md). And you also can use the GOD account to create a new account with the permission ADMIN on the [Account Management](../nebula-dashboard-ent/5.account-management.md) to log into the Dashboard. + +![start-page](../nebula-dashboard-en/figs/ds-028.png) diff --git a/docs-2.0/nebula-dashboard-ent/5.account-management.md b/docs-2.0/nebula-dashboard-ent/5.account-management.md new file mode 100644 index 00000000000..0541abf0d6c --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/5.account-management.md @@ -0,0 +1,9 @@ +# Authority management + +By default, you can log in with the GOD role (`nebula` as the default username and `nebula` as the default password). And the ADMIN account can be created or deleted on the authority management page. + +![god](../nebula-dashboard-ent/figs/ds-032.png) + +You cannot perform operations on other accounts using the ADMIN account you created except for viewing the user name, the role, and the creation time. + +![admin](../nebula-dashboard-ent/figs/ds-031.png) diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-031.png b/docs-2.0/nebula-dashboard-ent/figs/ds-031.png new file mode 100644 index 00000000000..0caa35ee481 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-031.png differ diff --git a/docs-2.0/nebula-dashboard-ent/figs/ds-032.png b/docs-2.0/nebula-dashboard-ent/figs/ds-032.png new file mode 100644 index 00000000000..540c3c7a8e5 Binary files /dev/null and b/docs-2.0/nebula-dashboard-ent/figs/ds-032.png differ