Docker Installation

This page will guide you through Docker setup steps.

Install Docker

Install or update Docker to the latest version. Visit the Official Docker website for detailed instructions. Use the command below to find your installed version if needed:

docker --version

Docker and Security Best Practices

General best practices recommend against running the tBTC v2 client as the root user as a security precaution. One security-minded approach is to Run the Docker daemon as a non-root user (Rootless mode).

Next, choose ONE of the following options: Docker Compose makes managing the container simple, but requires an additional step to ensure the container starts after a reboot. The tBTC v2 Service option configures the client to run as a service in order to ensure that the client is restarted automatically, should your machine reboot. The Docker Launch Script is faster to setup, but won't start the client if your machine reboots.

Navigate to cd /home/$USER/keep/

Create a file named docker-compose.yaml

Copy the the template below into the file and replace the <Placeholders> with respective details.

version: '3'
    image: keepnetwork/keep-client:latest
    container_name: keep-client
    restart: on-failure
      - "3919:3919"
      - "9601:9601"
      - /home/$USER/keep/config/:/mnt/keep/config
      - /home/$USER/keep/storage/:/mnt/keep/storage
      - KEEP_ETHEREUM_PASSWORD=<Operator Account keyfile password>
      - LOG_LEVEL=info
        max-size: "100m"
        max-file: "3"
    command: start --ethereum.url "<Ethereum API WS URL>"  --ethereum.keyFile "/mnt/keep/config/<Operator Account keyfile name>" --storage.dir "/mnt/keep/storage" --network.announcedAddresses "/ip4/<PUBLIC_IP_OF_MACHINE>/tcp/3919"

Save and close the file when finished.

To start the tBTC client sudo docker compose up

tBTC will start up with the console output on screen. Verify that the client is running correctly, then press CTRL + c to stop the client.

Restart the client with the 'detach' flag: sudo docker compose up -d

To stop the container at a later time, use sudo docker compose down

Starting Container Automatically After Reboot

To ensure the tBTC container starts after a server reboot, use the template below to create a service in /etc/systemd/system/ called docker-compose-app.service

# /etc/systemd/system/docker-compose-app.service

Description=Docker Compose Application Service

ExecStart=/usr/local/bin/docker-compose up
ExecStop=/usr/local/bin/docker-compose down


Adjust the WorkingDirectory to the path of your tBTC folder. Save and close the file when finished.

use sudo systemctl enable docker-compose-app to enable the service.

The path shown in the example configuration will differ from yours. Make sure it is configured correctly.

Client Startup and Logs

Unless the --detach flag was removed from the startup script, there will be no console output. In order to check your node, retrieve the Docker logs.

First, find your Docker instance identification, it'll be a random combination of words, e.g. stinky_brownie:

sudo docker ps

Use your specific identification and substitute:

sudo docker logs stinky_brownie >& /path/to/output/file

Scroll down about half a page, and you should see the following:

β–“β–“β–Œ β–“β–“ ▐▓▓ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–Œβ–β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–„
β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–Œβ–β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“
  β–“β–“β–“β–“β–“β–“    β–“β–“β–“β–“β–“β–“β–“β–€    ▐▓▓▓▓▓▓    ▐▓▓▓▓▓   β–“β–“β–“β–“β–“β–“     β–“β–“β–“β–“β–“   β–β–“β–“β–“β–“β–“β–Œ   ▐▓▓▓▓▓▓
  β–“β–“β–“β–“β–“β–“β–„β–„β–“β–“β–“β–“β–“β–“β–“β–€      ▐▓▓▓▓▓▓▄▄▄▄         β–“β–“β–“β–“β–“β–“β–„β–„β–„β–„         β–β–“β–“β–“β–“β–“β–Œ   ▐▓▓▓▓▓▓
  β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–€        ▐▓▓▓▓▓▓▓▓▓▓         β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–Œ        ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
  β–“β–“β–“β–“β–“β–“β–€β–€β–“β–“β–“β–“β–“β–“β–„       ▐▓▓▓▓▓▓▀▀▀▀         β–“β–“β–“β–“β–“β–“β–€β–€β–€β–€         ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▀
  β–“β–“β–“β–“β–“β–“   β–€β–“β–“β–“β–“β–“β–“β–„     ▐▓▓▓▓▓▓     β–“β–“β–“β–“β–“   β–“β–“β–“β–“β–“β–“     β–“β–“β–“β–“β–“   β–β–“β–“β–“β–“β–“β–Œ
β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ β–ˆβ–“β–“β–“β–“β–“β–“β–“β–“β–“ ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“  β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“
β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“ ▐▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“  β–“β–“β–“β–“β–“β–“β–“β–“β–“β–“

Trust math, not hardware.
| Keep Client Node                                                                |
|                                                                                 |
| Version: Version: vX.X.X-XX (4d745f6d0)                                         |
|                                                                                 |
| Operator: 0x_your_operator_address                                              |
|                                                                                 |
| Port: 3919                                                                      |
| IPs : /ip4/111.222.333.444/tcp/3919/ipfs/redacted                               |
|                                                                                 |
| Contracts:                                                                      |
| RandomBeacon   : 0x5499f54b4A1CB4816eefCf78962040461be3D80b                     |
| WalletRegistry : 0x46d52E41C2F300BC82217Ce22b920c34995204eb                     |
| TokenStaking   : 0x01B67b1194C75264d06F808A921228a95C765dd7                     |

Congratulations, your node is up and running.

Last updated