Mac

Guide for running the Taraxa Node with Docker on Mac

These instructions are specific to Mac. Instructions are also available for Windows and Linux.

1. Download Docker Desktop

You can download Docker Desktop by accessing this link for Intel Macs or this link for Apple chip Macs.

Download Docker Desktop

After the download finishes you can find the dmg file in the Downloads directory on the Dock.

Downloaded Docker Desktop

Open the Docker.dmg file.

Open Docker Desktop

You should see a window similar to the following. Drag and drop the Docker app file into the Applications folder.

Install Docker Desktop

You may get a notice like this because the app was downloaded from the web and not installed from the App Store. You can safely click "Open" here.

Confirm Docker Desktop

Docker also needs some privileges to install the Docker Helper. Click "OK" and enter your password.

Confirm Docker Desktop

Now you can open Finder and go to the Applications folder. You should see the Docker app.

NOTE: You can also press CMD + SPACE and search for Docker

Open Docker

After opening the application you should see a screen similar to this:

Starting Docker

When Docker starts you should see this screen. We can close the Docker window now.

Docker Started

2. Open Terminal

We need to use the Terminal application in order to start the Taraxa Node image.

You can find the app in the Utilities directory under Applications.

Open Utilities

Open the terminal application.

NOTE: You can also press CMD + SPACE and search for Terminal

Open Terminal

You should see a window similar to this:

Terminal Open

3. Start Taraxa

We have to run the following commands one by one:

cd ~/Desktop
curl -L https://github.com/Taraxa-project/taraxa-ops/archive/refs/heads/master.zip > master.zip && unzip master.zip && rm -f master.zip

GitHub is blocked in some countries. If you can't run the previous command please refer to the GitHub is blocked document.

cd ~/Desktop/taraxa-ops-master/taraxa_compose
docker-compose up -d
docker-compose logs -f

Now Docker is pulling the Taraxa Node image. You should see something similar to this:

Starting Taraxa

After it finishes pulling the latest version the node will start and you should see something similar to the following:

Taraxa Started

NOTE: You can press CTRL + C to stop displaying the logs

4. Updating the Taraxa Node

From time to time we will release new versions of the node software. Try to keep it up to date using the following commands:

cd ~/Desktop/taraxa-ops-master/taraxa_compose
curl -0 https://raw.githubusercontent.com/Taraxa-project/taraxa-ops/master/taraxa_compose/docker-compose.yml > docker-compose-new.yml && mv docker-compose-new.yml docker-compose.yml

GitHub is blocked in some countries. If you can't run the previous command please refer to the GitHub is blocked document.

docker-compose down
docker-compose pull
docker-compose up -d
docker-compose logs -f

During the testing period, we will also make changes on the protocol level and you will have to re-sync all the data. Don't worry, we will let you know. To remove the current data and do a full re-sync you have to run the following commands:

cd ~/Desktop/taraxa-ops-master/taraxa_compose
docker-compose down -v
docker-compose pull
docker-compose up -d
docker-compose logs -f