Skip to content

PINNER.md

Latest commit

 

History

History
76 lines (56 loc) · 4.46 KB

PINNER.md

File metadata and controls

76 lines (56 loc) · 4.46 KB
Raw

Running DAS-Pinner

Prerequisites

  • A Filebase account (filebase.com). The free tier (5 GB storage, 5 GB bandwidth, 1 dedicated gateway, no credit card) is sufficient for local testing.
  • An IPFS bucket in your Filebase account and an IPFS RPC API token scoped to that bucket. Generated from the Filebase console under the bucket's settings (separate from the S3 access key — we use the RPC token, not the S3 credentials).
  • Trusted setup for the service.

Installing the Trusted Setup

./install-trusted-setup.sh

Configuration

Set the following environment variables before running the service:

  • FILEBASE_RPC_TOKEN (required) — your Filebase IPFS RPC API token.
  • DEDICATED_GATEWAY (optional) — a dedicated public gateway URL (e.g. https://<your-bucket>.myfilebase.com/). When set, it is prepended to the read-side gateway pool, so /api/v1/get requests race it against the public gateways and typically win on inner CIDs of dag-cbor DAGs.

The pinner verifies the RPC token at startup against https://rpc.filebase.io/api/v0/version and refuses to start if it is missing or invalid.

Running the service

export FILEBASE_RPC_TOKEN=<your-token>
./bin/pinner --addr :5080

Output:

░▒▓███████▓▒░ ░▒▓██████▓▒░ ░▒▓███████▓▒░      ░▒▓███████▓▒░░▒▓█▓▒░▒▓███████▓▒░░▒▓███████▓▒░░▒▓████████▓▒░▒▓███████▓▒░  
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░             ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░ 
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░             ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░ 
░▒▓█▓▒░░▒▓█▓▒░▒▓████████▓▒░░▒▓██████▓▒░       ░▒▓███████▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓██████▓▒░ ░▒▓███████▓▒░  
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░      ░▒▓█▓▒░      ░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░ 
░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░      ░▒▓█▓▒░      ░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░ 
░▒▓███████▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓███████▓▒░       ░▒▓█▓▒░      ░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓████████▓▒░▒▓█▓▒░░▒▓█▓▒░ 
                                                                                                                       

Version: v0.1.0, commit: 00000000
Initializing root command...
2024-08-19T12:08:39.730-0700	INFO	das-pinner	pinner/main.go:47	Initializing trusted setup...
2024-08-19T12:08:41.533-0700	INFO	das-pinner	ipfs-node/w3storage.go:68	Initialized W3Storage with agent DID: did:key:z6MkfvChtMB5d5WJRGinGBWV1uuVdD6VmefLKPRU8Yog79YS
2024-08-19T12:08:41.915-0700	INFO	das-pinner	ipfs-node/w3storage.go:75	Added space with DID: did:key:z6MkiAxv94CHcwEmFxCRzrkCGq4MJDc1VC8PCCrkgA8wyAHz
generating 2048-bit RSA keypair...done
peer identity: QmY4FqTtiWZykV5D1c4vceYabSNqeh6TsFtqAndMAdcRk6
2024-08-19T12:08:43.046-0700	INFO	das-pinner	api/server.go:58	Starting server on 127.0.0.1:3001...

For more options, use the --help flag:

./bin/pinner --help

Running the CLI Tool

To interact with the service, use the CLI tool:

./bin/pinner-cli upload --data <path-to-data> --addr <pinner-address>