Getting Started

The full arweave node functionality is only supported on Linux, but it is possible to run a VDF Server on MacOS. Refer to the mining VDF guide for more information on running your own VDF server.

Linux Dependencies

  • Ubuntu 22 or 24 is recommended

  • OpenSSL development headers

  • GCC or Clang (GCC 8+ recommended)

  • Erlang OTP v26, with OpenSSL support

  • GNU Make

  • CMake (CMake version > 3.10.0)

  • SQLite3 header

  • GNU MP

Erlang R26 is now required. Unfortunately, Ubuntu 22.04 does not natively support Erlang R26 and a PPA repository is required. The RabbitMQ Team is maintaining this release for all Ubuntu version:

# add rabbitmq ppa repository
sudo add-apt-repository ppa:rabbitmq/rabbitmq-erlang-26
sudo apt update

# install required packages
sudo apt install erlang libssl-dev libgmp-dev libsqlite3-dev make cmake gcc g++

On some systems you might need to install libncurses-dev.

MacOS Dependencies

  1. Install Homebrew

  2. Install dependencies

brew install gmp erlang@26 cmake pkg-config
  1. Homebrew may ask you to update your LDFLAGS for erlang: don't. You should however update your PATH as requested.

Clone the repo

$ git clone --recursive https://github.com/ArweaveTeam/arweave.git
$ cd arweave

Configure your system

Run the automated tests

Run your node

Last updated

Was this helpful?