How to perform a private deployment of the DataV service-DataV(DataV)-阿里云帮助中心

Private deployment lets you package and download a dashboard created with DataV-Board 6.0. You can then install and run this dashboard on your corporate intranet. For example, if your corporate intranet has a database that is inaccessible from the public network, an online dashboard cannot connect to it. A private deployment resolves this issue.

Limits

Only Premium Edition users can use the private deployment feature.
Private deployments do not include map tile data.
Private deployments support the following data source types: HTTP API, MySQL, SQL Server, Oracle, PostgreSQL, and static data.

Note
During a private deployment, the packaged dashboard retains its original data source type and configuration.

Server requirements for private deployment

The minimum system and hardware requirements are as follows:

A 64-bit Linux system compatible with CentOS 7.0
4-core 4 GHz processor
8 GB memory
100 GB hard disk

Get a private deployment

Log on to the DataV console.
On the My Visualizations page, select a visualization application and click Edit.
In the PC canvas editor, click the Local Deployment icon in the upper-right corner of the page.
In the Local Deployment dialog box, follow the prompts to download the runtime environment package and the visualization application package.

Important
The runtime package is associated with your account. You can only deploy and run visualization applications that are downloaded from an account with an active Premium Edition subscription.
1. Click Download Runtime Environment. You are redirected to the User Center > Private Deployment panel. Under Usage Details, click A new version is available. Please regenerate. to download the compressed runtime environment package.
  
  Note
  If a new version of the runtime environment is being generated, wait about ten minutes for the process to complete. Then, refresh the page to download the runtime environment.
2. Click Download Dashboard. You are redirected to the dashboard packaging page. After the packaging is complete, click Download to download the compressed dashboard package.

Deploy the DataV service.

Upload the downloaded compressed runtime environment package to your server.
Create a new folder on the server. For example, run the mkdir datav command to create a folder named datav.

Decompress the runtime environment package into the datav folder.

tar xzvf runtime-4.8.2.tgz ./datav/   // Decompresses the downloaded runtime environment package. If the package name is different, replace it in the command. This example uses runtime-4.8.2.tgz.

Modify the config.js configuration file.

'use strict';
module.exports = {
  created: '2021-07-08T02: 44: 51.205Z',
  listen: {
    port: 7001, // Default port.
    // headersTimeout: 60 * 1000, // Request header timeout setting. By default, there is no timeout.
  },
  ratelimit: { // Rate limiting configuration.
    enable: false, // Disabled by default. Set to true to enable.
    duration: 60000, // Milliseconds
    max: 1000, // Count
    // This means a single IP address is limited to 1000 requests within 60 seconds. If you enable this option, set a larger value for max.
  },
  disableDelete: { // Do not accept DELETE requests. Disabled by default.
    enable: false,
  },
  crypt: {
    timeout: 30 * 1000, // Encrypted header time difference configuration. Default is 30 seconds.
  },
  /*
  blackList: { // Enabled by default.
    enable: true,
    max: 5, // Maximum number of failures. After 5 failures, the IP is added to the blacklist. Default is 5.
    maxAge: 5 * 60 * 1000, // Freeze duration in ms. Default is five minutes.
  },*/
  // Allowed file types for upload in the dashboard package. No limit by default.
  // uploadLimit: ['.png', '.gif', '.jpeg', '.jpg', '.ttf', '.woff', '.eot', '.json', '.swf', '.js', '.xml', '.hdr', '.vb', '.bin', '.datavmesh', '.glb', '.key'],
  /*
  host: [],   // Required when using a third-party domain name.
  */
  // Default account: admin | Password: hello_****, // Default logon password. To add new accounts, add them here.
};

Start the service and check its status. The service is stopped by default.

Navigate to the datav folder and run the following commands:

Important
If you do not have sufficient execution permissions, run chmod 777 ./* to modify the permissions.
- Start the service
```
./bin/datav start
```
- Stop the service
```
./bin/datav stop
```
- Restart the service
```
./bin/datav restart
```
- Check the service status
```
curl http://127.0.0.1:7001/app/check  // By default, DataV uses the local IP address and port. Modify the IP address and service port in the configuration file as needed.
```
After the service starts, open a browser and access the IP address and service port of the server on which the DataV service is running. For example, http://10.10.10.10:7001/.

Note
When you access the service for the first time, the page does not display correctly because the server has not been registered. The page displays your server's machine code. Save this machine code for server registration, as shown in the following figure.

Figure 1. Machine code displayed on the logon page for an unregistered server

Register the server.
1. In the DataV console, click User Center in the personal account drop-down list.
2. On the User Center page, click Details in the lower-right corner of the Private Deployment module.
3. On the Usage Details page of Private Deployment, enter the Server Machine Code and Server Name, and then click Register to register the server.
  After registration, the system generates a test key.
  
  Note
  You can submit a ticket to modify the server machine code before you enable the official key.
4. Download the test key to verify the server deployment.
  
  Important
  The test key is temporary. When it expires, you must download it again or enable it as an official key and replace the old key.
5. After successful verification, click Enable in the Actions column for the test key. In the dialog box that appears, click OK to enable the official key.
  After the test key is enabled as an official key, the quota for available servers is automatically deducted.
  
  Note
  After your DataV Premium Edition subscription expires, you can continue to use the content on your privately deployed servers.
After the server is registered, download the test key or official key file (runtime.key) and place it in the root folder of the runtime environment package.

Important
If you are using a test key, you can enable the official key after successful testing. Then, download the new runtime.key file and use it to replace the test runtime.key file. After replacing the file, restart the service.

Use the private deployment

The following figure shows the workflow for using a private deployment.

After the service restarts, open a browser and access the IP address and service port of the server where the DataV service is running, for example, http://10.10.10.10:7001/. Enter the username, password, and verification code to log on.
The username and password are the ones you configured in the config.js file. The verification code is the image in the lower-right corner of the logon interface.

Add a visualization application.

On the My Visualizations page, click Create Visualization.
On the New Project page, click Upload Dashboard Package.

On the Upload Dashboard Package page, click Upload to upload the visualization application package.

Important

The visualization application package name cannot contain Chinese characters.

After the visualization application package is uploaded, refresh the My Visualizations page to view it.

The uploaded visualization application is located in the assets/screens/ folder within the DataV folder. The file structure of the visualization application is as follows:

Offline package files

File	Description
config.json	Basic information about the visualization application.
data.json	Data configuration content.
filters.json	Filter content.
modules.js	Widget resource files.
packages.json	Widget information.
screen.json	Configuration items for the visualization application. Encrypted.
screen.key	License file for the visualization application.

Files after local modification

If you change the online version of this visualization application, you can repackage the online application and overwrite the offline package files while preserving the files listed below. These files are generated only after you publish the visualization application.

File	Description
config-new.json	Modified basic information of the visualization application.
data-new.json	Modified data configuration content.
filters-new.json	Modified filter content.
screen-new.json	Modified configuration items for the visualization application. Encrypted.
interaction-new.json	Modified configuration file for the Blueprint Editor.

Connect to a data source.
Private deployments use the DataV Proxy Service to connect to data sources, which supports MySQL, SQL Server, Oracle, and PostgreSQL. For more information, see How to use DataV Proxy and Add a DataV Proxy Service.
Configure the data source.
Navigate to the canvas editor page, click a widget, and configure a private network data source for the widget in the data configuration panel.
Data-related configurations are written to files that contain -new in their names. To adjust the style, you can download and package the online visualization application again and overwrite the local files.
Start the service and view logs.
Startup log: {DataV service folder}/logs.
View log: {DataV service folder}/datav_stdout.log.

Private deployment FAQ

This section provides answers to frequently asked questions about DataV-Board private deployments.

Are private deployment and local deployment the same feature?

Private deployment, also known as local deployment, is the process of packaging and downloading a page developed with DataV to a local environment, and then installing and deploying it to run on your corporate intranet. They are different names for the same feature.

Does DataV support local deployment? What are the deployment mode and pricing?

DataV currently offers Enterprise, Professional, and Premium editions. Only the Premium Edition supports local deployment. The deployment mode is a hybrid cloud model, where you use the public cloud to develop visualization applications. After development, the applications are packaged for local deployment. For pricing information about local deployment, go to the DataV product page, click the customer service icon on the right, and select Pre-sales Consultation to contact a customer service representative.

If your local deployment permissions expire, your previously deployed visualization applications are not affected and will continue to function.

Why is the local deployment version of DataV much more expensive than the public cloud version?

The main reasons are as follows: The local deployment version of DataV is more difficult to maintain and requires more technical support. A local deployment of DataV lets you access and use DataV's proprietary visualization chart widgets and geographic information widgets offline. These widgets are important assets of DataV. The underlying architecture is also upgraded to support online editing, packaging, widget style adjustments, and certain data operations.

Can all interactive content from the online Premium Edition's Blueprint Editor be deployed locally?

Yes. All interactive effects that you configure in the Premium Edition are included in the local download and can be modified and adjusted locally.

Can online maps still be used after a private deployment?

The basemap services used by the online version of DataV are provided by third-party map tile services, such as AMAP. DataV itself does not provide map tile data services. There are two solutions for using tile maps after a private deployment:

Solution 1: If your network is not completely physically isolated, you can add the third-party map service, such as AMAP, to a whitelist.
Solution 2: If your network is completely isolated, you must build your own tile service.