mutedtommy/keep-client repository overview

To run the Keep Beacon docker image on ARM devices (ARMv7/ARM64) follow these steps.

⁠Pull the docker image

sudo docker pull mutedtommy/keep-client:tag-name

⁠Set the following environment parameters

export KEEP_CLIENT_PERSISTENCE_DIR=<path of “persistence” directory for keep-client on your device>
export KEEP_CLIENT_CONFIG_DIR=<path of “config” directory containing config toml file for keep-client on your device>
export KEEP_CLIENT_KEYSTORE=<path of directory containing ethereum operator waller for beacon node>
export KEEP_CLIENT_ETHEREUM_PASSWORD=<password for unlocking ethereum wallet>

⁠Setup the config.toml file

#Ethereum host connection info.
[ethereum]
URL = "wss://"
URLRPC = "https://"
#Keep operator Ethereum account.
[ethereum.account]
Address = "operator wallet address"
KeyFile = "/mnt/keep-client/keystore/ethereum operator wallet file name"
#Keep contract addresses configuration.
[ethereum.ContractAddresses]
#Hex-encoded address of KeepRandomBeaconOperator contract
KeepRandomBeaconOperator = "0x440626169759ad6598cd53558F0982b84A28Ad7a"
#Hex-encoded address of TokenStaking contract
TokenStaking = "0xEb2bA3f065081B6459A6784ba8b34A1DfeCc183A"
#Hex-encoded address of KeepRandomBeaconService contract. Only needed
#in cases where the client's utility functions will be used (e.g., the
#relay subcommand).
KeepRandomBeaconService = "0xF9AEdd99357514d9D1AE389A65a4bd270cBCb56c"
#Keep network configuration.
[LibP2P]
Peers = ["/dns4/bootstrap-1.test.keep.network/tcp/3919/ipfs/16Uiu2HAm3eJtyFKAttzJ85NLMromHuRg4yyum3CREMf6CHBBV6KY",
"/dns4/bootstrap-2.test.keep.network/tcp/3919/ipfs/16Uiu2HAmNNuCp45z5bgB8KiTHv1vHTNAVbBgxxtTFGAndageo9Dp",
"/dns4/bootstrap-3.test.keep.network/tcp/3919/ipfs/16Uiu2HAm8KJX32kr3eYUhDuzwTucSfAfspnjnXNf9veVhB12t6Vf",
"/dns4/bootstrap-4.test.keep.network/tcp/3919/ipfs/16Uiu2HAkxRTeySEWZfW9C83GPFpQUXvrygmZryCN6DL4piZrbAv4"]
Port = 3920
#Override the node's default addresses announced in the network
AnnouncedAddresses = ["/ip4/public IP of your device running the beacon node/tcp/3919"]
#Storage is encrypted
[Storage]
DataDir = "/mnt/keep-client/persistence"

⁠Run the docker image using the following command

docker run -dit \ --entrypoint /usr/local/bin/keep-client \ --volume $KEEP_CLIENT_PERSISTENCE_DIR:/mnt/keep-client/persistence \ --volume $KEEP_CLIENT_CONFIG_DIR:/mnt/keep-client/config \ --volume $KEEP_CLIENT_KEYSTORE:/mnt/keep-client/keystore \ --env KEEP_ETHEREUM_PASSWORD=$KEEP_CLIENT_ETHEREUM_PASSWORD \ --env LOG_LEVEL=debug \ -p 3919:3919 \ mutedtommy/keep-client:latest --config /mnt/keep-client/config/config.toml start

⁠Check if the container is running using

sudo docker ps -a

⁠Check the container logs using

sudo docker logs -f container-id