Installation overview

You can install Grandine in four ways. All of them give you the same grandine binary with the same options.

MethodBest forPage
Pre-built binaryMost Linux, macOS and Windows users who run Grandine directly or under systemdPre-built binaries and Docker
Docker imageUsers who run their node with their own Docker or Docker Compose setupPre-built binaries and Docker
Eth DockerStakers who want a ready-made Docker Compose setup that also runs the execution client, MEV-Boost and key managementRunning with Eth Docker
Build from sourceDevelopers, unusual platforms, custom features, or users who want to audit what they runBuilding from source

Before you install, check the System requirements.

Which version to install

Grandine has two release channels:

  • Stable releases have plain version tags such as 3.0.0. Use them on Mainnet.
  • Unstable builds come from the develop branch and from pre-release tags such as 3.0.0-rc.0. They get new features and fixes first, and suit testnets and testing.

See Updating Grandine for how releases are published and how to upgrade.

Supported platforms

PlatformBinaryDocker
Linux x86-64YesYes (linux/amd64)
Linux ARM64YesYes (linux/arm64)
macOS IntelYesNo
macOS Apple siliconYesNo
Windows x86-64YesNo

Binaries are attached to every GitHub release. Builds of the develop branch are published only as the unstable Docker image, so on macOS and Windows the newest unstable code requires building from source.

After installing

  1. Check the version:

    grandine --version

    It prints the application name and version, for example Grandine 3.0.0.

  2. List the options:

    grandine --help

  3. Follow the Quick start to run an execution client and Grandine together.

  4. Set Grandine up as a long-running service with Running as a service.