Skip to content

Commit 333eb3a

Browse files
TippyFlitsUKjennijuju
authored andcommitted
GITBOOK-5: No subject
1 parent e2e0ef3 commit 333eb3a

File tree

3 files changed

+198
-0
lines changed

3 files changed

+198
-0
lines changed
17.9 KB
Binary file not shown.

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@
8484
* [Prerequisites](storage-providers/pdp/prerequisites.md)
8585
* [Install & Run Lotus](storage-providers/pdp/install-and-run-lotus.md)
8686
* [Install & Run YugabyteDB](storage-providers/pdp/install-and-run-yugabytedb.md)
87+
* [Install & Run Curio](storage-providers/pdp/install-and-run-curio.md)
8788

8889
## Nodes
8990

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
---
2+
description: >-
3+
Curio is the core PDP client that coordinates sealing, interacts with Lotus
4+
and submits PDP proofs.
5+
---
6+
7+
# Install & Run Curio
8+
9+
<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="https://docs.curiostorage.org/">Curio Documentation</a></td><td><a href="../../.gitbook/assets/Curio_placeholder.webp">Curio_placeholder.webp</a></td></tr><tr><td><a href="https://filecoinproject.slack.com/archives/C06LF5YP8S3">Filecoin Slack - #fil-curio-help</a></td><td><a href="../../.gitbook/assets/Filecoin.svg.png">Filecoin.svg.png</a></td></tr></tbody></table>
10+
11+
### System Configuration
12+
13+
Before you proceed with the installation, you should increase the UDP buffer size:
14+
15+
```sh
16+
sudo sysctl -w net.core.rmem_max=2097152
17+
sudo sysctl -w net.core.rmem_default=2097152
18+
```
19+
20+
To make this change persistent across reboots:
21+
22+
```sh
23+
echo 'net.core.rmem_max=2097152' | sudo tee -a /etc/sysctl.conf
24+
echo 'net.core.rmem_default=2097152' | sudo tee -a /etc/sysctl.conf
25+
```
26+
27+
### Build Curio
28+
29+
Clone the repository and switch to the PDP branch:
30+
31+
```sh
32+
git clone https://github.com/filecoin-project/curio.git
33+
cd curio
34+
git checkout feat/pdp
35+
```
36+
37+
{% hint style="info" %}
38+
Curio is compiled for a specific Filecoin network at build time. Choose the appropriate build command below.&#x20;
39+
{% endhint %}
40+
41+
```sh
42+
# For Filecoin Mainnet:
43+
make clean build
44+
45+
# For Calibration Testnet:
46+
make clean calibnet
47+
```
48+
49+
{% hint style="success" %}
50+
This step will take a few minutes to complete.
51+
{% endhint %}
52+
53+
### Install and Verify Curio
54+
55+
Run the following to install the compiled binary:
56+
57+
```sh
58+
sudo make install
59+
```
60+
61+
This will place curio in `/usr/local/bin`
62+
63+
Verify the installation:
64+
65+
```shell
66+
curio --version
67+
```
68+
69+
Expected output:
70+
71+
```sh
72+
# Example output for Mainnet:
73+
curio version 1.24.4+mainnet+git_f954c0a_2025-04-06T15:46:32-04:00
74+
75+
# Example output for Calibration:
76+
curio version 1.24.4+calibnet+git_f954c0a_2025-04-06T15:46:32-04:00
77+
```
78+
79+
***
80+
81+
### Guided Setup
82+
83+
Curio provides a utility to help you set up a new miner interactively. Run the following command:
84+
85+
```sh
86+
curio guided-setup
87+
```
88+
89+
{% stepper %}
90+
{% step %}
91+
#### **Select "Create a new miner"**
92+
93+
Use the arrow keys to navigate the guided setup menu and select "Create a new miner".
94+
{% endstep %}
95+
96+
{% step %}
97+
#### Enter Your YugabyteDB Connection Details
98+
99+
100+
{% endstep %}
101+
{% endstepper %}
102+
103+
#### 1️⃣ Select "Create a new miner"
104+
105+
Use the arrow keys to navigate the guided setup menu and select "Create a new miner".
106+
107+
#### 2️⃣ Enter Your YugabyteDB Connection Details
108+
109+
If you used the default installation steps from this guide, the following values should work:
110+
111+
* Host: 127.0.0.1
112+
* Port: 5433
113+
* Username: yugabyte
114+
* Password: yugabyte
115+
* Database: yugabyte
116+
117+
You can verify these settings by running the following command from the Yugabyte directory:
118+
119+
./bin/yugabyted status
120+
121+
After selecting "Continue to connect and update schema", Curio will automatically create the required tables and schema in the database.
122+
123+
#### 3️⃣ Set Wallet Addresses
124+
125+
For this step, use the two BLS wallets you created earlier with Lotus:
126+
127+
* Use wallet 1 for the Owner Address
128+
* Use wallet 2 for the Worker Address
129+
* Use wallet 1 again for the Sender Address
130+
131+
These addresses must match the Lotus wallets created earlier.
132+
133+
| 💡 You can display your Lotus wallets at any time by running: |
134+
| ------------------------------------------------------------- |
135+
136+
\
137+
138+
139+
lotus wallet list
140+
141+
#### 4️⃣ Choose Sector Size
142+
143+
Choose sector size:
144+
145+
* 64 GiB
146+
147+
| 💡 Selecting a sector size is required during the Curio guided setup, but PDP itself doesn’t use sectors. Proof set sizes in PDP are arbitrary and fully flexible. |
148+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
149+
150+
#### 5️⃣ Create Miner Actor
151+
152+
Review the information to ensure all inputs are correct. Then select "Continue to verify the addresses and create a new miner actor" to proceed.
153+
154+
| ⏱️ This step may take a few minutes to complete as Curio pushes the message and waits for it to land on-chain. |
155+
| -------------------------------------------------------------------------------------------------------------- |
156+
157+
Once the actor is created, Curio will:
158+
159+
* Register your miner ID
160+
161+
| 💡 If the guided setup fails after creating the miner actor, run the following command to complete the installation: |
162+
| -------------------------------------------------------------------------------------------------------------------- |
163+
164+
\
165+
166+
167+
curio config new-cluster \<miner ID>
168+
169+
#### 6️⃣ Telemetry (Optional)
170+
171+
You’ll be asked whether to share anonymised or signed telemetry with the Curio team to help improve the software.
172+
173+
Select your preference and continue.
174+
175+
#### 7️⃣ Save Database Configuration
176+
177+
At the final step of the guided setup, you’ll be prompted to choose where to save your database configuration file.
178+
179+
Use the arrow keys to select a location. A common default is:
180+
181+
/home/your-username/curio.env
182+
183+
Once selected, setup will complete, and the miner configuration will be stored.
184+
185+
#### 8️⃣ Launch the Curio Web GUI
186+
187+
To explore the Curio interface visually, start the GUI layer:
188+
189+
curio run --layers=gui
190+
191+
Then, open your browser and go to:
192+
193+
http://127.0.0.1:4701
194+
195+
This will launch the Curio web GUI locally.
196+
197+
\

0 commit comments

Comments
 (0)