Skip to content

docs: add Storage Provider Guides section#862

Open
nijoe1 wants to merge 1 commit into
masterfrom
docs/provider-guides
Open

docs: add Storage Provider Guides section#862
nijoe1 wants to merge 1 commit into
masterfrom
docs/provider-guides

Conversation

@nijoe1

@nijoe1 nijoe1 commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Closes #861

Adds a new top-level Storage Provider Guides section to docs.filecoin.cloud, after Developer Guides, documenting the provider lifecycle:

  1. Install & Run a PDP Node - full Lotus + YugabyteDB + Curio stack and Warm Storage registration. One page covering both Calibration and Mainnet via synced network tabs.
  2. Withdraw from Filecoin Pay - withdraw available USDFC and swap to FIL, with filpay-cli and Foundry tabs.
  3. Advanced - Nginx reverse proxy (TLS termination) and LXD container setup.

Also wires the section into the sidebar and adds a landing-page card.

Source: James (tippyflits) battle-tested PDP provider field guide, rewritten to the docs house style (no emoji, Starlight asides/Steps/Tabs).

Verified against source

  • Payments + USDFC contract addresses confirmed against the SDK's own chains.js / ABI (chain 314, Mainnet).
  • getAccountInfoIfSettled signature and the 4-value return order confirmed against the Filecoin Pay ABI.
  • Curio pdpv0 branch and make calibnet / make build targets confirmed against the upstream Makefile.
  • All filpay-cli commands, flags, default RPC, and install command confirmed against the filpay-cli repo.
  • Go 1.23.7 and the Forest snapshot endpoint confirmed live.
  • pnpm build passes; the link validator reports all internal links valid.

Needs maintainer sign-off before merge

These are operator-policy or pinned third-party values taken verbatim from the field guide, not protocol constants:

  • YugabyteDB pinned build 2.25.1.0-b381.
  • Warm Storage registration values: storage price (0.833 Calibration / 0.0833 Mainnet), serviceStatus (prod / testing), piece size bounds, and proving period (30).

Preview

Sidebar: Storage Provider Guides → Overview, Install & Run a PDP Node, Withdraw from Filecoin Pay, Advanced (Nginx Reverse Proxy, LXD Container Setup).
Screenshot 2026-06-30 at 2 46 58 PM
image

Document the storage provider lifecycle: installing and running a PDP
node on Calibration and Mainnet, withdrawing from Filecoin Pay, and
advanced Nginx and LXD setups. Wire the section into the sidebar and
add a landing-page card.
@nijoe1 nijoe1 requested review from TippyFlitsUK and beck-8 June 30, 2026 12:21
@nijoe1 nijoe1 requested review from hugomrdias and rvagg as code owners June 30, 2026 12:21
@github-project-automation github-project-automation Bot moved this to 📌 Triage in FOC Jun 30, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
synapse-dev 9fa121f Commit Preview URL

Branch Preview URL
Jun 30 2026, 12:26 PM

@momack2

momack2 commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

@truckerfling - IIRC the plan was to keep all SP docs in the filecoin.io docs instead of adding to filecoin.cloud so SPs dont have to float across many documentation sites?

@trruckerfling

Copy link
Copy Markdown

@momack2 yes that is covered here filecoin-project/filecoin-docs#2473. we kept SP docs within docs.filecoin.cloud in case of SPs who enter thru filecoin.cloud and docs.filecoin.cloud. it doesn't detract from the docs.filecoin.io experience to have it on both sites

@rvagg rvagg requested review from LexLuthr and snadrus July 6, 2026 03:18
@rvagg

rvagg commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Adding @LexLuthr & @snadrus as reviewers here, this could do with some Curio eyes.

@LexLuthr LexLuthr left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This requires some changes. Some of the assumptions are outdated. CUrio's next release should shorten the Curio+YB section to few lines.

build-essential hwloc libhwloc-dev libarchive-dev wget ntp python-is-python3 aria2
```

### Install Go 1.23.7

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.26.2+ is required and it will keep changing as Curio releases are cut.

Comment on lines +57 to +70
### Install Rust

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

When prompted, choose option `1) Proceed with standard installation` (the default, just press Enter). Then load Rust into your shell:

```bash
source $HOME/.cargo/env
rustc --version
```

You should see a version such as `rustc 1.86.0 (05f9846f8 2025-03-31)`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With filecoin-project/curio#1311 merged this seems irrelevant.

Comment on lines +196 to +197
--master_flags rpc_bind_addresses=127.0.0.1 \
--tserver_flags rpc_bind_addresses=127.0.0.1

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't need these. advertise_addresssets both.

```

:::caution[Locale errors on first start]
If you see locale-related errors, generate the UTF-8 locale and retry: `sudo locale-gen en_US.UTF-8`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be very hard for user to debug as it is hidden in YB logs. Just make this into a prerequisite step.


| Resource | Minimum |
| --- | --- |
| RAM | 32 GiB |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems too low for lotus.

| --- | --- |
| RAM | 32 GiB |
| CPU | 8 cores |
| Fast storage (NVMe/SSD) | 1 TiB |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need 1 TiB?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fast store is not required for Curio at all. It is only required for Yugabyte

3. **Start the database.**

```bash
./bin/yugabyted start \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This command should be specifying the path to the NVME storage.

@BigLep BigLep moved this from 📌 Triage to ⌨️ In Progress in FOC Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ⌨️ In Progress

Development

Successfully merging this pull request may close these issues.

Add a "Storage Provider Guides" section to the FOC docs

6 participants