Skip to content
Amaru Docs

Installation Instructions

Installation

Section titled “Installation”

The easiest to get started with Amaru is by downloading one of the pre-compiled executable.

linux x86_64
nightly

linux aarch64
nightly

macos aarch64
nightly

Quick Start

Section titled “Quick Start”

  1. Bootstrap the node

    Section titled “Bootstrap the node”

    Amaru requires snapshots to start as it doesn’t re-validate historical data.

    Terminal window
    amaru bootstrap --network=preprod

    This command downloads pre-packed snapshots for Amaru, and import them into Amaru’s local storage.

  2. (Optional) Setup observability backends

    Section titled “(Optional) Setup observability backends”

    Amaru doesn’t have a graphical user interface out of the box, but it has telemetry. So, in addition to logs printed out on the terminal, you can run one an observability backend to collect and process the telemetry.

    Terminal window
    docker-compose -f monitoring/jaeger/docker-compose.yml up
    export AMARU_WITH_OPEN_TELEMETRY=true

    This is only one example, you can also look into Amaru-doctor as a lean alternative.

  3. Run Amaru

    Section titled “Run Amaru”

    Then simply run the Amaru daemon. This assumes a local peer on 127.0.0.1:3001 but you can put any valid peer address here. You can also repeat the --peer option should you want to add multiple peers.

    Terminal window
    amaru daemon --network=preprod --peer-address 127.0.0.1:3001

    This will run Amaru from the snapshot onwards. You can interrupt it at any time using a SIGINT (Ctrl+C). It’ll resume back to where it was on restart.