The IPFS web browsers integration group

Informal group working on improving IPFS presence in web browsers

Our goal is to facilitate native support for IPFS and other decentralized protocols in web browsers in order to benefit ....

• Browser users: Browser extensions and native-included IPFS alike expose IPFS features in a robust and intuitive way
• Web developers: Web developers can enjoy a smooth experience working with IPFS in browser contexts
• Browser vendors: Browser developers are empowered to meet the requirements of the distributed web

Contents

• Current projects
  • IPFS Companion browser extension
  • IPFS and the JavaScript ecosystem
  • How to address IPFS on the web
  • How to run own HTTP Gateway
  • How to implement HTTP Gateway
  • DNSLink
  • Collaborations
    • W3C
    • IPFS and Igalia collaborate on dweb in browsers
    • Brave
    • Opera
• Get involved!
• Resources

Current projects

IPFS Companion browser extension

IPFS Companion is a browser extension that simplifies access to IPFS resources and adds browser support for the IPFS protocol. It runs in Firefox (desktop and Android) and Chromium-based browsers including Chrome or Brave. Check out all of IPFS Companion's features and install it today!

Firefox | Firefox for Android	Chrome | Brave | Opera | Edge

Notable past web extension experiments

• Mozilla hosted a community effort called libdweb to implement experimental APIs for Firefox WebExtensions, with a goal of enabling dweb protocols in Firefox through browser add-ons:
  • IPFS libdweb experiments, including a native protocol handler, local DNS-SD discovery and TCP transport
  • The long-term goal of this project was to integrate these APIs into the WebExtensions ecosystem, but as of Q3 2020 it is not yet in Firefox Nightly
• Exposing the IPFS API via window.ipfs (experiment ended in 2020)
• Support for chrome.sockets.* APIs in Chromium browsers (ended due to EOL 2022)

IPFS and the JavaScript ecosystem

At present, in order to interact with IPFS in a web browser, you must either bundle js-ipfs-core (a full IPFS node in JavaScript) with your client-side application, or use the js-ipfs-http-client HTTP RPC API client library to connect to an external daemon running on a local or remote machine.

• To learn more, make sure to check the browser-* examples at ipfs-examples/js-ipfs-examples
  • Highlight: an advanced, end-to-end example of using js-ipfs node in SharedWorker from ServiceWorker can be found at js-ipfs-examples/browser-service-worker

How to address IPFS on the web

• For regular users, see
  • this guide to how to address IPFS content paths on the web
  • this reference about HTTP Gateway API
• For browser vendors and user agent developers, see this memo for the current set of URL conventions for the IPFS community; we invite everyone to submit questions and suggestions for improvements via issues/PRs

How to run own HTTP Gateway

Use the latest Kubo daemon and follow gateway recipes.

How to implement HTTP Gateway

See specification and implementer notes at ipfs/specs/http-gateways.

DNSLink

DNSLink enables you to map a domain name to an IPFS address (CID or IPNS libp2p-key) by means of a DNS TXT record.

• Read the DNSLink guide for details, including how to set it up on your own website
• See details on DNSLink in IPFS Companion to see additional benefits of using IPFS Companion with DNSLink support

Collaborations

W3C

Protocol Labs is a W3C Member. Current focus is to watch, learn, and participate in WebExtensions Community Group.

IPFS and Igalia collaborate on dweb in browsers

In 2020 IPFS and Igalia started a collaboration that continues to this day. Read more: https://blog.ipfs.tech/2021-01-15-ipfs-and-igalia-collaborate-on-dweb-in-browsers/

The most notable highlights (chronological order):

• IPFS and Igalia started a collaboration that will continue beyond 2021+
• Distributed web schemes have been safelisted in Chrome 86’s implementation of custom handlers and registered at IANA.
• Chrome 89 will allow browser extensions to register cross-origin handlers or handlers for schemes with prefix ext+. Refinement is pending for the permission UI.
• Firefox 84 marks http://*.localhost/ URLs as secure context, which means websites loaded from local subdomain gateway will have access to the same Web APIs as HTTPS version.
• Firefox 84 has improved support for loading locally delivered mixed-resources. Patches have also been submitted to WebKit but are pending on reviews and discussions.
• Work is in progress to improve Chromium’s consistency and specification compliance regarding the notion of secure contexts, including removing non-standard localhost names.
• Miscellaneous other fixes have landed for the Firefox and Chromium’s implementations of custom handlers.
• WIP refactor to make it easier to register custom protocol handlers (example, related talk: Integrating New Protocol Handlers into Chrome [BlinkOn 15])
• 2022-05-10: HTML spec PR: add IPFS and IPNS as safelisted schemes for registerProtocolHandler()
• 2022-05-18: Chromium status update: New Custom Handlers Component (BlinkOn 16)
• 2022-06-28: Explainer: Predefined Custom Handlers + Chromium discussion thread
• 2022-07-20: Chromium SchemeRegistry patch MERGED: New list in SchemeRegistry to manage schemes with predefined handlers
• 2022-08-03: After refactors, adding predefined, redirect-based handlers is 2 LOC – demo Implement Predefined Handlers for IPFS schemes using the SchemeRegistry
• 2022-08-01: Blogpost: New Custom Handlers component for Chrome
• 2022-09-28: Intent to Prototype: Curve25519 in Web Cryptography

Brave

Brave v1.19 has integrated IPFS into their desktop web browser for Windows, macOS and Linux. When Brave detects an address which is an HTTP gateway URL to IPFS content or a native IPFS address such as ipfs:// or ipns:// it will prompt the user to install and enable the native IPFS node, or to use an HTTP gateway. Diagnostic UI can be found at brave://ipfs, we suggest enabling IPFS Companion for the best experience

TLDR integration status:

• Initial release (v1.19) is focused on daemon orchestration and on URI support (read blogs and press)
• Demo: Opening ipfs://{cid} will trigger install prompt for go-ipfs managed by Brave itself.
• For the best experience enable IPFS Companion and switch it to IPFS Node Type "Provided by Brave". When Companion is enabled all IPFS resources will be resolved by the local node.

Opera

Opera for Android 57 introduced support for resolving ipfs:// or ipns:// via a customizable gateway.
Read more: https://blog.ipfs.tech/2020-03-30-ipfs-in-opera-for-android/

Get involved!

Contribute to an issue

Contributions to our work are more than welcome! Every IPFS Project repo makes use of the project-wide global issue labeling scheme. Good labels to look for are ...

• help wanted
• good first issue
• and there are even occasional bounty labels for issues with rewards as part of the IPFS Bounty Board!

If you see an issue that catches your eye, leave a comment so we know you're interested, and we'll go from there!

We're an open project and a friendly group, so please be nice and read the contributing guidelines when you're ready to jump in.

Discuss

For the sake of async communication, archiving, and searchability, we encourage browser-related technical discussions to happen in the context of GitHub issue comments whenever practical.

If you want to ask support question, or just chat informally to learn and brainstorm, feel free to join chat community in #lobby:ipfs.io or discussion forum at https://discuss.ipfs.io

Improve docs

https://docs.ipfs.io is backed by the repo at https://github.com/ipfs/ipfs-docs – any help in improving docs related to browsers (or not) is appreciated!

Improve specs

Proof-read ipfs/specs and fill an issue for: (1) outdated specs (2) missing specs (3) bits that are confusing and need to be clarified.

Resources

If you're looking for endeavors related to IPFS browser integration work, these resources may be helpful.

• IPFS in Brave Browser: TLDR explanation how Brave supports IPFS out of the box (either as local node, or by delegating to a public gateway of user's choice)
• IPFS Companion: Harness the power of your local IPFS daemon directly inside your favorite Chromium or Firefox browser, enabling support for ipfs:// addresses, automatic IPFS gateway loading of websites and file paths, easy IPFS file import and sharing, and more
• IPFS Web UI: The IPFS dashboard shipped with the IPFS daemon or IPFS Desktop
• js-ipfs-core: Core IPFS implementation in JavaScript for use in browser (without Nodejs daemon parts)
• HTTP Gateway API docs - implementation-agnostic interface for trusted and trustless data retrieval
• HTTP RPC API docs: Guide to the RPC over HTTP API exposed when a Kubo IPFS node (go-ipfs) is running as a daemon; allows you to control the node and run the same commands you can from the command line
  • For up-to-date info about which JS client to use, see ipfs/kubo#9125
• IPFS GUI group - The other half of the IPFS Web Browsers & GUI Working Group, dedicated to creating and implementing standards and patterns for IPFS that are simple, accessible, reusable, and beautiful