js-ipfs runs in a Browser, a Service Worker, a Web Extension and Node.js, opening the door to a world of possibilities.
Packed with all the things you know and love about IPFS. This implementation also carries some extra neat things that are unique to the Browser. It's the toolkit to power all your DWeb Applications.
Run on Node.js and the Browser
js-ipfs works out of the box on Node.js, Electron and any modern browser. It is also customizable by design so that you can use it on your favorite runtime.
Implements the full IPFS Stack
No feature was left behind. js-ipfs is not a light client, it is the full implementation of the IPFS protocol.
Use PubSub to communicate in realtime with the other peers
IPFS nodes can create network topologies based on topics of interest to broadcast events in realtime.
Add and retrieve files from anywhere in the IPFS Network
IPFS is designed to use the power of Content Addressing to find the nodes in the network that have the content you are looking for. In the same way, you can add data and other nodes will find it too.
Use the DAG API to traverse over any hash linked data structure
IPFS uses IPLD, the InterPlanetary Linked-Data, a model that enables you interact with data from multiple sources, such as git, blockchains and more.
libp2p is built in
libp2p is the Modular Networking Stack that was created for IPFS and now you can use it through IPFS for your application directly as well.
Run it as a daemon
js-ipfs also comes with the option to run it as a daemon so that you can interact with it using the HTTP API that you are familiar with from go-ipfs.
Create stable addresses for changing data
It comes with IPNS, the Interplanetary Naming System, a way to author mutable pointers (records) to distribute updates in an authenticated and certified way.
IPFS gives you a Content Addressing primitive for all your data on the DWeb. You can make data available to the network or fetch existing data through its CID, the Content Identifier. Try it out below or explore our ProtoSchool tutorials!
Adding data to IPFS
Getting data from IPFS
Using the CLI
Using the HTTP Gatewayhttps://ipfs.io/ipfs/
Service Worker Gateway
Turn this page into a full IPFS Gateway without touching any servers or using HTTP to fetch content from the IPFS Network! Yes, you read it right, the Service Worker Gateway with js-ipfs can connect directly to the IPFS Network.
What people are building with it
What you can build with JS-IPFS
There are unlimited options for you to use js-ipfs. The following examples provide you an idea of what you can build with js-ipfs. Try them out!
Have suggestions?Share them here!
Publications & Talks
IPFS on the Brave Browser, Alan Shaw
CRDTs as the foundation for Distributed Web Apps, Pedro Teixeira
A Regular JS Core Dev Call, join us!
js-ipfs is an MIT Licensed, Open Source project from the IPFS community. There are many ways you can contribute: help write the specification, code implementations and tools using js-ipfs, craft examples and tutorials, and join our working group calls to discuss IPFS with us.