For the complete documentation index, see llms.txt. This page is also available as Markdown.

Getting Started

Setup and run your first Arweave miner

This guide walks you through planning, installing, and bringing an Arweave miner online for the first time.

For any questions and support queries regarding mining on Arweave, we strongly recommend that you join our Discord server and visit our Discussions Board as these are the hubs of our mining and developer communities. There you will find plenty of community members and Arweave team members available to help you out 🤖

1. Choose Your Node Type

Decide whether you are running a solo miner, coordinated miner, pool miner, VDF server, or validator.

2. Plan Your Hardware

Size CPU, memory, storage, and network based on your chosen role.

3. Configure the Operating System

Configure your operating system for Arweave workloads.

4. Install the Arweave Node

Install the node software either from pre-built binaries or by building from source, and verify the installation.

5. Setup Your Directory Structure

Create the directories and links for your data_dir and storage modules.

6. Create Your Node Wallet

All nodes need a configured wallet (aka mining key), if you don't specify one it will be created for you. If you're not mining, this default wallet is probably fine. For miners:

7. Configure and Run Your Node

Depending on your node type, operating phase, and different elements of your hardware and system configuration you will want to run your node with a different set of configuration options. We've provided a few examples in the Node Configuration Guide to get you started.

8. Learn, Iterate, and Optimize

After you get your node running, we recommend familiarizing yourself with the rest of the Mining Guide, joining the Discord Server, and reviewing the Discussions Board. There is a lot to learn and you will likely hit issues as you ramp up and tune your Arweave node - hopefully these resources will help you through it.

Thank you for supporting the Permaweb!

Last updated

Was this helpful?