Run a node on a server with Ubuntu

This guide describes how organizations can run a node on the Concordium network from a server and how to set up the node to run as a baker node.

You can also watch the video to learn how to run a node with Ubuntu.

Prerequisites

  • Ubuntu 20.04 must be installed on the server that is running the node.

  • The server must be running around the clock.

  • If you want to run the node as a baker, you must have generated baker keys. You can generate the keys in the Desktop Wallet. See Add a baker account in the Desktop Wallet.

Upgrade from version 1.1.3 to 3.0.0

To upgrade from version 1.1.3 of the concordium-node package to version 3.0.0 of the concordium-testnet-node package you need to:

  • Install the new package

    apt install ./concordium-testnet-node_3.0.0_amd64.deb
    

    This step performs automatic database migration, so that the new node doesn’t have to catch up from scratch. After installation is completed, the node and the collector are started as before.

Install the Debian package and run a node

To run the node, you must install a Debian package. After installation, the concordium-testnet-node and concordium-testnet-node-collector services will be started. The services are also enabled to start automatically on system start.

  1. Download the Debian package

  2. Install the package:

    sudo apt install /path-to-downloaded-package
    

Where path-to-downloaded-package is the location of the downloaded .deb file.

The path should be absolute, e.g., ./concordium-testnet-node.deb, otherwise apt will assume that you want to install a package from the registry.

  1. Enter a node name when prompted. The node name is visible on the network dashboard. When you have installed the services, the concordium-testnet-node will be running automatically.

  2. To verify that the node is running, go to the Concordium dashboard and look for a node with the name you provided.

Note

If the node is installed fresh, you can speed up initial catchup by downloading a batch of blocks and using Out of band catchup. Testnet blocks can be downloaded from catchup.testnet.concordium.com.

The concordium-testnet-node service that you just installed will be running around the clock, except if you’re going to restart the node with baker keys.

Note

If you want more detailed information about building and maintaining a node, or if your node is not running, see the Building .deb packages for ubuntu distributions README from Concordium

Enabling inbound connections

If you are running your node behind a firewall, or behind your home router, then you will probably only be able to connect to other nodes, but other nodes will not be able to initiate connections to your node. This is perfectly fine, and your node will fully participate in the Concordium network. It will be able to send transactions and, if so configured, to bake and finalize.

However you can also make your node an even better network participant by enabling inbound connections. By default, concordium-node listens on port 8888 for inbound connections on Mainnet and on port 8889 for inbount connections on Testnet. Depending on your network and platform configuration you will either need to forward an external port to 8888 or 8889 on your router, open it in your firewall, or both. The details of how this is done will depend on your configuration.

Run a baker node on Ubuntu

The following steps show you how to run a node as a baker on a server that participates in the Concordium network. A node receives blocks and transactions from other nodes and propagates information about blocks and transactions to the nodes in the Concordium network. In addition, a baker node also participates in the lottery and produces its own blocks. If the stake is high enough the baker node also participates in finalization.

Configure the node with baker keys

  1. Move the JSON file with the baker keys you generated in the Desktop Wallet to the server that’s running the node. Store it, for example, in /home/user/concordium/baker-credentials.json.

  2. In the terminal, enter:

    sudo systemctl edit concordium-testnet-node.service
    
  3. Add the following snippet to the opened file (the file is empty the first time you open it):

    [Service]
    
    Environment=CONCORDIUM_NODE_BAKER_CREDENTIALS_FILE=%S/concordium-9dd9ca4d19e9393877d2c44b70f89acbfc0883c2243e5eeaecc0d1cd0503f478/baker-credentials.json
    BindReadOnlyPaths=/home/user/concordium/baker-credentials.json:%S/concordium-9dd9ca4d19e9393877d2c44b70f89acbfc0883c2243e5eeaecc0d1cd0503f478/baker-credentials.json
    

    Where you replace the path /home/user/concordium/baker-credentials.json with the actual location of the file.

  4. Save the edited file.

  5. Restart for the changes to take effect. Enter:

    sudo systemctl restart concordium-testnet-node.service
    
  6. To verify the node is running, enter:

    sudo systemctl status concordium-testnet-node.service
    

Verify that a node is a baker node.

Two epochs must have elapsed before you can see the baker ID of the node on the dashboard.

You can use concordium-client to see the status of the node. For more information, see Concordium Client.

$concordium-client --grpc-port 10001 raw GetNodeInfo

...

Consensus type: "Active"

...

In the Desktop Wallet and the Mobile Wallet, a bread icon is added to the account associated with the baker node. The bread icon appears as soon as the transaction has been submitted. That is, before the two epochs have elapsed.

Support & Feedback

If you have questions or feedback, join us on Discourse, or contact us at support@concordium.software.