Boost
Boost is a tool for Filecoin storage providers to manage data storage and retrievals on Filecoin.
See the docs at https://boost.filecoin.io to get started.
Table of Contents
- Building and Installing Boost
- Running Boost devnet in Docker
- External Contribution Guidelines
- License
Building and Installing Boost
Compile and install using the instructions at the Building and installing
section in the docs.
Running Boost devnet in Docker for development
Prerequisites
- Install Docker - https://docs.docker.com/get-docker/
Building Docker images
- Build images from the root of the Boost repository
make clean docker/all
If you need to build containers using a specific version of lotus then provide the version as a parameter, e.g. make clean docker/all lotus_version=v1.23.3
. The version must be a tag or a remote branch name of Lotus git repo.
If the branch or tag you requested does not exist in our Github image repository then you can build the lotus image manually with make clean docker/all lotus_version=test/branch1 build_lotus=1
. We are shipping images all releases from Lotus in our Github image repo.
Start devnet Docker stack
- Run
make devnet/up
It will spin up lotus
, lotus-miner
, boost
, booster-http
and demo-http-server
containers. All temporary data will be saved in ./docker/devnet/data
folder.
The initial setup could take up to 20 min or more as it needs to download Filecoin proof parameters. During the initial setup, it is normal to see error messages in the log. Containers are waiting for the lotus to be ready. It may timeout several times. Restart is expected to be managed by docker
.
- Try opening the Boost GUI http://localhost:8080 . Devnet is ready to operate when the URL opens and indicates no errors on the startup page.
You can inspect the status using cd docker/devnet && docker compose logs -f
.
Start monitoring docker stack
docker plugin install grafana/loki-docker-driver:latest --alias loki --grant-all-permissions
cd docker/monitoring
docker compose up -d
Connect monitoring stack to devnet stack
docker network connect devnet tempo
docker network connect devnet prometheus
Explore Grafana / Tempo and search for traces
http://localhost:3333 (username: admin
; password: admin
)
Making a deal
The boost
container is packed with boost
and lotus
clients. You can connect to the container with the command docker compose exec boost /bin/bash
and follow instructions for storing files with Boost guide. But the recommended startup is to follow the semi-interactive demo first:
# Attach to a running boost container
make devnet/exec service=boost
# Execute the demo script /app/sample/make-a-deal.sh
root@83260455bbd2:/app# ./sample/make-a-deal.sh
You can also generate, dense, random cars and automatically make deals by leveraging the script at ./docker/devnet/boost/sample/random-deal.sh
. See the scripts comments for usage details.
Accessing Lotus from localhost
By default the docker-compose.yaml does not expose any port of the lotus
container. To access the lotus
from a local machine:
- You can either expose
1234
in docker-compose.yaml or find the IP of thelotus
container usingdocker inspect lotus | grep IPAddress
command. - Get the
FULLNODE_API_INFO
docker exec -it lotus lotus auth api-info --perm=admin
FULLNODE_API_INFO=eyJ...ms4:/dns/lotus/tcp/1234/http
docker exec -it lotus-miner lotus-miner auth api-info --perm=admin
MINER_API_INFO=eyJ...UlI:/dns/lotus-miner/tcp/2345/http
- Change the
dns/lotus/tcp/1234/http
toip4/<127.0.0.1 or container's IP>/tcp/1234/http
for the use inFULLNODE_API_INFO
.
Cleaning up
To stop containers and drop everything:
make devnet/down
rm -rf ~/.cache/filecoin-proof-parameters
External Contribution Guidelines
If you want to contribute to the Boost project, please refer to these guidelines.
License
Dual-licensed under MIT + Apache 2.0