LogoLogo
v2.x (Stable)
v2.x (Stable)
  • What is Boost?
  • Features
  • Components
    • boostd
      • Repository
      • GraphQL API
      • JSON-RPC API
      • SQLite metadata database
    • Local Index Directory
      • Index types
      • Dependencies
      • Initialisation
    • boostd-data
    • YugabyteDB
    • booster-http
    • booster-bitswap
    • libp2p Protocols
  • Hardware requirements
    • YugabyteDB
  • Installation
  • New Boost Setup
  • Configuration
    • UI Settings
    • HTTP Transfer limit
    • Deal Filters
    • Remote CommP
    • Legacy Deal configuration
    • HTTP indexer announcement
    • Manual Publish Storage Deal Message
  • Monitoring
    • Setting up a monitoring stack for Boost
  • Storing data on Filecoin
  • Retrieving data from Filecoin
    • HTTP retrieval
    • Advanced Configuration of booster-http
    • Bitswap retrieval
  • Backup and Restore
  • Tutorials
    • How to upgrade from Boost v1 to Boost v2
    • How to re-index unsealed pieces that are flagged by LID in Boost v2
    • How to upgrade from v2.0.0 to v2.1.0
    • How to upgrade from v2.1.x to v2.2.0
    • Start and stop Boost processes
    • How to store files with Boost on Filecoin
    • Using filters for storage and retrieval deals
    • Migrate from Lotus to Boost
    • How to onboard data using DDO deals
  • Troubleshooting
  • Experimental Features
    • FVM Contract Deals
    • Direct Deals
    • Data Segment Indexing
  • FAQ
  • Need help?
Powered by GitBook
On this page
  • Boost compatibility matrix
  • Building and Installing
Edit on GitHub
Export as PDF

Installation

This section details how to compile and install Boost if you are a storage provider or a client

PreviousYugabyteDBNextNew Boost Setup

Last updated 29 days ago

The Boost source code repository is hosted at

Boost compatibility matrix

Boost Version
Lotus Version
Golang Version
Curio Version

< v2.0.0

NA

v2.0.0

v1.23.x

1.20.x

NA

v2.1.0, v2.1.1, v2.1.2

v1.24.x, v1.25.x

1.20.x

NA

v2.2.0

v1.26.0, v1.26.1

1.21.7

NA

v2.3.0

v1.27.x, v1.28.x

1.22.3

1.22.x, 1.23.x

v2.4.0

v1.30.0

1.22.3

1.24.2

v2.4.1

v1.32.0-rc1

1.22.8

1.24.3, 1.24.4

v2.4.2

v1.32.1

1.23.7

NA

v2.4.3

v1.32.2

1.23.7

NA

Building and Installing

Prerequisites

Please make sure you have installed: Go - following

Rust - following

Node 20.x

Linux / Ubuntu

curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash - 
sudo apt-get install -y nodejs
sudo apt install mesa-opencl-icd ocl-icd-opencl-dev gcc git bzr jq pkg-config curl clang build-essential hwloc libhwloc-dev wget -y

macOS

brew install node@20
brew install jq pkg-config hwloc coreutils

Linux

Depending on your architecture, you will want to export additional environment variables:

export RUSTFLAGS="-C target-cpu=native -g"
export FFI_BUILD_FROM_SOURCE=1
git clone https://github.com/filecoin-project/boost
cd boost
git checkout <stable tag or branch>
make clean build
sudo make install

Please ignore any output or onscreen instruction during the npm build unless there is an error.

macOS

export LIBRARY_PATH=$LIBRARY_PATH:/opt/homebrew/lib
git clone https://github.com/filecoin-project/boost
cd boost
git checkout <stable tag or branch>
make clean build
sudo make install

Please ignore any output or onscreen instruction during the npm build unless there is an error.

Calibration Network

To build boost for calibnet, please complete the above pre-requisites and build using the following commands.

git clone https://github.com/filecoin-project/boost
cd boost
git checkout <stable tag or branch>
make clean calibnet

github.com/filecoin-project/boost
https://go.dev/learn/
https://www.rust-lang.org/tools/install
https://boost.filecoin.io/v/v1/getting-started#boost-and-lotus-compatibility-matrix
https://boost.filecoin.io/v/v1/getting-started#boost-and-lotus-compatibility-matrix