Skip to content

Prerequisites

This document outlines the common prerequisites for running Piri services. Specific services may have additional requirements noted in their respective guides.

System Requirements

Operating System

  • Linux-based OS (Ubuntu 20.04+ recommended)

Hardware

  • CPU: 4+ cores
  • RAM: 8+ GB
  • Storage: 1+ TB
  • Network: 1+ Gbps symmetric connection

Software Requirements

Required Packages

Install the following packages:

sudo apt update && \
sudo apt install -y make git jq curl wget nginx certbot python3-certbot-nginx

Network Requirements

Domain

You'll need a domain, e.g. piri.example.com

Firewall Configuration

Ensure the following ports are open for ingress and egress:

  • 80
  • 443

Filecoin Prerequisites

Lotus Node Setup

A Lotus node is required for interacting with the PDP Smart Contract. Use the correct network for your environment:

Prod Use a mainnet Lotus node
Staging Use a calibration Lotus node

Funded Delegated Wallet

A Lotus Delegated Address is required by Piri for interacting with the PDP Smart Contract. This guide assumes you have already setup a lotus node as described 'Filecoin Prerequisite' above. Please refer to the official Filecoin Docs for more details on delegated addresses.

Step 1: Generate a Delegated Address

lotus wallet new delegated

Example output: t410fzmmaqcn3j6jidbyrqqsvayejt6sskofwash6zoi

Step 2: Fund the Address

Prod Fund with mainnet FIL
  1. Send mainnet FIL to your delegated address (from your preferred wallet/exchange).
  2. Verify funding:
lotus wallet balance YOUR_DELEGATED_ADDRESS
Staging Fund with calibration FIL
  1. Visit the Calibration faucet
  2. Request funds for your new address
  3. Verify funding:
lotus wallet balance YOUR_DELEGATED_ADDRESS

Next Steps

Once you've completed all prerequisites: