- Helder S Ribeiro
Ipfs-Deploy: Zero-Config CLI to Deploy Static Websites to IPFS
- 🌱 First npm package I authored
- 🚀 When launched, ipfs-deploy was on the front page of Hacker News for 15 hours, reaching top 5 at its peak
- ⭐ It had 493 GitHub stars 3 months later
- 📚 It got recommended by Cloudflare's official IPFS documentation
- 🎓 It got adopted by Protocol Labs, the developers of IPFS, when I decided to transfer maintainership
It now lives at: github.com/ipfs-shipyard/ipfs-deploy
👇 This is the original tutorial I published around the time I launched ipfs-deploy. Keeping it here for historic purposes :)
The Complete Beginner's Guide to Deploying Your First Static Website to IPFS
This is going to be like the quickest tutorial ever. Underwhelming almost.
You don't need to know anything about IPFS or distributed nothing, not even static site generators.
Ready? Ok, the first step is you gotta open up your terminal and type this in:
mkdir -p dwebsite/public cd dwebsite echo '<h1>Hello, worlds!</h1>' >> public/index.html yarn global add ipfs-deploy # or: npm install -g ipfs-deploy ipd
You with me? Ok, typed that. What else? Nothing.
What? Yep. You're done here.
Now you sit back and watch as the victory parade logs by 😎
ℹ 🤔 No path argument specified. Looking for common ones… ✔ 📂 Found local public directory. Deploying that. ✔ 🚚 public weighs 24 B. ✔ 📌 It's pinned to Infura now with hash: ℹ 🔗 QmQzKWGdjjQeTXrruYL2vLkCqRP8TyXnG1a9QEJjDM8WTY ✔ 📋 Copied HTTP gateway URL to clipboard: ℹ 🔗 https://ipfs.infura.io/ipfs/QmQzKWGdjjQeTXrruYL2vLkCqRP8TyXnG1a9QEJjDM8WTY ✔ 🏄 Opened web browser (call with -O to disable.)
Sweet, huh? 🍬
Slow down, what exactly just happened?
Alright, that was a bit much to take in at once. Let's rewind a little and look at it in slow-motion, with backstage commentary:
1. Where's the stuff?
Truth be told, I could have called
ipd ./public, passing the directory to be
But then you wouldn't see the "hard thinking" emoji as ipfs-deploy probes smartly about for one of the many, often undocumented, build destinations commonly used by static site generators.
ℹ 🤔 No path argument specified. Looking for common ones… ✔ 📂 Found local public directory. Deploying that.
Yes, I actually combed through staticgen.com, installed a bunch of those static site generators, and built little test sites just so I could claim that "zero-config" headline. It's the little things, you know.
This is what ipfs-deploy looks for when we're too lazy to type it out:
const guesses = [ '_site', // jekyll, hakyll, eleventy 'site', // forgot which 'public', // gatsby, hugo 'dist', // nuxt 'output', // pelican 'out', // hexo 'build', // create-react-app, metalsmith, middleman 'website/build', // docusaurus 'docs', // many others ]
As you can see from this blog's domain name, I'm a fan of Gatsby, but ipfs-deploy serves all in need. Bring your own SSG and we'll slap an interplanetary jetpack on its back and send it flying. 🚀
2. The upload
This is what we're here for, that is, putting the website into space (figuratively, for now). So a few seconds later, ipfs-deploy delivers:
✔ 📌 It's pinned to Infura now with hash: ℹ 🔗 QmQzKWGdjjQeTXrruYL2vLkCqRP8TyXnG1a9QEJjDM8WTY
Jackpot! That's the money shot right there.
That little rambling of a hash is the crux of the whole dweb judo. The magic utterance that summons by name your website from the cavernous depths of the connected dungeons, caring not where it lies, but only what it is.
Intrinsic addressing, unbound by location or route.
Welcome \<grave pause> to the distributed future.
Wait a minute, I thought I heard you say "distributed" 🧐
Oh, you perspicacious reader.
You're right: if IPFS is supposed to be a peer-to-peer protocol, why are we even uploading at all, right? To a server!? 🤢
Shouldn't we just announce to the network that we have the hash and then wait to serve it ourselves to other peers as they request it?
Yeah, you can do that. Then you close your laptop, wifi goes down, 💩 happens, and poof ✨ there goes your website.
This is just like torrents: you need at least one seeder to be available for content to be reachable. If your website has tons of people who run their own IPFS node visiting it and re-serving it to others, then on average your uptime will be pretty high.
But there aren't that many such visitors around yet (hopefully Brave will fix that for us) and besides, it's a brand new website! 🐣 Poor thing wasn't born famous. Give it some time.
It would be a different story if browsers had a decent #asyncUX and visitors could easily tell them to queue the download for when a peer is available and then notify when it's ready (like a seamless "read it later" flow).
But as it stands, if there's no one live the moment a request is made, things just hang and then time out. Definitely not space-ready.
So we need a high-uptime seeder on our side. Or, in IPFS lingo, a "pinner."
Zero-Config Pinning with Infura.io
A big design goal of ipfs-deploy is to let you have that first happy experience of just seeing something you made up on IPFS as fast as possible.
One way to do that is to run a local IPFS daemon and have you serve the content yourself.
But as we saw above, that would be a little gimmicky as it doesn't represent what an actual deployment that you can share with your friends would look like. Gotta have a stable pinner.
Pinning stuff with decent uptime costs money though, so most pinning services understandably require you to at least sign up for a free tier before they'll agree to host your website.
Not Infura.io, though!
By some magic of careful rate-limiting, clever abuse prevention, growth capital, or reckless abandon, they let you just upload stuff out of the blue, unauthenticated, and they'll serve it for you indefinitely. (Even against your will it seems, as there is no clear way of unpinning things at the moment.)
So we owe that slick on-ramp to their generosity: thank y'all at Infura, and please keep it up!
Also, if you own a pinning service yourself and would like to be part of the zero-config welcome package, please consider adding an "even freer" tier that doesn't require signup.
Newly-created static websites don't take up much room, have very little traffic, and are a great gateway into further IPFS consumption.
You did it! 🏁
If you got this far, condragulations. You rock! 🗿
Not only did you deploy your first IPFS website, you can now boast you actually understand how it works by waving your hands and saying "oh, it's pretty much like git + bittorrent you know, easy peasy!"
If you diligently followed the instructions, and somehow things blew up in your face, that's on me, not you. This is my commitment: your first happy experience, or it's a bug!
So please tell me what went wrong and I'll smooth it out for you.
We're all about removing friction around here 🧹🥌
If you haven't had enough, stick around for some extra credit.
And if you are content with where we got for now, please share that feeling with others by spreading and upvoting this guide far and wide :) Thank you!
Free Redundancy with Pinata.cloud
Having a stable pinner is cool and all, but isn't much different from regular web hosting. (In the "distributedness" sense, that is. In the "content-addressableness" sense, it's night and day.)
One way to get a taste of the distributed nature of IPFS is by adding a second pinner, and ipfs-deploy makes that easier.
We're going to deploy both to Infura.io and Pinata.cloud so that visitors can download from both at the same time, or from one in case the other fails.
Pinata.cloud is a dedicated IPFS pinning service that gives you more control over what is being hosted.
It allows you to delete pins and to add metadata that you can later use to filter and manage your deployments.
There is a 1 GB free tier which is plenty enough for dev blogs, landing pages, documentation, and #YangGang fanpages. It does require signup, but it's pretty straightforward and doesn't require credit card or personal information.
# dwebsite/.env IPFS_DEPLOY__PINATA__API_KEY=paste-the-api-key-here IPFS_DEPLOY__PINATA__SECRET_API_KEY=and-the-secret-api-key-here
⚠ You don't want to make that information public ⚠, so when you're doing
this in a repository that you're going to host publicly, make sure to add the
.env file to your
echo .env >> .gitignore
[Update 2019-06-13: there was a section here about how you needed to do manual port forwarding and whatnot to get pinata to deploy, but thankfully, that's no longer necessary. they have enabled HTTPS uploading too so now there's no need to run a node, open a port, and tell them to connect to it. Which is great news, because now this blog has Continuous Deployment with Travis CI 🙌]
Now that Pinata is set up, let's get back to the show. Here's what you run to deploy to both pinning services:
ipd -p infura -p pinata
And this is what you get:
ℹ 🤔 No path argument specified. Looking for common ones… ✔ 📂 Found local public directory. Deploying that. ✔ 🚚 public weighs 24 B. ✔ 📌 It's pinned to Infura now with hash: ℹ 🔗 QmQzKWGdjjQeTXrruYL2vLkCqRP8TyXnG1a9QEJjDM8WTY ✔ 📌 It's pinned to Pinata now with hash: ℹ 🔗 QmQzKWGdjjQeTXrruYL2vLkCqRP8TyXnG1a9QEJjDM8WTY
And there it is: same hash, different locations.
✔ 📋 Copied HTTP gateway URL to clipboard: ℹ 🔗 https://ipfs.infura.io/ipfs/QmQzKWGdjjQeTXrruYL2vLkCqRP8TyXnG1a9QEJjDM8WTY ✔ 🏄 Opened web browser (call with -O to disable.)
You can see the same content on whichever gateway you want by replacing "ipfs.infura.io" with:
Or any of the ones listed here: https://ipfs.github.io/public-gateway-checker
I've said it before, but I find this so cool that it bears repeating:
Intrinsic addressing, unbound by location or route.
Or: calling data by what it is, not where it is.
That's cryptographic hashing for ya 💪
The telling-your-friends part 🗣
Alright, we're done here, right? Feeling all great and distributed. Now go tell your friends about it over the phone 📞
— Hey Jessie, guess what?
— I've got my website up on the dwebs!!
— Yay friend, how cool! I bet that was super hard.
— Nah, there's this npm package, y'know...
— Yeah, yeah, lemme see the website, where's it at?
— Oh it's at i-p-f-s-dot-i-o-slash-i-p-f-s-slash... Er...
— Slash what?
— It's uh... You got a pen? It's uh... uppercase Q, lowercase m, uppercase Q, uppercase T... Ugh... How about I text you the URL?
— Ok, sure, but what if I'm just some random person who sees your URL on a billboard? You won't be able to text me then, will you?
— Hm, I guess not.
— You know what, how about you call me when you have something memorable I can type in the browser?
— Wow, harsh.
Ok that very lifelike conversation went south pretty fast.
It turns out content-addressing on its own doesn't gel quite well with the limited human memory buffer.
Plus, friends can be tough.
What do we do then?
A pretty URL
Human-readable naming for IPFS websites is definitely an area that needs smoothing out.
But if (and that's a big if) you keep within the constraint of using the free Cloudflare IPFS Gateway for now, ipfs-deploy wraps it all together in a pretty neat way.
Here is actual footage of me deploying interplanetarygatsby.com:
ipd -p infura -p pinata -d cloudflare
And this is what I see after the uploads are over:
✔ 🙌 SUCCESS! ℹ 🔄 Updated DNS TXT interplanetarygatsby.com to: ℹ 🔗 dnslink=/ipfs/QmSNf4sScZUmpNqBWAAs9S5tC4XkQRNepA3KbF4aipGGeq
It makes me smile every time at the sheer effortlessness of it 😌
There are some one-time steps you need to take to get there though:
- Buy a domain
- Sign up for a Cloudflare account
- Move your domain's DNS zone to Cloudflare
- Hook up your domain to their IPFS gateway
- Get your API keys
Between actually performing those configuration steps and waiting for DNS information to propagate, this whole thing can take a couple of hours.
That's why I put that part in this bonus chapter and left the base instructions zero-config. In time, we'll remove more and more friction and make that first happy experience ever happier 😃⬅️🧹🥌
So after steps 1-5 are done, the last thing you need to do is add your domain
and Cloudflare API credentials to your website's
# dwebsite/.env IPFS_DEPLOY_CLOUDFLARE__ZONE=example.com # _dnslink.subdomain.example.com also works below; zone stays the same IPFS_DEPLOY_CLOUDFLARE__RECORD=_dnslink.example.com IPFS_DEPLOY_CLOUDFLARE__API_KEY=paste-your-cloudflare-api-key-here IPFS_DEPLOY_CLOUDFLARE__API_EMAIL=the-email-you-used-to-sign-up
Now go ahead, fire away with
ipd -d cloudflare, and tell all those billboards
about it! 📣📣📣
Postface: A Call for Curlers 🧹🥌
While writing this guide, I happened upon the "curling stone" emoji and felt an instant connection to it.
To be honest, I've always found the idea of curling a little... odd. But a whole team sport dedicated to frantically removing friction from a path just so that this peculiar artifact can gracefully and effortlessly glide its way onto a goal is so... moving.
That's how I want ipfs-deploy to feel to the user. A silk-smooth experience landing them right on the distributed web without breaking a sweat, and a wild sweeping crowd cheering them on.
If that sounds like your kind of sport, say hello in the issues and let's polish some stuff!