v2.2.2

Changes since v2.2.1

• chore: update deps (#459, #461)
• fix: window.ipfs streaming (#465)
  • Note: not fully functional, as both js-ipfs-api and (to some extent) js-ipfs have open bugs that prevent adding files with pull streams: ipfs-inactive/js-ipfs-http-client#745, ipfs/js-ipfs#1317
• fix: remove API client constructor from window (#467)
• Improved error handling for window.ipfs (#455, PR #458)
• Fix: wss:// gets redirected to IPNS (#469, PR #472)
• Added references to additional docs to the Preferences screen (#470, PR #471)

  

Installation via Stable Channel

• Firefox: Install from Mozilla Add-ons
• Chrome: Install from Chrome Web Store
• Other: use *generic.zip above or build and install it manually

v2.2.2rc1

Changes

• Improved error handling for window.ipfs (#455, PR #458)
• Added docs about Node Types (#470, PR #471)
• Fix: wss:// gets redirected to IPNS (#469, PR #472)

Installation

• Firefox: Install from Our Self-hosted Signed Beta Channel
  or download signed .xpi attached to these release notes and follow these steps
• Chrome: Beta Channel at Chrome Web Store
• Other: use .zip above or build and install it manually

v2.2.2beta1

Changes

• chore: update deps (#459, #461)
• fix: window.ipfs streaming (#465)
  • Note: not fully functional, as both js-ipfs-api and (to some extent) js-ipfs have open bugs that prevent adding files with pull streams: ipfs-inactive/js-ipfs-http-client#745, ipfs/js-ipfs#1317
• fix: remove API client constructor from window (#467)

Installation

• Firefox: Install from Our Self-hosted Signed Beta Channel
  or download signed .xpi attached to these release notes and follow these steps
• Chrome: Beta Channel at Chrome Web Store
• Other: use .zip above or build and install it manually

v2.2.1

A quick bugfix release for #449.
See v2.2.0 for proper Release Notes.

Installation

• Firefox: Install from Mozilla Add-ons
• Chrome: Install from Chrome Web Store
• Other: use *generic.zip above or build and install it manually

v2.2.1beta1

Bugfix release for #449

Installation

• Firefox: Install from Our Self-hosted Signed Beta Channel
  or download signed .xpi attached to these release notes and follow these steps
• Chrome: Beta Channel at Chrome Web Store
• Other: use .zip above or build and install it manually

v2.2.0

Summary

This is v2.2.0. Long time due, but finally we are here! 🎉

Installation

• Firefox: Install from Mozilla Add-ons
• Chrome: Install from Chrome Web Store
• Other: use *generic.zip above or build and install it manually

Release Highlights ✨

IPFS API exposed as window.ipfs

IPFS Companion is exposing a subset of IPFS APIs as window.ipfs on every webpage ✨

This means websites can detect that window.ipfs already exists and use it instead of spawning own js-ipfs node, which saves resources, battery etc.

Make sure to read our notes on window.ipfs in v2.2.0.
Additional background and open questions can be found in original issue: Expose IPFS API as window.ipfs (#330)

Some highlights below:

• window.ipfs property in every web page! 🎠
  • also adds window.Buffer if not there
  • also adds window.Ipfs
• Proxies to running js-ipfs or go-ipfs node (via js-ipfs-api) in the extension
  (improves performance and battery life)
  • in-depth 20min talk: How window.ipfs works in IPFS companion
• Scope-based permissions (origin+path)
  • 4min video explanation: window.ipfs scope based permissions
  • ipfs.files.* APIs are additionally sandboxed within an application path (#431, FAQ)
• Built-in access controls for proxied IPFS functions (#382)
  • Non-whitelisted ipfs functions prompt user for a allow/deny 🎭 decision on first use:
    
  • Option on the Preferences to globally enable/disable 🎭 access via window.ipfs proxy:
    
  • Page for managing permissions:
    

• Documentation: window.ipfs.md @ v2.2.0
• Demo apps that use window.ipfs
  • ipfs-peer-map-example
  • ipfs-id-qr-codes

Embedded Node (js-ipfs)

We now provide a mechanism for switching between embedded and external IPFS nodes.

Embedded node is a fine fallback for situations when user needs to quickly share a file with someone or just wants to run a dapp against window.ipfs but has no third party IPFS daemon running locally.
User can provide own config (eg. to enable experimental pubsub) via Preferences (#395, visible only when embedded node type is selected)

UX Note: Embedded node does not run when external one is used. Every time you switch to Embedded node, a new instance is spawned on-demand, so it takes a few seconds for a brand new node to find peers:

Other Improvements

Protocol Indicator in Firefox

This feature is limited to Firefox – sorry Chrome users! :-)

Different color and tooltip are shown when resource was loaded via local gateway:

• grey icon – valid IPFS resource, but loaded from a public gateway (via HTTP)
• aqua icon – IPFS resource loaded via user's custom gateway (actual IPFS was used)

Demo (click to zoom):

Page Actions in Firefox

To make things more intuitive, page-specific actions are available in a short menu under Protocol Indicator:

Support for simplified redirect-based protocol handlers without web+ prefix in Firefox >= 59

Still just a redirect and not a real protocol handler, but it is a step in the right direction.

More info: #164 (comment)

Known Issues

• Support for simplified redirect-based protocol handlers does not work on Android due to upstream bug.

Want help?

• Should we merge virtual roots for the same IPFS Paths on different gateways?
  See pros and cons in #330 (comment)
• Translate user interface to your preferred language! #300

v2.2.0 (RC2)

Summary

This is the second Release Candidate for v2.2.0.
We are nearly there!

Installation

• Firefox: Install from Our Self-hosted Signed Beta Channel
• Chrome: Beta Channel at Chrome Web Store
• Other: use .zip above or build and install it manually

In This Release

New Features

• added pt-PT locale
• support for ipfs.name.* and ipfs.stats.* in window.ipfs

Fixes

• Big.js serialization problem in ipfs.stats accessed via window.ipfs (#438)
• Popup render issue in Chrome on Mac (#318, PR #441)
• Response for multiple acl dialogs get mixed up (#443)
• Multi permisison dialogs for the same permission (#442)

Open Questions, Known Issues

• Should we merge virtual roots for the same IPFS Paths on different gateways?
  See pros and cons in #330 (comment)

v2.2.0 (RC1)

Summary

This is the first Release Candidate for v2.2.0.
It focuses on speed and stability, but there are some new and exciting features as well 🚀

Installation

• Firefox: Install from Our Self-hosted Signed Beta Channel
  or download signed .xpi attached to these release notes and follow these steps
• Chrome: Beta Channel at Chrome Web Store
• Other: use .zip above or build and install it manually

In This Release

New Features

• Access to selected ipfs.files APIs via window.ipfs is now scoped to an application path

  • demo and details in #431 and docs/window.ipfs.md
  • tl;dr: each app gets it's own "root" where it can store files:
    Calling ipfs.files.write with /myfile.txt on https://domain.com/
    writes to /dapps/https/domain.com/myfile.txt instead.

• Embedded js-ipfs node supports custom configuration #395

  • User can provide own config (eg. to enable experimental pubsub) via Preferences:

    

• Protocol Indicator in Firefox #418

  • Demo (click to zoom):
    
  • pageAction menu:
    

Fixes

• Significant performance improvement for browserAction pop-up time #430
• Context update locks the UI when on "pin-in-progress" IPFS Path #426, #428
• Error: Not able to stop from state: starting #407
• Fix options_ui in Chrome+OSX #429
• Fix: proxy access dialog display issue on Firefox+OSX #427
• Locale fixes and documentation #434, #435
  • Added Localization Notes with instructions on how to smoke-test translations under Firefox and Chrome

Open Questions, Known Issues

• Should we merge virtual roots for the same IPFS Paths on different gateways?
  See pros and cons in #330 (comment)

v2.2.0 (Beta 4)

Beta Release Summary

This beta delivers additional features for Firefox:

• Simplified redirect-based protocol handlers without web+ prefix in Firefox 59 (PR #359)
  More info: #164 (comment)

  

• Improved UI for context-dependent actions:

  • IPFS Protocol Indicator in Location Bar (#398, PR/demo: #418 (comment))

    

  • Menu Under pageAction (PR/demo: #418 (comment))

    

Installation

• Firefox: Install from Our Self-hosted Signed Beta Channel (will update automatically)
  or download signed .xpi attached to these release notes and follow these steps
• Chrome: Beta Channel at Chrome Web Store (will update automatically)
• Other: use .zip above or build and install it manually

v2.2.0 (Beta 3)

Summary

This is a small bugfix Beta release that:

• updates translation files
• fixes ipfs.swarm.peers call when using js-ipfs-api (#413)

To make these Release Notes more exciting:
make sure to check ipfs-peer-map-example app by @alanshaw
It will opportunistically use API exposed via window.ipfs if your browser is running IPFS Companion 🚀

Installation

• Firefox: Install from Our Self-hosted Signed Beta Channel
  or download signed .xpi attached to these release notes and follow these steps
• Chrome: Beta Channel at Chrome Web Store
• Other: use .zip above or build and install it manually