README
¶
Piri
A storage node that runs on the Storacha network.
What is Piri?
What's Piri? It's the Provable Information Retention Interface - a Go-based storage node that's part of the Storacha network backbone. It works alongside other services like the indexing service and upload service to enable decentralized storage with cryptographic proofs.
Documentation
Get started with Piri by exploring our comprehensive documentation:
- 🚀 Getting Started - Complete setup guide to deploy Piri
- 🏗️ Architecture - Understand how Piri works
Setup Guides
Follow these guides in order to set up Piri:
- Prerequisites - System, network, and Filecoin requirements
- Installation - Download and install Piri
- Key Generation - Create your cryptographic identity
- TLS Configuration - Set up HTTPS for your domains
- PDP Server Setup - Deploy the storage backend
- UCAN Server Setup - Deploy the client-facing API
- Validation - Test your deployment
Note: Using Curio? See Filecoin's PDP documentation for setup instructions. The Piri UCAN server can connect to Curio as an alternative to the Piri PDP server.
Quick Links
- New to Piri? Start with the Getting Started Guide
- Want to understand the system? Read the Architecture Overview
Contributing
All welcome! Storacha is open-source. Please feel empowered to open a PR or an issue.
Reporting Issues
Found a bug or have a feature request? Please open an issue on our GitHub repository.
License
Dual-licensed under Apache 2.0 OR MIT
Directories
¶
| Path | Synopsis |
|---|---|
|
lambda/aggregatesubmitter
command
|
|
|
lambda/getclaim
command
|
|
|
lambda/getroot
command
|
|
|
lambda/pieceaccepter
command
|
|
|
lambda/pieceaggregator
command
|
|
|
lambda/postroot
command
|
|
|
lambda/putblob
command
|
|
|
internal
|
|
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
pkg
|
|
|
internal/revision
Package revision provides the vsc revision, embedded by the compiler, as a global variable.
|
Package revision provides the vsc revision, embedded by the compiler, as a global variable. |
|
pdp/aggregator/jobqueue/worker
Package jobqueue provides a Worker which can run registered job [Func]s by name, when a message for it is received on the underlying queue.
|
Package jobqueue provides a Worker which can run registered job [Func]s by name, when a message for it is received on the underlying queue. |
|
pdp/scheduler
Package scheduler implements a session-based task scheduler with the following features:
|
Package scheduler implements a session-based task scheduler with the following features: |
|
pdp/service/contract/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |