You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our goal is to **facilitate native support for IPFS and other decentralized protocols in web browsers in order to benefit ...**.
10
10
@@ -33,9 +33,9 @@ Our goal is to **facilitate native support for IPFS and other decentralized prot
33
33
34
34
### IPFS Companion browser extension
35
35
36
-
[IPFS Companion](https://github.com/ipfs-shipyard/ipfs-companion#ipfs-companion) is a browser extension that simplifies access to IPFS resources and adds browser support for the IPFS protocol. It runs in <imgsrc="https://unpkg.com/@browser-logos/[email protected]/firefox_16x16.png"width="16"height="16">Firefox (desktop and Android) and Chromium-based browsers including
36
+
[IPFS Companion](https://github.com/ipfs/ipfs-companion#ipfs-companion) is a browser extension that simplifies access to IPFS resources and adds browser support for the IPFS protocol. It runs in <imgsrc="https://unpkg.com/@browser-logos/[email protected]/firefox_16x16.png"width="16"height="16">Firefox (desktop and Android) and Chromium-based browsers including
37
37
<imgsrc="https://unpkg.com/@browser-logos/[email protected]/chrome_16x16.png"width="16"height="16">Chrome or
38
-
<imgsrc="https://unpkg.com/@browser-logos/[email protected]/brave_16x16.png"width="16"height="16">Brave. Check out all of [IPFS Companion's features](https://github.com/ipfs-shipyard/ipfs-companion#ipfs-companion-features) and [**install it**](https://github.com/ipfs-shipyard/ipfs-companion#install) today!
38
+
<imgsrc="https://unpkg.com/@browser-logos/[email protected]/brave_16x16.png"width="16"height="16">Brave. Check out all of [IPFS Companion's features](https://github.com/ipfs/ipfs-companion#ipfs-companion-features) and [**install it**](https://github.com/ipfs/ipfs-companion#install) today!
39
39
40
40
41
41
@@ -49,7 +49,7 @@ Our goal is to **facilitate native support for IPFS and other decentralized prot
49
49
- IPFS [libdweb experiments](https://github.com/ipfs-shipyard/ipfs-companion/blob/libdweb/docs/libdweb.md), including a [native protocol handler](https://github.com/ipfs-shipyard/ipfs-companion/pull/533), [local DNS-SD discovery and TCP transport](https://github.com/ipfs-shipyard/ipfs-companion/pull/553)
50
50
- 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
51
51
- Exposing the IPFS API via [`window.ipfs`](https://docs.ipfs.io/how-to/companion-window-ipfs/) (experiment ended in 2020)
52
-
- Support for [`chrome.sockets.*` APIs](https://github.com/ipfs-shipyard/ipfs-companion/issues/664) in Chromium browsers (deprioritized due to [EOL 2022](https://9to5google.com/2020/01/15/google-killing-chrome-apps/))
52
+
- Support for [`chrome.sockets.*` APIs](https://github.com/ipfs-shipyard/ipfs-companion/issues/664) in Chromium browsers (ended due to [EOL 2022](https://9to5google.com/2020/01/15/google-killing-chrome-apps/))
53
53
54
54
### IPFS and the JavaScript ecosystem
55
55
@@ -60,12 +60,14 @@ At present, in order to interact with IPFS in a web browser, you must either bun
60
60
61
61
### How to address IPFS on the web
62
62
63
-
- For regular users, see this [guide to how to address IPFS content paths on the web](https://docs.ipfs.io/how-to/address-ipfs-on-web/)
63
+
- For regular users, see
64
+
- this [guide to how to address IPFS content paths on the web](https://docs.ipfs.io/how-to/address-ipfs-on-web/)
65
+
- this [reference about HTTP Gateway API](https://docs.ipfs.tech/reference/http/gateway/)
64
66
- For browser vendors and user agent developers, see this [memo](ADDRESSING.md) for the current set of URL conventions for the IPFS community; we invite everyone to submit questions and suggestions for improvements via issues/PRs
65
67
66
68
### How to run own HTTP Gateway
67
69
68
-
Use the latest [go-ipfs daemon](https://github.com/ipfs/go-ipfs) and follow [gateway recipes](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#gateway-recipes).
70
+
Use the latest [Kubo daemon](https://github.com/ipfs/kubo) and follow [gateway recipes](https://github.com/ipfs/kubo/blob/master/docs/config.md#gateway-recipes).
69
71
70
72
### How to implement HTTP Gateway
71
73
@@ -75,8 +77,8 @@ See specification and implementer notes at [ipfs/specs/http-gateways](https://gi
75
77
76
78
[DNSLink](https://dnslink.dev) enables you to map a domain name to an IPFS address (CID or IPNS libp2p-key) by means of a DNS TXT record.
77
79
78
-
- Read the [DNSLink guide](https://docs.ipfs.io/concepts/dnslink/) for details, including how to set it up on your own website
79
-
- See details on [DNSLink in IPFS Companion](https://docs.ipfs.io/how-to/dnslink-companion/) to see additional benefits of using IPFS Companion with DNSLink support
80
+
- Read the [DNSLink guide](https://docs.ipfs.tech/concepts/dnslink/) for details, including how to set it up on your own website
81
+
- See details on [DNSLink in IPFS Companion](https://docs.ipfs.tech/how-to/dnslink-companion/) to see additional benefits of using IPFS Companion with DNSLink support
80
82
81
83
### Collaborations
82
84
@@ -88,14 +90,14 @@ Current focus is to watch, learn, and participate in [WebExtensions Community Gr
88
90
#### IPFS and Igalia collaborate on dweb in browsers
89
91
90
92
In 2020 IPFS and Igalia started a collaboration that continues to this day.
The most notable highlights (chronological order):
94
96
95
97
* IPFS and [Igalia](https://www.igalia.com/) started a collaboration that will continue beyond 2021+
96
98
*[Distributed web schemes have been safelisted in Chrome 86](https://www.chromestatus.com/feature/4776602869170176)’s implementation of [custom handlers](https://html.spec.whatwg.org/multipage/system-state.html#custom-handlers) and [registered at IANA](https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml).
97
99
* 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](https://bugs.chromium.org/p/chromium/issues/detail?id=1079333).
98
-
* Firefox 84 marks `http://*.localhost/` URLs as [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), which means websites loaded from local [subdomain gateway](https://docs.ipfs.io/how-to/address-ipfs-on-web/#subdomain-gateway) will have access to the same Web APIs as HTTPS version.
100
+
* Firefox 84 marks `http://*.localhost/` URLs as [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), which means websites loaded from local [subdomain gateway](https://docs.ipfs.tech/how-to/address-ipfs-on-web/#subdomain-gateway) will have access to the same Web APIs as HTTPS version.
99
101
* Firefox 84 has improved support for [loading locally delivered mixed-resources](https://developer.mozilla.org/en-US/docs/Web/Security/Mixed_content#Loading_locally_delivered_mixed-resources). Patches have also been submitted to WebKit but are pending on reviews and discussions.
100
102
* Work is in progress to improve Chromium’s consistency and specification compliance regarding the notion of [secure contexts](https://w3c.github.io/webappsec-secure-contexts/), including removing non-standard [localhost](https://chromestatus.com/feature/5698580851458048)[names](https://chromestatus.com/feature/5668106045227008).
101
103
* Miscellaneous other fixes have landed for the Firefox and Chromium’s implementations of custom handlers.
@@ -116,13 +118,13 @@ TLDR integration status:
116
118
117
119
- Initial release (v1.19) is focused on daemon orchestration and on URI support (read [blogs and press](https://github.com/ipfs/in-web-browsers/issues/64#issuecomment-763016248))
118
120
- Demo: Opening `ipfs://{cid}` will trigger install prompt for go-ipfs managed by Brave itself.
119
-
- For the best experience enable IPFS Companion and switch it to IPFS Node Type ["Provided by Brave"](https://docs.ipfs.io/how-to/companion-node-types/#provided-by-brave).
121
+
- For the best experience enable IPFS Companion and switch it to IPFS Node Type ["Provided by Brave"](https://docs.ipfs.tech/how-to/companion-node-types/#provided-by-brave).
120
122
When Companion is enabled all IPFS resources will be resolved by the local node.
121
123
122
124
#### Opera
123
125
124
126
Opera for Android 57 introduced support for resolving `ipfs://` or `ipns://` via a customizable gateway.
@@ -173,6 +175,7 @@ If you're looking for endeavors related to IPFS browser integration work, these
173
175
-[IPFS Companion](https://github.com/ipfs-shipyard/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
174
176
-[IPFS Web UI](https://github.com/ipfs-shipyard/ipfs-webui): The IPFS dashboard shipped with the IPFS daemon or IPFS Desktop
175
177
-[js-ipfs-core](https://www.npmjs.com/package/ipfs-core): Core IPFS implementation in JavaScript for use in browser (without Nodejs daemon parts)
176
-
-[HTTP API documentation](https://docs.ipfs.io/reference/http/api/): Guide to the HTTP API exposed when an IPFS node (`go-ipfs` or `js-ipfs`) is running as a daemon; allows you to control the node and run the same commands you can from the command line
177
-
-[js-ipfs-http-client](https://www.npmjs.com/package/ipfs-http-client): Client library for the IPFS HTTP API implemented in JavaScript
178
+
-[HTTP Gateway API docs](https://docs.ipfs.tech/reference/http/gateway/) - implementation-agnostic interface for trusted and trustless data retrieval
179
+
-[HTTP RPC API docs](https://docs.ipfs.tech/reference/kubo/rpci/): 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
180
+
- For up-to-date info about which JS client to use, see https://github.com/ipfs/kubo/issues/9125
178
181
-[IPFS GUI group](https://github.com/ipfs-shipyard/pm-ipfs-gui) - 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
0 commit comments