Run a Node with Docker
This guide outlines the process of setting up and operating a KUB node using Docker. Docker provides a streamlined and efficient method for running KUB Mainnet nodes, including Validator Node, Full Node, and Archive Node configurations.
Core Components
Running a KUB node using Docker is designed to simplify node deployment by providing pre-configured Docker Compose setups. It encapsulates all the essential services required to run various types of KUB Mainnet nodes, ensuring a quick and reliable deployment.
Prerequisites
Before you begin, ensure you have the following software installed on your system:
Docker: A platform for developing, shipping, and running applications in containers.
Docker Compose: A tool for defining and running multi-container Docker applications.
Getting Started
Initial Setup
To initiate the node deployment, you'll first need to clone the bkc-node-docker
repository and navigate into the mainnet
directory, which contains the specific configurations for the KUB Mainnet.
git clone https://github.com/kub-chain/bkc-node-docker
cd bkc-node-docker/mainnet
Node Configuration Approach
Unlike some other blockchain node setups that rely on .env
files for configuration, bkc-node-docker
adopts a different strategy. It provides distinct docker-compose
files tailored for each node type.
This approach simplifies configuration by allowing you to select the appropriate docker-compose
file directly when launching your node, eliminating the need for extensive environment variable management.
Launching Your KUB Node
Once you've successfully navigated to the bkc-node-docker/mainnet
directory, you can proceed to launch your desired KUB node type using the respective Docker Compose command. These commands will start the node services in the background, allowing them to run continuously.
docker compose -f docker-compose.validator.yaml up -d
Managing Your KUB Node
Docker Compose provides robust tools for interacting with and managing the various containers that comprise your KUB node.
Monitoring Node Status
The bkc-node-docker
setup includes integrated monitoring solutions to help you keep track of your node's health and synchronization progress.
Grafana Monitoring Dashboard
A Grafana dashboard is available for detailed monitoring and visualization of your node's metrics. Access it by navigating to http://localhost:8080
in your web browser.
Default Username:
admin
Default Password:
admin
Stats Dashboard
For a more concise overview of your node's operational statistics, you can access the Stats Dashboard at http://localhost:8090
in your browser.
Last updated