Skip to content

skullzarmy/porcupin-ipfs-backup-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

115 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Porcupin Porcupin

A set-and-forget Tezos NFT preservation app that pins your NFT assets to IPFS.

License Go Version codecov Platform Tezos

Porcupin automatically monitors your Tezos wallets and backs up all NFT content (images, metadata, videos) to IPFS. Once configured, it runs in the background keeping your digital art collection safeβ€”forever.

🌐 Website: porcupin.xyz


πŸ—³οΈ Support This Project

Porcupin is seeking funding through the Tezos Ecosystem DAO!

Help us build and maintain this open-source tool for the Tezos community. Vote on our proposal until December 10th, 2025:

πŸ‘‰ Vote on Tezos Homebase

Connect any Tezos wallet to vote. Your Tez is your vote!

πŸ’œ We also accept Tezos donations: tz1U4wbRsojw1uWcNUpVMK2uihuhhXFYNVg3


πŸ“– Documentation

I want to... Go here
Install and use Porcupin User Guide
Build from source Developer Guide
Update Porcupin Updating Guide
Data Backup & Recovery Backup Strategy
Contribute code Contributing Guide
Understand the architecture Architecture Docs

✨ Features

  • πŸ¦” Set and Forget β€” Add wallets once, Porcupin handles the rest
  • πŸ“Œ IPFS Pinning β€” Embedded Kubo node, no external services needed
  • πŸ”„ Real-time Sync β€” Watches for new NFTs via TZKT
  • πŸ’» Cross-Platform β€” macOS, Windows, Linux, Raspberry Pi, Docker
  • 🌐 Remote Server Mode β€” Run headless on NAS/Pi, manage from desktop app
  • πŸ“Š Dashboard β€” Track sync status, storage usage, failed assets
  • πŸ”’ Self-Sovereign β€” Your data stays on your machine

πŸš€ User Installation

πŸ‘‰ See the User Guide for complete installation instructions.

Quick Links

Supported Platforms

Platform Desktop (GUI) Headless (CLI) Docker
macOS (Intel) βœ… βœ… βœ…
macOS (Apple Silicon) βœ… βœ… βœ…
Windows x64 βœ… β€” βœ…
Windows ARM64 βœ… β€” βœ…
Linux x64 βœ… βœ… βœ…
Linux ARM64 (Pi) β€” βœ… βœ…

🀝 Contributing

We welcome contributions from developers of all skill levels! Please read our Contributing Guide before getting started.

Quick links:

Good First Issues

Look for issues labeled good first issue to get started!


πŸ“„ License

This project is licensed under the MIT License β€” see the LICENSE file for details.

You are free to use, modify, and distribute this software. We just ask that you give credit where it's due! πŸ’œ


πŸ™ Credits

Built and Maintained by

FAFOlab

FAFOlab
fafolab.xyz Β· info@fafolab.xyz

Technology Stack

This project was made possible by these incredible open-source technologies:

  • Wails β€” The Go/React desktop application framework
  • Kubo IPFS β€” The implementation of IPFS used for embedded pinning
  • TZKT β€” The premier Tezos API and Indexer
  • Go β€” The language that powers the backend

Special Thanks

πŸ›οΈ Tezos Ecosystem DAO
Community-voted, community-funded infrastructure for the Tezos ecosystem.
This project is supported by the Tezos community.


Made with πŸ¦”πŸ’œ for the Tezos NFT community

About

A set-and-forget Tezos NFT preservation app that pins your NFT assets to IPFS.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors 3

  •  
  •  
  •