User Guide

This user guide provides brief instructions on how to install the DolphinDB server package, GUI clients, and APIs, as well as how to deploy DolphinDB clusters.


DolphinDB Server

Download DolphinDB Community Edition from Official Site.

Unzip DolphinDB package. It has DolphinDB executable, license file, and web-based cluster manager, etc. No need to install after unzipping. To request Enterprise Trial, click "Request a free trial" to apply for an enterprise license.

GUI Clients

DolphinDB provides VS Code Extension (recommended) that supports DolphinDB programming language, enabling users to manage DolphinDB scripts in VS Code and send them to the DolphinDB server for execution. You can install the extension in VS Code at lower use-cost. For detailed instructions on VS Code extension, see VS Code Extension.

You can also connect to the DolphinDB server and manage scripts using the DolphinDB GUI or Web Interface.


Check DolphinDB API for how to install and use Python/Java/C#/C++ API.

Possible Problems

(1) After starting a server, the system immediately exits. The error message in the log file is "The license has expired".

Cause: license expired

Solution: contact and update the license file.

(2) After starting the nodes on the web-based cluster manager, the nodes are still shown as stopped.

Cause: need to refresh nodes status.

Solution: click on the "refresh" button. If the log file has error message "Failed to bind the socket on XXXX" in the log file where XXXX is the port number of a data node to be started, this could mean that the port number is occupied by another application. If so, just close that application and try again. It could also mean the port is not yet released by the Linux kernel if you just closed the data node with this port number. For this case, just wait around 30 seconds and restart the nodes.

For any problem in using DolphinDB database, please first check the log file for more information. There is a log file on each of the data nodes and on the controller node. The default folder of the log file is the home directory. You can post your questions on or contact us at