Creating nodes locally

Local nodes are used for testing and demo purposes only.

There are two ways you can create a node locally:

• Manually: create a local directory, add the relevant node and CorDapp files, and configure them.
• Automatically: use the Cordform or Dockerform gradle plug-ins, which automatically generate and configure a local set of nodes.

Create a local node manually

To create a local node manually, make a new directory and add the following files and sub-directories:

• The Corda JAR artifact file, downloaded from Maven.
• A node configuration file with a name node.conf, configured as described in the Node configuration section.
• A sub-directory with a name cordapps, containing any CorDapp JAR files you want the node to load.
• An up-to-date version of the network-parameters file (see The network map), generated by the bootstrapper tool.

The remaining node files and directories will be generated at runtime. These are described in the Node folder structure section.

Run the database migration script if upgrading

1. Remove any transactionIsolationLevel, initialiseSchema, or initialiseAppSchema entries from the database section of your configuration.
2. Start the node with run-migration-scripts sub-command with --core-schemas and --app-schemas:

java -jar corda.jar run-migration-scripts --core-schemas --app-schemas

The node will perform any automatic data migrations required, which may take some time. If the migration process is interrupted, it can be continued simply by starting the node again, without harm. The node will stop automatically when migration is complete. See Upgrading your node to Corda 4.9 for more information.

Start the node in the normal way

Start the node in the normal way.

Use Cordform or Dockerform to create a set of local nodes automatically

Corda provides two gradle plug-ins: Cordform and Dockerform. They both allow you to run tasks that automatically generate and configure a local set of nodes for testing and demonstration purposes.

• A Cordform task creates nodes in the build/nodes directory. The example Cordform task used in this document creates three nodes: Notary, PartyA, and PartyB, however you are free to spin up more nodes, specify what nodes you need on the network, change node names, and update node configurations.

• Nodes deployed via Dockerform use Docker containers. A Dockerform task is similar to Cordform but it provides an extra file that enables you to easily spin up nodes using docker-compose. This creates a docker-compose file that enables you to run a single command to control the deployment of Corda nodes and databases (instead of deploying each node/database manually).

• For more information about the plugins, visit the Dockerform and Cordform pages.