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
- ⭐️ Best Practices - A checklist of things you should be doing as a Piri node operator
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
- Server Setup - Deploy the Piri server
Quick Links
- New to Piri? Start with the Getting Started Guide
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/advertisementpublisher
command
|
|
|
lambda/getclaim
command
|
|
|
lambda/getroot
command
|
|
|
lambda/postad
command
|
|
|
lambda/postroot
command
|
|
|
lambda/publisher
command
|
|
|
lambda/putblob
command
|
|
|
internal
|
|
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
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. |
|
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/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: |
|
store/objectstore/flatfs
Package flatfs is a Datastore implementation that stores all objects in a two-level directory structure in the local file system, regardless of the hierarchy of the keys.
|
Package flatfs is a Datastore implementation that stores all objects in a two-level directory structure in the local file system, regardless of the hierarchy of the keys. |
Click to show internal directories.
Click to hide internal directories.