Run Sui Node using Docker Compose

Tested using:

• ubuntu 20.04 (linux/amd64) on bare metal
• ubuntu 22.04 (linux/amd64) on bare metal

Prerequisites and Setup

1. Confirm you have either Docker Engine or Docker Desktop installed, as well as Docker Compose.

2. Update validator.yaml and place it in the same directory as docker-compose.yaml.

Add the paths to your private keys to validator.yaml. If you chose to put them in /opt/sui/key-pairs, you can use the following example:

protocol-key-pair:
  path: /opt/sui/key-pairs/protocol.key
worker-key-pair: 
  path: /opt/sui/key-pairs/worker.key
network-key-pair: 
  path: /opt/sui/key-pairs/network.key

3. Place genesis.blob in the same directory as docker-compose.yaml. (available post genesis ceremony)

Connectivity

You may need to explicitly open the ports outlined in Sui for Node Operators for the required Sui Node connectivity.

Start the node

Start Sui Node in detached mode:

sudo docker compose up -d

Logs

By default, logs are stored at /var/lib/docker/containers/[container-id]/[container-id]-json.log.

• View and follow

sudo docker compose logs -f validator

• By default all logs are output, limit this using --since

sudo docker logs --since 10m -f validator

Storage

• What is the size of the local Sui database?

# get the volume location on disk
sudo docker volume inspect docker_suidb
# get the size of the volume on disk
sudo du -sh /var/lib/docker/volumes/docker_suidb/_data

• Delete the local Sui databases (volume)

sudo docker-compose down -v

Updates

• DO NOT delete the Sui databases

1. Stop docker compose

sudo docker compose down

2. Update docker-compose.yaml to reference the new image

-    image: mysten/sui-node:<OLD_SUI_SHA>
+    image: mysten/sui-node:<NEW_SUI_SHA>

3. Start docker compose in detached mode:

sudo docker compose up -d