Skip to content

Latest commit

 

History

History
145 lines (98 loc) · 2.99 KB

install.md

File metadata and controls

145 lines (98 loc) · 2.99 KB
title sidebar_position
Installing
2

import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem";

To install Forest from pre-compiled binaries, please refer to the releases page, or consider using Docker.

Verifying the installation

Ensure that Forest was correctly installed.

forest --version

Sample output:

forest-filecoin 0.19.0+git.671c30c

Nix Flake

To install Forest as a Nix flake:

nix profile install github:ChainSafe/forest

This will make the forest, forest-cli, forest-tool, and forest-wallet commands available in your shell.

forest --version

Sample output:

forest-filecoin 0.19.0+git.671c30c

Images

Images are available via Github Container Registry:

ghcr.io/chainsafe/forest

:::tip If you have trouble using the Github Container Registry, make sure you are authenticated with your Github account. :::

You will find tagged images following these conventions:

  • latest - latest stable release
  • vx.x.x - tagged versions
  • edge - latest development build of the main branch
  • date-digest (e.g., 2023-02-17-5f27a62) - all builds that landed on the main branch

A list of available images can be found here.

Basic Usage

Running the Forest daemon:

docker run --init -it --rm ghcr.io/chainsafe/forest:latest --help

Using forest-cli:

docker run --init -it --rm --entrypoint forest-cli ghcr.io/chainsafe/forest:latest --help

:::note More information about Docker setup and usage can be found in the Docker documentation. :::

Dependencies

  • Rust compiler (install via rustup)
  • OS Base-Devel/Build-Essential
  • Clang compiler
  • Go for building F3 sidecar module

For Ubuntu, you can install the dependencies (excluding Rust) with:

sudo apt install build-essential clang

Compilation & installation

Option 1: From crates.io (latest release)

cargo install forest-filecoin

Option 2: From repository (latest development branch)

git clone --depth 1 https://github.com/ChainSafe/forest.git && cd forest
make install

Both approaches will compile and install forest and forest-cli to ~/.cargo/bin. Make sure you have it in your PATH.

Verifying the installation

Ensure that Forest was correctly installed.

forest --version

Sample output:

forest-filecoin 0.19.0+git.671c30c