/commune-node-test

Primary LanguageShell

Running a Commune Node

Requirements

Installing on Ubuntu:

sudo apt install docker.io docker-compose
sudo apt install wget

# Ubuntu has `yq` on apt since 23.04
sudo apt install yq
# On older versions, you can install it with:
sudo wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/bin/yq && \
    sudo chmod +x /usr/bin/yq

Docker Image

We provide the laster Docker image for the Commune node in this Github package at the latest tag. You can pull the image with the command:

docker pull ghcr.io/agicommies/subspace:latest

Chain specs

You can get the chain specs file from the main/specs/main.json file at github.com/commune-ai/subspace:

wget https://raw.githubusercontent.com/commune-ai/subspace/main/specs/main.json

Getting bootnodes

You can get the bootnodes list from the bootnodes field at the commune/modules/subspace/chain/chain.yaml file in github.com/commune-ai/commune.

wget https://raw.githubusercontent.com/commune-ai/commune/main/commune/modules/subspace/chain/chain.yaml

yq '.chain_info.main.boot_nodes[]' chain.yaml -r > bootnodes.txt

Deploying the config

Pick a directory to store the node data, and copy the chain specs and bootnodes:

export COMMUNE_NODE_DIR="/commune-node"

mkdir -p "$COMMUNE_NODE_DIR/specs"

cp main.json "$COMMUNE_NODE_DIR/specs/main.json"
cp bootnodes.txt "$COMMUNE_NODE_DIR/bootnodes.txt"
cp node-start.sh "$COMMUNE_NODE_DIR/node-start.sh"

Running the node

The provided ./docker-compose.yaml file expects the environment variable COMMUNE_NODE_DIR to be set to the node data directory, that will be mounted to /node-data inside the container. It will serve the P2P connection at 30333 and the RPC service at 9933.

docker-compose up -d

By default the node will work in archive mode, which means it will store all the chain data (gigabytes). This can be changed by replacing the --pruning=archive and --sync=full flags with --sync=warp in the docker-compose.yaml script.

References: