> For the complete documentation index, see [llms.txt](https://boost.filecoin.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boost.filecoin.io/getting-started.md).

# Installation

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

The Boost source code repository is hosted at [github.com/filecoin-project/boost](https://github.com/filecoin-project/boost)

### Boost compatibility matrix

| Boost Version          | Lotus Version                                                                         | Golang Version                                                                        | Curio Version  |
| ---------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -------------- |
| < v2.0.0               | <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> | 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             |
| v2.4.4                 | v1.34.0                                                                               | 1.24.7                                                                                | NA             |
| v2.4.6                 | v1.34.1                                                                               | 1.24.7                                                                                | NA             |
| v2.4.7                 | v1.34.1                                                                               | 1.24.7                                                                                | NA             |
| v2.4.8                 | v1.35.0                                                                               | 1.24.7                                                                                | NA             |
| v2.5.0                 | v1.35.0                                                                               | 1.25.0                                                                                | NA             |
| v2.5.1                 | v1.35.1                                                                               | 1.26.2                                                                                | NA             |
| v2.5.2                 | v1.36.0                                                                               | 1.26.2                                                                                | NA             |

### Building and Installing

#### Prerequisites

{% hint style="warning" %}
Please make sure you have installed:\
\
**Go** - following <https://go.dev/learn/>

**Rust** - following <https://www.rust-lang.org/tools/install>

**Node 24.x**
{% endhint %}

**Linux / Ubuntu**

```
curl -sL https://deb.nodesource.com/setup_24.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@24
brew install jq pkg-config hwloc coreutils
```

#### Linux

{% hint style="warning" %}
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
```

{% endhint %}

```
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
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boost.filecoin.io/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.