Local Docker Development

In this section we will cover how to deploy a NEO•ONE Node locally using the NEO•ONE Node Docker image.

If you are unfamiliar with Docker or do not have a version installed locally visit their getting started page.

---

---

Requirements

• Docker
  • Minimum: at least 2GB Memory, 1cpu, and 50GB Storage allocated
  • Recommended: 4GB Memory, 2cpu, and 60GB+ Storage allocated (if you plan to deploy to a cluster you will need this for each pod/container)

Getting Started

NEO•ONE pushes a new node image to dockerhub every time a new version is published. We publish a new node image with each commit as well as tagged versions for official releases. We recommend using the most recent tagged version, such as neoonesuite/node:neo-one-node-binv2.3.0.

After you have installed Docker, run the following in a terminal:

docker pull neoonesuite/node
docker run neoonesuite/node

Voila! You should now be running the most recent NEO•ONE Node in a local docker container and will see logs to confirm it has started. Since the NEO•ONE Node uses pino for logging we recommend piping the logs through pino-pretty during development. Note that the node won’t begin syncing with the blockchain until additional configuration is provided.

Configuring

There are several ways to configure the node; any rc type configuration is accepted. as an example we can set the logger level of the node to trace using either:

docker run neoonesuite/node --telemetry.logging.level=trace

or through environment variables

docker run -e neo-one_telemetry__logging__level=trace neoonesuite/node

Additionally you have the option of creating a config (no extension) file and mounting it directly to the container. By default the node will look for a config at /etc/neo-one.

So if we have a config

## /path/to/config
{
  "telemetry": {
    "logging": {
      "level": "trace"
    }
  }
}

located at /path/to/config we could mount this to the default location as:

docker run -v /path/to:/etc/neo-one/ neoonesuite/node

(Note that you must mount the entire folder the config file is in)

After running any the above you should see more logging on startup! For more configuration options see the configuration reference.

Storage

Similarly to how we can mount a configuration folder to the container for local testing we can also mount a folder for storing the blockchain data our node will collect. By default, the node will use /root/.local/share/neo-one as its storage. We can mount a local folder /path/to/node-data/ using

docker run -v /path/to/node-data:/root/.local/share/neo-one neoonesuite/node

This is helpful when testing locally as you won’t have to re-sync your node-data on every restart.

Port Publishing

By default the container will be able to access external resources, such as connecting and syncing with other relay nodes after setting node.rpcURLs.

If you would like your local Docker container to be able to send its own data, you’ll need to publish the port using docker commands. As an example we can enable node metrics using the following command:

docker run -p 8001:8001 neoonesuite/node --telemetry.port=8001

Upon visiting localhost:8001/metrics you should now see the node-metrics page.

Note

By default metrics are disabled so you must include the --telemetry.port=8001 argument or provide a telemetry port through other means of configuration (see above).

Examples

The following configurations should be a solid jumping off point for working with the node. For each of the three examples here we will also show how to implement them using Docker Compose.

In all three examples we will use

docker run -v /node-config/:/etc/neo-one/ -v /node-data/:/root/.local/share/neo-one neoonesuite/node

to mount our configuration and local data file before starting the node. Go ahead and create the two folders node-config and node-data if you would like to follow along.

Sync

To sync your node with other nodes on the network, you must specify them using the node.rpcURLs configuration setting. A list of current mainnet nodes can be found at: http://monitor.cityofzion.io/

#/node-config/config
{
  "node": {
    "rpcURLs": [
      "http://seed6.ngd.network:10332",
      "http://node1.nyc3.bridgeprotocol.io:10332"
    ]
  }
}

Now, if we apply this configuration we can begin to request block information from other nodes. After saving this to node-config/config, run the command listed above.

Upon successfully starting the node, you should begin to see relay_block events!

Note

Its worth mentioning that syncing the entire blockchain can take a very long time. If you plan on syncing/restoring multiple times it might be worth creating a backup of your node-data folder.