This tutorial is a quick start guide describing how to deploy the DolphinDB server standalone, and update the server and license file. You can also find solutions to common issues in the FAQ section.
- 1. Standalone Deployment on Linux OS
- 2. Standalone Deployment on Windows OS
- 3. Upgrade DolphinDB Server
- 4. Update License File
- 5. FAQ
- 6. See Also
- Official website: DolphinDB
- Or you can download DolphinDB with a shell command:
wget "https://www.dolphindb.com/downLinux64-Current.php -O dolphindb.zip"Then extract the installation package to the specified directory (/path/to/directory):
unzip dolphindb.zip -d </path/to/directory>Note: The directory name cannot contain any space characters, otherwise the startup of the data node will fail.
If you have obtained the Enterprise Edition license, use it to replace the following file:
/DolphinDB/server/dolphindb.licOtherwise, you can continue to use the community version of DolphinDB, which allows up to 8GB of memory use for 20 years.
Navigate to the folder /DolphinDB/server/. The file permissions need to be modified for the first startup. Execute the following shell command:
chmod +x dolphindb- Linux console mode:
./dolphindbThe default port number of the system is 8848. To change it (e.g., to 8900), use the following command line:
./dolphindb -localSite localhost:8900:local8900- Linux background mode:
sh startSingle.shTo check whether the node was successfully started, execute the following shell command:
ps aux|grep dolphindbThe following information indicates a successful startup:
Enter the deployment server IP address and port number (8848 by default) in the browser to navigate to the DolphinDB Web. The server address (ip:port) used in this tutorial is 10.0.0.82:8848. Below is the web interface.
Note: If the browser and DolphinDB are not deployed on the same server, you should turn off the firewall or open the corresponding port beforehand.
-
Official website: DolphinDB
-
Extract the installation package to the specified directory:
C:\DolphinDBNote: The directory name cannot contain any space characters, otherwise the startup of the data node will fail. For example, do not extract it to the Program Files folder on Windows.
If you have obtained the Enterprise Edition license, use it to replace the following file:
C:\DolphinDB\server\dolphindb.licOtherwise, you can continue to use the community version of DolphinDB, which allows up to 8GB of memory use for 20 years.
Navigate to the folder C:\DolphinDB\server:
- Windows console mode:
Double click to execute dolphindb.exe:
The default port number of the system is 8848. You can change it by modifying the localSite parameter in config file dolphindb.cfg.
- Windows background mode:
Double click to execute backgroundSingle.vbs, and check DolphinDB process in your Task Manager.
Or you can check the process in Command Prompt with the following command.
tasklist|findstr "dolphindb"
Enter the deployment server IP address and port number (8848 by default) in the browser to navigate into the DolphinDB Web. The server address (ip:port) used in this tutorial is 10.0.0.82:8848. Below is the web interface.
Note: If the browser and DolphinDB are not deployed on the same server, you should turn off the firewall or open the corresponding port beforehand.
Step 1: Close the Server
Navigate to the folder /DolphinDB/server/clusterDemo to execute the following command:
./stopAllNode.shStep 2: Backup the Metadata
The default directory to save the metadata for a standalone mode is:
/DolphinDB/server/local8848/dfsMeta//DolphinDB/server/local8848/storage/CHUNK_METADATA/You can execute the following command to back up the metadata:
mkdir backup
cp -r local8848/dfsMeta/ backup/dfsMeta
cp -r local8848/storage/CHUNK_METADATA/ backup/CHUNK_METADATANote: If the backup files are not in the above default directories, check the directories specified by the configuration parameters dfsMetaDir and chunkMetaDir. If the configuration parameters are not modified but the configuration parameter volumes is specified, then you can find the CHUNK_METADATA under the volumes directory.
Step 3: Upgrade
Note: When the server is upgraded to a certain version, the plugin should also be upgraded to the corresponding version.
- Online Upgrade
Navigate to the folder /DolphinDB/server/clusterDemo to execute the following command:
./upgrade.shThe following prompt is returned:
Type "y" and press Enter:
Type "1" and press Enter:
Type a version number and press Enter. To upgrade to version 2.00.9.1, for example, enter 2.00.9.1 and press Enter. The following prompt indicates a successful upgrade.
- Offline Upgrade
Download a new version of server package from DolphinDB website
Upload the installation package to /DolphinDB/server/clusterDemo. Take version 2.00.9.1 as an example.
Navigate to the folder /DolphinDB/server/clusterDemo to execute the following command:
./upgrade.shThe following prompt is returned:
Type "y" and press Enter:
Type "2" and press Enter:
Type a version number and press Enter. To upgrade to version 2.00.9.1, for example, enter 2.00.9.1 and press Enter. The following prompt indicates a successful upgrade.
Step 4: Restart the Server
Navigate to the folder /DolphinDB/server to start the server with the following command:
sh startSingle.shOpen the web interface and execute the following script to check the current version of DolphinDB.
version()Step 1: Close the Server
- In console mode, close the foreground process.
- In background mode, close DolphinDB process from Task Manager.
Step 2: Back up the Metadata
The default directory to save the metadata for a standalone mode is:
C:\DolphinDB\server\local8848\dfsMeta\C:\DolphinDB\DolphinDB\server\local8848\storage\CHUNK_METADATA\Create a new folder backup under C:\DolphinDB, and copy the following files to it:
- file dfsMeta under C:\DolphinDB\server\local8848
- file CHUNK_METADATA under C:\DolphinDB\server\local8848\storage
Note: If the backup files are not in the above default directories, check the directories specified by the configuration parameters dfsMetaDir and chunkMetaDir. If the configuration parameters are not modified but the configuration parameter volumes is specified, then you can find the CHUNK_METADATA under the volumes directory.
Step 3: Upgrade
- Download a new version of server package from DolphinDB website
- Replace the existing server with all files (except dolphindb.cfg and dolphindb.lic) in the current \DolphinDB\server folder.
Note: When the server is upgraded to a certain version, the plugin should also be upgraded to the corresponding version.
Step 4: Restart the Server
Double click to execute dolphindb.exe.
Open the web interface and execute the following script to check the current version of DolphinDB.
version()Replace an existing license file with a new one.
License file path on Linux:
/DolphinDB/server/dolphindb.licLicense file path on Windows:
C:\DolphinDB\server\dolphindb.lic- Online Update
Execute the following script in web interface:
updateLicense()Note:
- The client name of the license cannot be changed.
- The number of nodes, memory size, and the number of CPU cores cannot be smaller than the original license.
- The update takes effect only on the node where the function is executed. Therefore, in a cluster mode, the function needs to be run on all controllers, agents, data nodes, and compute nodes.
- The license type must be either commercial (paid) or free.
- Offline Update
Restart DolphinDB server to complete the updates.
Q1: Failed to start the server for the port is occupied by other programs
The default port number of the system is 8848. If you cannot start the server, you can first check the log file dolphindb.log under /DolphinDB/server.
If the following error occurs, it indicates that the specified port is occupied by other programs.
<ERROR> :Failed to bind the socket on port 8848 with error code 98In such case, you can change to another free port in the config file.
Q2: Failed to access the web interface
Despite the server running and the server address (ip:port) being correct, the web interface remains inaccessible.
A common reason for the above problem is that the browser and DolphinDB are not deployed on the same server, and a firewall is enabled on the server where DolphinDB is deployed. You can solve this issue by turning off the firewall or by opening the corresponding port.
Q3: Roll back a failed upgrade on Linux
If you cannot start DolphinDB server after upgrade, you can follow steps below to roll back to the previous version.
- Step 1: Restore Metadata Files
Navigate to the folder /DolphinDB/server to restore metadata files from backup with the following commands:
cp -r backup/dfsMeta/ local8848/dfsMeta
cp -r backup/CHUNK_METADATA/ local8848/storage/CHUNK_METADATA- Step 2: Restore Program Files
Download the previous version of server package from the official website. Replace the server that failed to update with all files (except dolphindb.cfg and dolphindb.lic) just downloaded.
Q4: Roll back a failed upgrade on Windows
If you cannot start DolphinDB server after upgrade, you can follow steps below to roll back to the previous version.
- Step 1: Restore Metadata Files
Use metadata files from folder backup to replace the following files:
file dfsMeta under local8848
file CHUNK_METADATA under local8848/storage
- Step 2: Restore Program Files
Download the previous version of server package from the official website. Replace the server that failed to update with all files (except dolphindb.cfg and dolphindb.lic) just downloaded.
Q5: Failed to update the license file
Updating the license file online has to meet the requirements listed in Step 2, Chapter 4.
If not, you can choose to update offline or apply for an Enterprise Edition License。
Q6: Change configuration
For more details on configuration parameters, refer to Configuration。
If you encounter performance problems, you can contact our team on Slack for technical support.
For more information, refer to DolphinDB User Manual.