Skip to main content


Benefits of operating a Shardeum validator

Earn SHM for securing the network. Contribute to the security, scalability and decentralization of Shardeum.

Minimum Hardware Requirements

  • 250 GB SSD storage
  • Quad core CPU less than 10 years old if self hosting
  • Dual core CPU works if hosted with newer Xeons / EPYC
  • 16 GB of ram, 4+ GB of virtual memory recommended
  • Hosting: 8 GB RAM + 8 GB Virtual Memory

Access the terminal interface for Shell CLI commands:

(Press at the same time)
Ctrl + Alt + T

Install package managers

We will use curl in this tutorial to download files:


Mac comes with curl, so we will install homebrew with curl (which will handle handle packages like apt in Linux).

sudo apt-get install curl

Update package managers

Make sure your packages are up to date first:


When you add sudo to a command, the output will ask for your system password for admin verification.

sudo apt update

Install docker

Install docker with

sudo apt install

Check that docker is working with (should return version 20.10.12 or higher):

docker --version

Install docker-compose

Curl request docker-compose:

sudo curl -L "$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

Setup permissions for docker-compose:

sudo chmod +x /usr/local/bin/docker-compose

Check that docker-compose is working with (should return version 1.29.2 or higher):

docker-compose --version

Shardeum Validator support on Windows will be coming in the future.

Step 2: Download and install validator


curl -O && chmod +x && ./

The terminal will ask questions about your setup settings.

Give permission to collect validator data for bug reporting:

By running this installer, you agree to allow the Shardeum team to collect this data. (y/n)?:

Enter y to setup the web based dashboard:

Do you want to run the web based Dashboard? (y/n):

Set a password for dashboard access:

Set the password to access the Dashboard:

Add a custom session port for the web based dashboard or hit enter for port 8080:

Enter the port (1025-65536) to access the web based Dashboard (default 8080):

Add a custom external IP address or use an automatically detected IP address:

If you wish to set an explicit external IP, enter an IPv4 address (default=auto):

Add a custom internal IP address or use an automatically detected IP address:

If you wish to set an explicit internal IP, enter an IPv4 address (default=auto):

Set the first p2p port (default 9001):

To run a validator on the Sphinx Validator 1.X network, you will need to open two ports in your firewall.
This allows p2p communication between nodes.
Enter the first port (1025-65536) for p2p communication (default 9001):

Set the second p2p port (default 10001):

Enter the second port (1025-65536) for p2p communication (default 10001):

Add a custom path or install to root:

What base directory should the node use (defaults to ~/.shardeum):

Wait for the installation process to complete.


If you are behind a router and you are using ports 9001 and 10001 for p2p communication, make sure ports 9001 and 10001, are forwarded (be careful doing this since it will modify your firewall).

Router port forwarding example with AT&T:

More info on router port forwarding:


Step 3: Open validator CLI

Make sure you are in the root directory by running:


Go to the hidden Shardeum directory:

cd .shardeum

Start the CLI by running the following shell script:


If you see docker container error:

Error response from daemon: Container <container_id_hexadecimal> is not running

start all docker containers until the errors go away:

docker start <container_id_hexadecimal>

If you see docker permission error:

Got permission denied while trying to connect to the Docker daemon socket at
Get "http://%2Fvar%2Frun%2Fdocker.sock/v1.24/containers/shardeum-dashboard/json":
dial unix /var/run/docker.sock:
permission denied


sudo usermod -a -G docker $USER && newgrp docker

if that does not work, also try:

sudo service docker start

then try to start the shell script again.

Step 4: Open validator GUI

Go to your web browser and go to:


You might see a warning page when trying to access this address in your web browser. Ignore this warning and continue to the validator dashboard. Another way to work around this warning:

From the three bar button (hamburger) menu button, go to Settings

Click on “Privacy & Security” on the left.

Scroll down to locate “View Certificates” and click that button.

Click the “Servers” tab, then click “Add Exception”.

Type: “https://localhost:8080” (or your remote/VPS server’s IP and port),
then click “Get Certificate”, then click “Confirm Security Exception”.

The result should be the server/localhost in the list, click “OK”.

Refresh the operator dashboard page and the certificate error should be gone.

You will be asked for your password set during setup.



The login will fail even if you put no password during the setup process. To set a new password inside the validator CLI:

operator-cli gui set password <type_new_password__here>

You should see the “Overview” page for the Shardeum Validator Dashboard in your web browser:


Step 5: Start validator

Go to the “Maintenance” page, then click the “Start Node” button in the top left white box:


(Same as running)

operator-cli start

Wait and refresh the page.

The node is running correctly if the “Start Node” button now says “Stop Node”. If you want to stop tne node with the CLI:

operator-cli stop


Step 6: Monitor validator

Go to “Performance” to see your node’s hardware performance here:


For more details about your node status run the following inside the CLI:

operator-cli status

If your node becomes inactive, try checking its status.

pm2 list

Reset the validator from the list by running:

pm2 delete [id]

Step 7: Connect Wallet to Betanet

Connect to Sphinx Validator 1.X with your wallet by clicking the button linked here

Step 8: Get SHM from Betanet Faucet

Shardeum Discord SHM Faucet for Sphinx 1.X

Step 9: Stake SHM to validator


After you start the validator, go to the “Settings” page. You will be asked to connect your wallet:


After you connect your wallet, you should see the following:


When you click "Add Stake", you will see the following:


-Stake Wallet Address [wallet connected]
-Nominee Public Key [filled in automatically while validator is running]
-Stake amount (SHM) [empty and is in units ether not wei]

This example has filled in 10 SHM tokens to stake.


Stake minimum of 10 SHM per Validator node to earn rewards.

Once all fields are filled, click the “Stake” button.

Your wallet will ask you to sign the transaction stake your SHM.

Once the transaction is signed and complete, you have staked your SHM tokens successfully.


If your node status is on Standby and you have 10 SHM or more staked, your validator node is setup correctly.

The network will automatically add your validator to be active in the network.

The time to be added as an active validator will vary based on network load and validators in the network.


If you have staked before, you can "Remove Stake". However, you will stop getting testnet SHM rewards when you unstake.


If you see your validator IP address as "":

Go into the operator dashboard docker (may be different if you customized install location:

cd ~/.shardeum

Get your node's external IP:


The returned IP in the format of nnn.nnn.nnn.nnn is your EXTERNAL_IP.

Set the number above in place of EXTERNAL_IP:



You can also stake and unstake from the Validator CLI if you are not able to access a web browser for the Validator GUI.

First, set your private key in your Validator CLI:


Be very careful with your private keys. We recommend you use a private key which has testnet tokens only to be safe.

Please note, this is not the recommended method for staking with the Shardeum validator. Mishandling of private key may result in loss of assets. Shardeum discards private key after the transaction is signed. Take precaution when extracting your private key.

export PRIV_KEY=<private_key>

make sure your private key is stored in your Validator CLI by running:

echo $PRIV_KEY

add stake with:

operator-cli stake 10

check your stake amount with:

operator-cli stake_info <wallet_address>

remove stake with:

operator-cli unstake




New validator versions will be released over time. It is necessary to keep your validator updated by checking the minimum version required and your current version periodically.


curl localhost:9001/nodeinfo


  • Stop your validator before updating (you don't need to unstake though)
  • In your terminal, first exit from the container using
cd ..
  • Run the following curl script
curl -O && chmod +x && ./

You might manually have to start the GUI afterwards with:

operator-cli gui start
  • Check your currect version from either CLI or GUI and make sure it is the latest version.

Exit Error Logs

sudo docker exec shardeum-dashboard cat cli/build/logs/exit-summary.json




operator-cli version



operator-cli update


To see all CLI commands, run:

operator-cli help

Uninstall Validator

Useful if your validator is outdated and you want to clean your last installation.

You can delete the validator folder while in your root directory with:

rm -rf .shardeum

You can also delete docker containers and images that the Shardeum validator was using.


These commands will delete all docker images and containers on your computer!

Delete all docker containers:

docker rm -vf $(docker ps -aq)

Delete all docker images:

docker rmi -f $(docker images -aq)