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
A safe subset of IPFS APIs of user's node is exposed as `window.ipfs` on every webpage.
45
+
This means websites can detect if `window.ipfs` exists and opt-in to use it instead of spawning own `js-ipfs` node. This saves resources, battery etc.
46
+
Make sure to read our [notes on `window.ipfs`](https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/window.ipfs.md), where we explain it in-depth and provide examples on how to use it your own dapp.
47
+
48
+
#### Embedded `js-ipfs` Node
49
+
50
+
Browser Action menu provides a toggle for switching between embedded, in-memory `js-ipfs` and external IPFS node accessed over HTTP API.
51
+
52
+
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.
53
+
Power users can provide own config (eg. to enable experimental pubsub) via _Preferences_.
54
+
55
+
**UX Note:** Embedded node does not run when external one is used. Every time you switch back to Embedded node, a new instance is spawned on-demand, so it takes [a few seconds](https://user-images.githubusercontent.com/157609/38493690-4a77bd9e-3bf3-11e8-85da-ba06fd94cdbf.gif) for a brand-new node to find peers.
56
+
57
+
#### IPFS Status and Context Actions
43
58
44
59
- IPFS API and Gateway status
45
60
- Quick Upload of local files
@@ -63,7 +78,6 @@ _(some are disabled by default, use Preferences screen to enable)_
63
78
- Make plaintext IPFS links clickable
64
79
- Mirror to IPFS by right click on any image or video
65
80
- Embedded node can be used for uploads even when external API is down
66
-
-[`window.ipfs`](docs/window.ipfs.md) - web pages can access your IPFS node
67
81
68
82
## Install
69
83
@@ -155,10 +169,15 @@ Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/ipfs-
155
169
156
170
If you want to help in developing this extension, please see [CONTRIBUTING](CONTRIBUTING.md) page :sparkles:
157
171
172
+
Browser extension team hangs out at the [#ipfs-in-web-browsers](https://webchat.freenode.net/?channels=ipfs-in-web-browsers) channel on Freenode.
173
+
158
174
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
159
175
160
176
### TROUBLESHOOTING
161
177
178
+
The best place to ask your questions about IPFS in general, how it works and what you can do with it is at [discuss.ipfs.io](https://discuss.ipfs.io/).
179
+
We are also available at the [#ipfs](https://webchat.freenode.net/?channels=ipfs) channel, where most of IPFS community hangs out.
180
+
162
181
#### Upload via Right-Click Does Not Work in Firefox
163
182
164
183
See [this workaround](https://github.com/ipfs/ipfs-companion/issues/227).
0 commit comments