Update companion-node-types.md by jessicaschilling · Pull Request #581 · ipfs/ipfs-docs

jessicaschilling · 2021-01-05T20:14:52Z

Ready to merge once approved.

This PR updates https://docs.ipfs.io/how-to/companion-node-types/ for two reasons:

Adds info on native browser support in Brave
Rewrites section on embedded + chrome.sockets as deprecated

johnnymatthews

One tiny change, otherwise everything looks good. Merge when ready.

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel · 2021-01-06T15:50:33Z

@johnnymatthews @jessicaschilling mind giving it another 👀 ?

I've expanded "Native" section a bit with more info why "Provided by Brave" is cool
- For now Brave is the only one under "Native", but we expect the list to grow, TOC now reflects that
Moved "Embedded" to the end, as its the least useful one + added warning + removed mentions of deprecated window.ipfs

jessicaschilling · 2021-01-06T18:27:39Z

@lidel Did a close edit of your revisions in d965c04 - thanks for the additional work!

@johnnymatthews do you mind another look? 🙏

Clarify Brave version with native IPFS

lidel · 2021-01-07T15:54:22Z

Added Brave version info to avoid user confusion when they use older one without Native IPFS (current Stable is v1.18):

Ok to merge on my end: ipfs/ipfs-companion#956 already shipped in ipfs-companion v2.16.0.990

johnnymatthews

Mostly minor tweaks. We should probably have a flowchart or table at the top of this page to quickly show readers which node type they should use. It essentially boils down to:

Do you have an IPFS node installed?
|
| --- yes --> Use EXTERNAL mode.
|
| --- no --> Do you have Brave installed?
	     |
	     | --- yes --> Use NATIVE mode within Brave.
	     |
	     | --- no --> Install a local IPFS node, or install Brave.

johnnymatthews · 2021-01-07T15:50:53Z

+**More information on each node type is below, but when in doubt, choose the _External_ node type and run an IPFS node on your local machine.** Some options for doing so:

- Use the [IPFS Desktop](https://github.com/ipfs-shipyard/ipfs-desktop) GUI app (for Windows/Linux/Mac), which installs and manages a local IPFS node for you
+- Use the [IPFS Desktop](https://github.com/ipfs-shipyard/ipfs-desktop) app (for Windows/Linux/Mac), which installs and manages a local IPFS node for you as well as offering an easy, convenient user interface for managing files, peers, and more


Suggested change

- Use the [IPFS Desktop](https://github.com/ipfs-shipyard/ipfs-desktop) app (for Windows/Linux/Mac), which installs and manages a local IPFS node for you as well as offering an easy, convenient user interface for managing files, peers, and more

An above suggestion makes this line redundant.

johnnymatthews · 2021-01-07T15:51:04Z

 - If you prefer a more hands-on approach:
  - Install IPFS by following the [command line quick-start guide](command-line-quick-start.md)
  - Or run it in [Docker](https://github.com/ipfs/go-ipfs#running-ipfs-inside-docker)


Suggested change

- If you prefer a more hands-on approach:

- Install IPFS by following the [command line quick-start guide](command-line-quick-start.md)

- Or run it in [Docker](https://github.com/ipfs/go-ipfs#running-ipfs-inside-docker)

Again, an above suggestion makes these lines redundant.

johnnymatthews · 2021-01-07T16:13:42Z


 Power users can provide [custom config](https://github.com/ipfs/js-ipfs#faq) (e.g. to enable experimental pubsub) via the IPFS Companion [Preferences](https://user-images.githubusercontent.com/157609/38084660-0b97c0cc-334e-11e8-9368-823345ced67f.png)

 **Note:** At present, embedded js-ipfs running within webextension (browser context) comes with some limitations:


Suggested change

**Note:** At present, embedded js-ipfs running within webextension (browser context) comes with some limitations:

There are some limitation when running js-ipfs within a browser context:

johnnymatthews · 2021-01-07T16:14:08Z


 **Note:** At present, embedded js-ipfs running within webextension (browser context) comes with some limitations:

 - Can't act as an HTTP gateway (extension uses public one as a fallback)


Suggested change

- Can't act as an HTTP gateway (extension uses public one as a fallback)

- Companion cannot act as an HTTP gateway: the extension uses public one as a fallback.

johnnymatthews · 2021-01-07T16:16:05Z

 - Can't act as an HTTP gateway (extension uses public one as a fallback)
- Known to be CPU-hungry
-  ([#450](https://github.com/ipfs-shipyard/ipfs-companion/issues/450), [ipfs/js-ipfs#1190](https://github.com/ipfs/js-ipfs/issues/1190)) over time, which may drain your battery
+- Known to be CPU-hungry ([#450](https://github.com/ipfs-shipyard/ipfs-companion/issues/450), [ipfs/js-ipfs#1190](https://github.com/ipfs/js-ipfs/issues/1190)) over time, which may drain your battery


Suggested change

- Known to be CPU-hungry ([#450](https://github.com/ipfs-shipyard/ipfs-companion/issues/450), [ipfs/js-ipfs#1190](https://github.com/ipfs/js-ipfs/issues/1190)) over time, which may drain your battery

- The extension is CPU-hungry and may drain your battery. GitHub issues [ipfs-companion #450](https://github.com/ipfs-shipyard/ipfs-companion/issues/450) and [js-ipfs #1190](https://github.com/ipfs/js-ipfs/issues/1190) address this problem.

johnnymatthews · 2021-01-07T16:17:43Z

+A _public_ node is used as an implicit fallback for gateway functionality when an external node is offline or an embedded node is used. It does not expose the API port.
+
+Because it's a fallback, it's not included as an option in Companion's preferences.


Suggested change

A _public_ node is used as an implicit fallback for gateway functionality when an external node is offline or an embedded node is used. It does not expose the API port.

Because it's a fallback, it's not included as an option in Companion's preferences.

A _public_ node is used as a fallback for gateway functionality when an external node is offline or an embedded node is used. It does not expose the API port. This type of node is not included as an option in Companion's preferences.

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

…b.com/ipfs/ipfs-docs into chore/update-companion-nodetype-brave

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

jessicaschilling · 2021-01-07T17:12:55Z

@johnnymatthews - incorporated your suggestions (but leaving the auto-generated list of node types at the top of the page so we know it's always up to date). Please merge if you're cool with it. 😊

cc @lidel

Update companion-node-types.md

1d4af93

jessicaschilling requested review from johnnymatthews and lidel January 5, 2021 20:15

jessicaschilling assigned lidel Jan 5, 2021

jessicaschilling mentioned this pull request Jan 5, 2021

feat: leverage IPFS node provided by Brave ipfs/ipfs-companion#956

Merged

johnnymatthews reviewed Jan 5, 2021

View reviewed changes

Comment thread docs/how-to/companion-node-types.md Outdated

johnnymatthews suggested changes Jan 5, 2021

View reviewed changes

jessicaschilling and others added 2 commits January 5, 2021 14:33

Update docs/how-to/companion-node-types.md

33cfd17

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

docs: expand Native types

ccbb23b

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel requested a review from johnnymatthews January 6, 2021 15:46

Close-edited @lidel additions

d965c04

lidel approved these changes Jan 7, 2021

View reviewed changes

Update companion-node-types.md

58d671b

Clarify Brave version with native IPFS

johnnymatthews suggested changes Jan 7, 2021

View reviewed changes

jessicaschilling and others added 13 commits January 7, 2021 09:26

Update docs/how-to/companion-node-types.md

e6e28d9

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

70cff79

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

cc37efe

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

0c8a0a4

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

35239ce

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

4437709

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

bb95369

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

399f3d5

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Text tweaks on top of @johnnymatthews tweaks

1dd9dfd

Update docs/how-to/companion-node-types.md

5a2034e

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

More text tweaks from @johnnymatthews suggestions

abf4578

Merge branch 'chore/update-companion-nodetype-brave' of https://githu…

f12b199

…b.com/ipfs/ipfs-docs into chore/update-companion-nodetype-brave

Update docs/how-to/companion-node-types.md

253ced2

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

jessicaschilling and others added 4 commits January 7, 2021 09:48

Update docs/how-to/companion-node-types.md

cd6dce8

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

37adc39

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Update docs/how-to/companion-node-types.md

7031468

Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>

Streamline initial guidance tree per @johnnymatthews

d1ea32c

johnnymatthews approved these changes Jan 7, 2021

View reviewed changes

johnnymatthews changed the base branch from master to pre-production January 7, 2021 19:23

johnnymatthews merged commit bf9671c into pre-production Jan 7, 2021

johnnymatthews deleted the chore/update-companion-nodetype-brave branch January 7, 2021 19:23

	- If you prefer a more hands-on approach:
	- Install IPFS by following the [command line quick-start guide](command-line-quick-start.md)
	- Or run it in [Docker](https://github.com/ipfs/go-ipfs#running-ipfs-inside-docker)


		Power users can provide [custom config](https://github.com/ipfs/js-ipfs#faq) (e.g. to enable experimental pubsub) via the IPFS Companion [Preferences](https://user-images.githubusercontent.com/157609/38084660-0b97c0cc-334e-11e8-9368-823345ced67f.png)

		Note: At present, embedded js-ipfs running within webextension (browser context) comes with some limitations:

	Note: At present, embedded js-ipfs running within webextension (browser context) comes with some limitations:
	There are some limitation when running js-ipfs within a browser context:


		Note: At present, embedded js-ipfs running within webextension (browser context) comes with some limitations:

		- Can't act as an HTTP gateway (extension uses public one as a fallback)

	- Can't act as an HTTP gateway (extension uses public one as a fallback)
	- Companion cannot act as an HTTP gateway: the extension uses public one as a fallback.

	- Known to be CPU-hungry ([#450](https://github.com/ipfs-shipyard/ipfs-companion/issues/450), [ipfs/js-ipfs#1190](https://github.com/ipfs/js-ipfs/issues/1190)) over time, which may drain your battery
	- The extension is CPU-hungry and may drain your battery. GitHub issues [ipfs-companion #450](https://github.com/ipfs-shipyard/ipfs-companion/issues/450) and [js-ipfs #1190](https://github.com/ipfs/js-ipfs/issues/1190) address this problem.

		A _public_ node is used as an implicit fallback for gateway functionality when an external node is offline or an embedded node is used. It does not expose the API port.

		Because it's a fallback, it's not included as an option in Companion's preferences.

Conversation

jessicaschilling commented Jan 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

johnnymatthews left a comment

Choose a reason for hiding this comment

Uh oh!

lidel commented Jan 6, 2021

Uh oh!

jessicaschilling commented Jan 6, 2021

Uh oh!

lidel commented Jan 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnnymatthews left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jessicaschilling commented Jan 7, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jessicaschilling commented Jan 5, 2021 •

edited

Loading

lidel commented Jan 7, 2021 •

edited

Loading