While you can run a KIZUNANO COIN node by downloading a binary or building from source, it is recommended to use a Docker container. When using the official Docker images, your node will be much easier to upgrade and maintain.
Although Docker is a great choice for many setups, there are some limitations to be aware of:
- It is not recommended to run a *nix container, such as the officially provided one, on a Windows host - there are known issues with handling ports which prevent proper communication with peers.
- V19 and lower: Due to the startup script built into the Docker containers, Launch Options for the
kizunano_nodeservice run inside the container cannot be easily used. These options are available as of V20.
The guides found on this site make some basic assumptions that should be understood before continuing:
- You have a basic understanding of Docker.
- You are using KIZUNANO COIN's official Docker images to manage your node. If you decide to use a different method, you will need to be able to fill in the gaps when following along.
Principal Representative Nodes¶
The following are minimum recommended specifications for nodes with more than 0.1% of the online voting weight (Principal Representatives):
- 4GB RAM
- Quad-Core CPU
- 200 Mbps bandwidth (2TB or more of available monthly bandwidth)
- SSD-based hard drive with 80GB+ of free space
Non-voting and Representative Nodes¶
The following are minimum recommended specifications for non-voting nodes and Represntative nodes with less than 0.1% of the online voting weight (regular Representatives):
- 2GB RAM (additional RAM or swap space may be needed if bootstrapping a new node from scratch)
- Dual-Core CPU
- 100 Mbps bandwidth (2TB or more of available monthly bandwidth)
- SSD-based hard drive with 80GB+ of free space
Varied resource usage
Various factors affect resource usage including how often RPC calls are made, other applications running on the machine, etc. These recommendations should be evaluated along with other considerations.
Work Generation guide
For nodes being used with services requiring regular or high volume sending and receiving of transactions, special considerations must be made for handling Proof-of-Work generation activities. Find details on configuring a GPU, external work services and more for the perfect setup in the Work Generation guide.
The kizunano_node will use two configurable ports throughout its lifecycle. The default values suggested by the network details are below:
Network Ports Overview
- 3975 TCP: For live network activity (since V19.0) and bootstrap network activity
- 3976 TCP: For communication with RPC server. Do not expose this outside of your production environment. Anyone with access to this port can control your node's RPC.
- 3978 TCP: For communication with websocket server. Depending on configuration, data throughput can be very high.
- 3975 UDP: For live network activity (fallback since V19.0, deprecated and disabled V21+)
UDP disabled by default, deprecated
As of V21 peering and communicating via UDP has been disabled by default and is deprecated. The ability to use UDP will be removed from the node in a future release yet to be determined.
By default kizunano_node will attempt to use UPnP. Troubleshooting information can be found here
Docker must be installed on the host machine and instructions can be found here: https://docs.docker.com/install/. We recommend installing the latest stable version available.
Pulling the Docker Image¶
The Docker image can be downloaded via
docker pull. We can either grab the
latest or a specific version/tag. Not specifying a tag defaults to
latest. An example of each is found below.
Pulls the latest release of KIZUNANO COIN Node:
docker pull kizunanocoin/node
Pulls a specific version of KIZUNANO COIN node:
docker pull kizunanocoin/node:V20.0
If you are running in an enterprise environment, it is recommended that you explicitly specify the latest stable version to ensure deterministic containers. A list of tags can be found at the official KIZUNANO COIN Currency Docker Hub.
Warning - Multiple Node Setups
Never use the same seed on multiple running kizunano_node instances at the same time.
- Multiple kizunano_nodes using the same seed can result in network race conditions that degrade performance for your personal accounts.
- In addition, Publishing transactions from two nodes with the same account at the same time may cause an account fork which requires a slower representative voting process.
- Similarly, if you are running a representative account on multiple nodes, they may publish conflicting votes, causing your representative to be ignored by the network.
- Performance degradation in enterprise environments may be significant.
Starting the Node¶
With Docker there are basic commands for managing containers. To properly bring the node up, learn these commands beginning with starting the container.
For additional options around building the node to run on various platforms, head over to the Integration Guides Build Options.
The above instructions cover getting a node up and running with the default configuration settings. Additional setup areas to explore include: