Quickstart

In this guide we’re going to learn how to go from zero to a running Dolos instance with the least amount of effort.

1. Installation

   mac

   You can use Homebrew to install the latest version of Dolos in Mac (both x86 / ARM64)

   brew install txpipe/tap/dolos

   linux

   You can install Dolos on linux system using the following command:

   curl --proto '=https' --tlsv1.2 -LsSf https://github.com/txpipe/dolos/releases/latest/download/dolos-installer.sh | sh

   windows

   You can use Powershell to install Dolos on Windows systems:

   powershell -c "irm https://github.com/txpipe/dolos/releases/latest/download/dolos-installer.ps1 | iex"

   docker

   Dolos provides public Docker images through Github Packages. To execute Dolos via Docker, use the following command:

   docker run ghcr.io/txpipe/dolos:latest

   For more detailed information on how to install Dolos, check the installation section

2. Configuration

   To configure Dolos, run the following command that will guide you through a set of questions to automatically configure your instance:

   dolos init

   For more detailed information on how to configure Dolos, check the configuration section

3. Bootstrap

   To bootstrap Dolos (aka: sync the history of the chain), run the following command to import a Mithril snapshot:

   dolos bootstrap

   For more detailed information on how to bootstrap Dolos, check the bootstrap section

4. Running

   Run the following command to start Dolos in daemon mode. This will keep runnig forever while syncing the chain from the upstream node and serving data through the APIs.

   dolos daemon

   For more detailed information on different ways to run Dolos, check the running section