ipfs2fil

Snapshot your IPFS repos to Filecoin, and browse them from anywhere.

Website · Explorer demo: from Filecoin or on the website · Install · Quickstart · Releases

ipfs2fil reads an IPFS repo of any version (kubo, go-ipfs or IPFS Desktop; fs-repo 0 through 18), links every pin, the MFS tree and leftover blocks under one root, cuts the blocks into pieces, and stores 3 copies on Filecoin Onchain Cloud, where providers keep proving on chain that they hold them. Every archive carries its own index and an HTML explorer, so any IPFS gateway can serve the files and show what is where.

Two made-up repos of a few GiB. The storage is simulated (a test build) and the waits are sped up; everything else is the real tool.

The explorer, served by ipfs2fil explore or by any gateway:

What you get

• Every repo version. fs-repo 0 to 18, go-ipfs 0.2 to kubo 0.43: flatfs, leveldb, badger, pebble, custom datastore specs. The repo is only ever read, so the daemon can keep running.
• js-ipfs repos too. ~/.jsipfs repos 7 to 12 (js-ipfs 0.40 and later), for the archives js-ipfs left behind when it was retired.
• Helia stores. A Node app's Helia blockstore (blockstore-fs) and its datastore (datastore-fs or datastore-level) beside it, with pins and MFS.
• CAR files too. Point --repo at a .car file or a folder of them (ipfs dag export, gateway and Lassie downloads, old web3.storage exports). Each CAR's roots are kept as pins named after the file.
• Or a running node. --repo http://127.0.0.1:5001 reads through kubo's RPC API, for repos on S3 or other plugin datastores and nodes on other machines (through an ssh tunnel).
• Bluesky accounts. A Bluesky (atproto) repo is IPLD too, so --repo at://you.bsky.social archives an account like any IPFS repo: its signed commit, records, images and video. Its posts, records and media join the explorer's library, with a Bluesky App viewer for the feed. --repo pds:https://pds.example.com archives every account on a self-hosted PDS as one repo.
• Everything in it. Recursive and direct pins, the MFS tree, and orphan blocks no pin reaches (on by default).
• Incremental, deterministic pieces. Pieces are cut where the content says, so the same repo always gives the same pieces. Run it again after the repo changes and only the changed pieces upload.
• Proven copies. 3 copies by default on Filecoin Onchain Cloud, paid from your own wallet. Providers announce the CIDs to IPFS, so any gateway can fetch a file by CID.
• An explorer inside the archive. Photos, video, audio, PDFs, books, web pages, Markdown, spreadsheets, Office files and code open in the page, with thumbnails; JavaScript and Python run sandboxed. Every list filters, sorts and runs from the keyboard.
• Many repos, many machines. Shared data sets, blocks stored once across repos, and a catalog of every machine's repos kept encrypted on chain.

Install

curl -fsSL https://github.com/jbenet/ipfs2fil/releases/latest/download/install.sh | sh

or go install github.com/jbenet/ipfs2fil/cmd/ipfs2fil@latest, or download a binary for your platform from releases. Each release lists SHA-256 checksums and signed build provenance (gh attestation verify <file> --repo jbenet/ipfs2fil).

Quickstart

You need an IPFS repo from kubo, go-ipfs or IPFS Desktop (the daemon can keep running) or a CAR file, and a Filecoin wallet holding some FIL for gas and USDFC to pay for storage. Add --network calibration to any command to try it free on the testnet.

ipfs2fil scan              # what would be archived, and what it costs
ipfs2fil up                # pack and push in one go, after confirming the cost
ipfs2fil status            # copies, funding, proofs
ipfs2fil explore           # browse the archive locally

1. See what you have and what it costs. Nothing is written.

   ipfs2fil scan
   

   It reads $IPFS_PATH, else ~/.ipfs; pass --repo <path> for another repo.

2. Give it a wallet. Either make a new one here and fund it:

   ipfs2fil wallet new        # writes ~/.ipfs2fil/wallet.key, prints the address to fund
   ipfs2fil wallet            # FIL, USDFC, and the Filecoin Pay deposit
   

   or point it at the key of a wallet you already have. ipfs2fil never prints the key or copies it anywhere.

   export IPFS2FIL_KEY_FILE=~/secrets/filecoin.key    # or IPFS2FIL_PRIVATE_KEY=<hex>
   

3. Archive. This packs the repo into ./ipfs2fil-archive, shows the monthly cost and any deposit to make into Filecoin Pay, and stores 3 copies once you say yes. Each piece is uploaded once; the other providers copy it from the first. Uploading and adding pieces on chain are separate steps, so uploads keep going while on-chain adds wait out a gas price spike (--max-base-fee, default 0.1 nanoFIL per gas); the pieces that piled up are then added together.

   ipfs2fil up
   

   Ctrl-C or a failure is safe: run ipfs2fil up again and it carries on. If the repo has not changed, packing only lists its blocks and keeps the last archive; pieces every copy holds are skipped, and the existing data sets are reused. Run it again after the repo changes and only the changed pieces are written and uploaded.

4. Check on it, and browse it.

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗