LogoLogo
v1.x (Deprecated)
v1.x (Deprecated)
  • What is Boost?
  • Features
  • Architecture
    • Repository
    • Database
    • DAG store
    • libp2p Protocols
  • Hardware requirements
  • Getting started
    • As a storage provider
    • As a client
  • Migrate from Lotus to Boost
    • Migrate a monolith lotus-miner to Boost
    • Migrate a Lotus markets service process to Boost
    • Roll back to Lotus markets service process
  • Configuration
    • UI Settings
    • HTTP Transfer limit
    • Deal Filters
    • Remote CommP
    • Legacy Deal configuration
    • HTTP indexer announcement
  • Backup and Restore
  • Tutorials
    • How to store files with Boost on Filecoin
    • Using filters for storage and retrieval deals
    • Setting up a monitoring stack for Boost
  • Bitswap Retrieval
  • HTTP Retrieval
    • Serving files with booster-http
  • Troubleshooting
  • Experimental Features
    • FVM Contract Deals
    • Local Index Directory
      • Architecture
      • Requirements
      • Initialisation
  • GraphQL API
  • JSON-RPC API
  • FAQ
  • Need help?
Powered by GitBook
On this page
  • Boost and Lotus compatibility Matrix
  • Building and installing
  • Upgrading Boost
Edit on GitHub
Export as PDF

Getting started

This section details how to get started with Boost if you are a storage provider or as a client

PreviousHardware requirementsNextAs a storage provider

Last updated 1 year ago

The Boost source code repository is hosted at

Boost and Lotus compatibility Matrix

Boost Version
Lotus Version
Golang Version

v1.5.0

v1.18.0

1.18.x

v1.5.1, v1.5.2, v1.5.3

v1.18.0, v1.19.0

1.18.x

v1.6.0, v1.6.1, v1.6.2-rc1

v1.20.x

1.18.x

v1.6.3, v1.6.4

v1.22.x

1.18.x

v1.6.2-rc2, v1.7.0-rc1

v1.21.0-rc1, v1.21.0-rc2

1.20.x

v1.7.0, v1.7.1, v1.7.2

v1.7.3, v1.7.4

v1.23.x

1.20.x

Building and installing

Prerequisites

Please make sure you have installed: Go - following

Rust - following

Node 16.x

Environment Variables in Boost

BOOST_CLIENT_REPO         - repo directory for Boost client
BOOSTER_BITSWAP_REP       - repo directory for Booster bitswap
BOOST_PATH                - boost repo path
FULLNODE_API_INFO         - Lotus daemon node API connection string

Linux / Ubuntu

curl -sL https://deb.nodesource.com/setup_16.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@16
brew install bzr 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

Upgrading Boost

Linux

1. Make sure that Boost daemon is not running. Run the below commands to upgrade the binary.

cd boost
git checkout main
git pull
git checkout <New release>
make clean build
sudo make install

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

3. Start the boost daemon.

MacOS

1. Make sure that Boost daemon is not running. Run the below commands to upgrade the binary.

export LIBRARY_PATH=$LIBRARY_PATH:/opt/homebrew/lib
cd boost
git checkout main
git pull
git checkout <New release>
make clean build
sudo make install

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

3. Start the boost daemon.

github.com/filecoin-project/boost
https://go.dev/learn/
https://www.rust-lang.org/tools/install