Build server of Blockchain explorer

1. Functions

This project aims to build the back-end server of the Blockchain explorer. Its workflow includes extracting the node’s local blockchain data into a database, providinfg database access to the front-end webpage.

2. Prerequisites

Environment Version
Java jdk1.8.0_121 or above version
gradle gradle-5.0 or above version
database mysql-5.6 or above version
Note: the installation details is attached in Additional.

3. Deployment

3.1 Pull code

Execute command:

git clone

# If you have network issue for exec the command above, please try:
git clone
cd fisco-bcos-browser

3.2 Compile code

Enter the code directory:

cd server/fisco-bcos-browser

Then, build code:

gradle build

It will create a target directory dist after the building.

3.3 Modify config

The directory dist provides a config template on dist/conf_template(only for reference):

# create a config file on dist/conf  and set the parameters according to the template, or copy and rename the template if it's the initial installation.
 Example:cp dist/conf_template dist/conf -r

Enter directory:

cd dist/conf

Modify service config (except for the unchanged parts):

Database server should be prepared in advance. The build method can be referred in Appendix.

modify current server port: sed -i "s/5101/${your_server_port}/g" application.yml
modify database IP: sed -i "s/${your_db_ip}/g" application.yml
modify database user name: sed -i "s/dbUsername/${your_db_account}/g" application.yml
modify database password: sed -i "s/dbPassword/${your_db_password}/g" application.yml
modify database name: sed -i "s/db_browser/${your_db_name}/g" application.yml

Example (change the database IP from to sed -i "s/" application.yml


In real production, we suggest to place the compiled install package (i.e. the directory dist) to the service deployment directory. For example: /data/app/fisco-bcos-browser

3.4 Service start/stop

Go to the compiled target directory:

cd dist

3.5 View log

Enter the compiled target directory:

cd dist

Execute the command:

tail -f log/fisco-bcos-browser.log

4. Troubleshooting

4.1 Start/Stop fail

If this problem happens in the above bash script, please try:

chmod +x *.sh

4.2 gradle build fail

If the following exception occures during the building process. Please check the gradle version and make sure it is at v 5.0 or above.

Could not find method annotationProcessor() for arguments [org.projectlombok:lombok:1.18.2] on object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler.

5. Appendix

5.1 Java environment deployment

Here are simple steps for quick start. For detailed description, please consult the official website.

Download Java installation package from the official website corresponding to the specific version introduced before, and decompress to the relevant directory:

mkdir /software
tar -zxvf jdkXXX.tar.gz /software/

Configure environment variable:

export JAVA_HOME=/software/jdk1.8.0_121
export PATH=$JAVA_HOME/bin:$PATH 
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar

5.2 gradle enrironment deployment

Here are simple steps for quick start. For detailed description, please consult the official website.

Download the 5.0 or above version of gradle installation package from the website and decompress to the relative directory.

mkdir /software/
unzip -d /software/

Configure environment variable

export GRADLE_HOME=/software/gradle-XXX

5.3 Set-up MySQL

Here we take Centos/Fedora as an example.

a. Transfer to the root user

sudo -s

b. Install MySQL

yum install mysql*
# some versions of Linux needs to install mariadb which is a branch of mysql
yum install mariadb*

c. Start MySQL service

service mysqld start
#if mariadb is installed, start it with the following command
systemctl start mariadb.service

d. Initialize database user

Access the database with the root user:

mysql -u root

Set password for the root user and grant the access privilege to remote login

mysql > SET PASSWORD FOR 'root'@'localhost' = PASSWORD('123456');


  1. The database password (123456) provided here is only for example. We strongly recommend you to set more complexer password.

  2. The setting of remote access in the example will make the database accessible for the outside network . Please limit the network accessibility according to the specific network topology and permissioned accounts.

Create test user and a database test, grant the database privilege to the test user:

mysql > CREATE user 'test'@'localhost' identified by '123456';
mysql > CREATE DATABASE test;
mysql > GRANT ALL PRIVILEGES ON test.* TO 'test'@'localhost' IDENTIFIED BY '123456' WITH GRANT OPTION;

e. Test the connection

Open another terminal and check the database connection with the test user :

mysql -utest -p123456 -h -P 3306

If login successfully, execute the following SQL commands to check the privilege granting.

mysql > USE test;

f. Create database

Login database with root user

mysql -uroot -p

Create database and grant the privilege to test user

mysql > CREATE DATABASE db_browser;
mysql > GRANT ALL PRIVILEGES ON db_browser.* TO 'test'@'localhost' IDENTIFIED BY '123456' WITH GRANT OPTION;

5.3.1 Common issues

After installing MySQL on centos of Tencent Cloud , it reports the exception: Access denied for user ‘root’@’localhost’

  1. Edit /etc/my.cnf, add the follow in the bottom of [mysqld]

  1. Save and restart MySQL

   service mysqld restart 
  1. Input the following command, press enter, input password and press enter again to login MySQL

   mysql -uroot -p mysql