Skip to content

Commit

Permalink
GITBOOK-29: devnet docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LexLuthr authored and gitbook-bot committed Oct 23, 2024
1 parent 843274b commit 82c295b
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
1 change: 1 addition & 0 deletions documentation/en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@
* [Curio](curio-cli/curio.md)
* [Sptool](curio-cli/sptool.md)
* [API](api.md)
* [Docker Devnet](docker-devnet.md)
* [Experimental Features](experimental-features/README.md)
* [GPU Over Provisioning](experimental-features/gpu-over-provisioning.md)
48 changes: 48 additions & 0 deletions documentation/en/docker-devnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
description: How to run a local network with Curio using docker
---

# Docker Devnet

## Prerequisites

To ensure a stable and functional network, the Curio devnet requires running multiple binaries in parallel. To simplify this process, we have packaged the devnet using Docker. Please make sure to install the latest version of Docker on your system before proceeding.

* Install Docker - [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)

## Building Docker images

Build images from the root of the Curio repository

```
make clean docker/devnet
```

* If you need to build containers using a specific version of lotus then provide the version as a parameter. The version must be a tag of [Lotus git repo](https://github.com/filecoin-project/lotus). We are shipping images for all releases from Lotus in our [Github image repo](https://github.com/filecoin-shipyard/lotus-containers/pkgs/container/lotus-containers).\


```bash
make clean docker/devnet lotus_version=v1.29.2
```

\

* If the branch or tag you requested does not exist in our [Github image repository](https://github.com/filecoin-shipyard/lotus-containers/pkgs/container/lotus-containers) then you can build the lotus image manually.\


```bash
make clean docker/devnet lotus_version=test/branch1 build_lotus=1
```

## Start devnet Docker stack

* Run

```
make devnet/up
```
* It will spin up `lotus`, `lotus-miner`, `yugabyte` and `curio` containers. All temporary data will be saved in `./docker/data` folder.
* The initial setup could take up to 5 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 Curio GUI [http://localhost:4701](http://localhost:4701) . 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`.

0 comments on commit 82c295b

Please sign in to comment.