Update companion-node-types.md #581
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnnymatthews
suggested changes
Jan 5, 2021
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>
|
@johnnymatthews @jessicaschilling mind giving it another 👀 ?
|
|
@lidel Did a close edit of your revisions in d965c04 - thanks for the additional work! @johnnymatthews do you mind another look? 🙏 |
lidel
approved these changes
Jan 7, 2021
Clarify Brave version with native IPFS
|
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
suggested changes
Jan 7, 2021
There was a problem hiding this comment.
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.
docs/how-to/companion-node-types.md
Outdated
|
|
||
| - 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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
An above suggestion makes this line redundant.
docs/how-to/companion-node-types.md
Outdated
Comment on lines
17
to
19
| - 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) |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
Again, an above suggestion makes these lines redundant.
docs/how-to/companion-node-types.md
Outdated
|
|
||
| This node type is only for development and experimentation. Most users should use [external](#external) or [native](#native) node types instead. | ||
|
|
||
| ::: | ||
|
|
||
| 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: |
There was a problem hiding this comment.
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: |
docs/how-to/companion-node-types.md
Outdated
|
|
||
| This node type is only for development and experimentation. Most users should use [external](#external) or [native](#native) node types instead. | ||
|
|
||
| ::: | ||
|
|
||
| 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: | ||
|
|
||
| - Can't act as an HTTP gateway (extension uses public one as a fallback) |
There was a problem hiding this comment.
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. |
docs/how-to/companion-node-types.md
Outdated
|
|
||
| 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: | ||
|
|
||
| - 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 |
There was a problem hiding this comment.
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. |
docs/how-to/companion-node-types.md
Outdated
Comment on lines
100
to
102
| 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. |
There was a problem hiding this comment.
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>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
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>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
Co-authored-by: Johnny <9611008+johnnymatthews@users.noreply.github.com>
|
@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 |
johnnymatthews
approved these changes
Jan 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ready to merge once approved.
This PR updates https://docs.ipfs.io/how-to/companion-node-types/ for two reasons:
embedded + chrome.socketsas deprecated