Skip to content

Commit 82c295b

Browse files
LexLuthrgitbook-bot
authored andcommitted
GITBOOK-29: devnet docs
1 parent 843274b commit 82c295b

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

documentation/en/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,6 @@
2626
* [Curio](curio-cli/curio.md)
2727
* [Sptool](curio-cli/sptool.md)
2828
* [API](api.md)
29+
* [Docker Devnet](docker-devnet.md)
2930
* [Experimental Features](experimental-features/README.md)
3031
* [GPU Over Provisioning](experimental-features/gpu-over-provisioning.md)

documentation/en/docker-devnet.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
description: How to run a local network with Curio using docker
3+
---
4+
5+
# Docker Devnet
6+
7+
## Prerequisites
8+
9+
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.
10+
11+
* Install Docker - [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
12+
13+
## Building Docker images
14+
15+
Build images from the root of the Curio repository
16+
17+
```
18+
make clean docker/devnet
19+
```
20+
21+
* 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).\
22+
23+
24+
```bash
25+
make clean docker/devnet lotus_version=v1.29.2
26+
```
27+
28+
\
29+
30+
* 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.\
31+
32+
33+
```bash
34+
make clean docker/devnet lotus_version=test/branch1 build_lotus=1
35+
```
36+
37+
## Start devnet Docker stack
38+
39+
* Run
40+
41+
```
42+
make devnet/up
43+
```
44+
45+
* It will spin up `lotus`, `lotus-miner`, `yugabyte` and `curio` containers. All temporary data will be saved in `./docker/data` folder.
46+
* 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`.
47+
* 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.
48+
* You can inspect the status using `cd docker/devnet && docker compose logs -f`.

0 commit comments

Comments
 (0)