Skip to content
Pinner.xyz

Quickstart

Deploy a static site to IPFS and make it accessible via a custom domain, all in under 5 minutes.

You need a Pinner account and an API key. Don't have one? Create an API key.

# 1. Authenticate (interactive: prompts for email and password)
pinner auth
 
# 2. Build your site (example with Vite)
npm run build
 
# 3. Deploy: create a website pointing to your CID
pinner websites create mysite.pinner.xyz --cid QmYourCIDHere
 
# Done: your site is live on IPFS

Non-interactive (CI/CD)

If you already have an API key from another machine or for automation:

pinner auth YOUR_JWT

What just happened

The CLI created a website record that maps a domain to an IPFS CID. You provide the domain and CID, and Pinner handles routing and DNS validation. The SDK does the same thing; you give it a domain, target_type, and target_hash (CID), and Pinner handles the rest.

Next steps