From e3f383a53fe16bbc9a65467641e0086968086900 Mon Sep 17 00:00:00 2001 From: ElPaisano <113373882+ElPaisano@users.noreply.github.com> Date: Tue, 24 Jan 2023 12:16:01 -0800 Subject: [PATCH 1/6] how-to/command-line-quick-start refactor --- docs/.vuepress/config.js | 4 +- docs/how-to/command-line-quick-start.md | 293 +++++++++++++++--------- docs/install/ipfs-companion.md | 13 +- 3 files changed, 191 insertions(+), 119 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index cb1bf34c4..9c6e196ae 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -144,13 +144,13 @@ module.exports = { '/concepts/further-reading/academic-papers' ], '/how-to/': [ - '/how-to/command-line-quick-start', '/how-to/desktop-app', { - title: 'Customize your install', + title: 'IPFS Kubo Tutorials', sidebarDepth: 1, collapsable: true, children: [ + '/how-to/command-line-quick-start', '/how-to/configure-node', '/how-to/modify-bootstrap-list', '/how-to/nat-configuration', diff --git a/docs/how-to/command-line-quick-start.md b/docs/how-to/command-line-quick-start.md index ee6b124ef..3de3330a1 100644 --- a/docs/how-to/command-line-quick-start.md +++ b/docs/how-to/command-line-quick-start.md @@ -1,178 +1,243 @@ --- -title: IPFS Kubo Tutorial -description: Quick-start guide for installing and getting started with Kubo IPFS from the command line. +title: Initialize a Kubo node and interact with the IPFS Network +description: Initialize a Kubo node repository, take your node online, interact with the IPFS network, and view the web console on your local node using IPFS Desktop --- -# IPFS Kubo Tutorial +# Initialize a Kubo node and interact with the IPFS Network -If you're command-line savvy and just want to get up and running with IPFS right away, follow this quick-start guide. Please note that this guide assumes that you'll be installing Kubo, the reference implementation written in Go. - -::: tip -Don’t want to use the command line right now? Give the desktop-app implementation of IPFS a try. It also does all the steps listed on this page automatically, so you can run IPFS from the terminal later whenever you want. [Download IPFS Desktop now](https://github.com/ipfs/ipfs-desktop) -::: +In this tutorial, you will initialize an IPFS Kubo node repository, take your node online, interact with the IPFS network, and view the web console on your local node. If you run into any problems while following this guide, see [Troubleshooting](#troubleshooting). ## Prerequisites -If you have not yet installed Kubo, follow the [install instructions](../install/command-line.md). +If you have not yet installed Kubo, follow the [Kubo install guide](../install/command-line.md). ## Initialize the repository -`ipfs` stores all its settings and internal data in a directory called _the repository._ Before using IPFS for the first time, you’ll need to initialize the repository with the `ipfs init` command: +`ipfs` stores all its settings and internal data in a directory called _the repository._ Before using Kubo for the first time, you’ll need to initialize the repository. -::: warning -Be careful with `sudo` on Unix platforms (including macOS)! If you run `sudo ipfs init`, the repository will be created for the `root` user instead of your local user account. IPFS doesn't need root privileges, so it's best to run all `ipfs` commands as a regular user! +:::tip + - If you are running a Kubo node in a data center, you should initialize IPFS with the `server` profile. Doing so will prevent IPFS from creating data center-internal traffic trying to discover local nodes: + + ```bash + ipfs init --profile server + ``` + - Be careful using `sudo` on Unix platforms (including macOS)! Running `sudo ipfs init` will create the repository for the `root` user, instead of your local user account. Kubo doesn't require root privileges, so it's best to run all `ipfs` commands as a regular user! ::: -```bash -ipfs init - -> initializing ipfs node at /Users/jbenet/.ipfs -> generating 2048-bit RSA keypair...done -> peer identity: Qmcpo2iLBikrdf1d6QU6vXuNb6P7hwrbNPW9kLAH8eG67z -> to get started, enter: -> -> ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme -``` +1. Open a terminal window. -If you are running on a server in a data center, you should initialize IPFS with the `server` profile. Doing so will prevent IPFS from creating a lot of data center-internal traffic trying to discover local nodes: +1. Initialize the repository with the `ipfs init` command -```bash -ipfs init --profile server -``` + ```bash + ipfs init + ``` -There are a whole host of other configuration options you may want to set — check [the full reference](https://github.com/ipfs/kubo/blob/master/docs/config.md) for more. + Output similar to the following displays: -The hash after `peer identity:` is your node’s ID and will be different from the one shown in the above output. Other nodes on the network use it to find and connect to you. You can run `ipfs id` at any time to get it again if you need it. + ```bash + > initializing ipfs node at /Users/jbenet/.ipfs + > generating 2048-bit RSA keypair...done + > peer identity: Qmcpo2iLBikrdf1d6QU6vXuNb6P7hwrbNPW9kLAH8eG67z + > to get started, enter: + > + > ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme + ``` + + :::tip + The hash next to `peer identity` is your node’s ID and will be different from the one shown in the above output. Other nodes on the network use `peer identity` to find and connect to you. + + Run `ipfs id` to display the `peer identity` if you need it. + ::: -Now, try running the command suggested to you in the output of `ipfs init`. The one that looks like `ipfs cat /ipfs//readme`. -You should see something like this: -``` -Hello and Welcome to IPFS! - -██╗██████╗ ███████╗███████╗ -██║██╔══██╗██╔════╝██╔════╝ -██║██████╔╝█████╗ ███████╗ -██║██╔═══╝ ██╔══╝ ╚════██║ -██║██║ ██║ ███████║ -╚═╝╚═╝ ╚═╝ ╚══════╝ - -If you see this, you have successfully installed -IPFS and are now interfacing with the ipfs merkledag! - - ------------------------------------------------------- -| Warning: | -| This is alpha software. use at your own discretion! | -| Much is missing or lacking polish. There are bugs. | -| Not yet secure. Read the security notes for more. | - ------------------------------------------------------- - -Check out some of the other files in this directory: - - ./about - ./help - ./quick-start <-- usage examples - ./readme <-- this file - ./security-notes -``` +2. Now, try running the command suggested to you in the output of `ipfs init` (i.e. `ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme`): -You can explore other objects in the repository. In particular, the `quick-start` directory which shows example commands to try: + ```bash + ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme + ``` -```bash -ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/quick-start -``` + You should see something like this: + + ``` + Hello and Welcome to IPFS! + + ██╗██████╗ ███████╗███████╗ + ██║██╔══██╗██╔════╝██╔════╝ + ██║██████╔╝█████╗ ███████╗ + ██║██╔═══╝ ██╔══╝ ╚════██║ + ██║██║ ██║ ███████║ + ╚═╝╚═╝ ╚═╝ ╚══════╝ + + If you see this, you have successfully installed + IPFS and are now interfacing with the ipfs merkledag! + + ------------------------------------------------------- + | Warning: | + | This is alpha software. use at your own discretion! | + | Much is missing or lacking polish. There are bugs. | + | Not yet secure. Read the security notes for more. | + ------------------------------------------------------- + + Check out some of the other files in this directory: + + ./about + ./help + ./quick-start <-- usage examples + ./readme <-- this file + ./security-notes + ``` + +1. The respository's `quick-start` directory shows other example commands to try. To display the contents of `quick-start, run: + + ```bash + ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/quick-start + ``` + + :::tip + There are a whole host of other configuration options you can set — see the [the full reference](https://github.com/ipfs/kubo/blob/master/docs/config.md) for more. + ::: ## Take your node online -Once you're ready to join your node to the public network, run the ipfs daemon in another terminal and wait for all three lines below to appear to know that your node is ready: +Next, take your node online and interact with the IPFS network: -```bash -ipfs daemon +1. Open another terminal window. -> Initializing daemon... -> API server listening on /ip4/127.0.0.1/tcp/5001 -> Gateway server listening on /ip4/127.0.0.1/tcp/8080 -``` +2. Start the IPFS daemon in the new terminal window: -Make a note of the TCP ports you receive. If they are different, use yours in the commands below. + ```bash + ipfs daemon + ``` -::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET + After a few moments, output like the following displays, and your node is ready: -The API port provides admin-level access to your Kubo IPFS node. See [RPC API v0 docs](../reference/kubo/rpc.md) for more information. + ```bash + > Initializing daemon... + > API server listening on /ip4/127.0.0.1/tcp/5001 + > Gateway server listening on /ip4/127.0.0.1/tcp/8080 + ``` -::: + Make a note of the TCP ports in the output. If they are different, use yours in the commands below. -Now, switch back to your original terminal. If you’re connected to the network, you should be able to see the IPFS addresses of your peers when you run: + ::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET -```bash -ipfs swarm peers + The API port provides admin-level access to your Kubo IPFS node. See [RPC API v0 docs](../reference/kubo/rpc.md) for more information. -> /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ -> /ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx -> /ip4/134.121.64.93/tcp/1035/p2p/QmWHyrPWQnsz1wxHR219ooJDYTvxJPyZuDUPSDpdsAovN5 -> /ip4/178.62.8.190/tcp/4002/p2p/QmdXzZ25cyzSF99csCQmmPZ1NTbWTe8qtKFaZKpZQPdTFB -``` + ::: -These are a combination of `/p2p/`. +1. Switch back to your original terminal window. -Now, you should be able to get objects from the network. Try: +1. If you’re connected to the network, run `ipfs swarm peers` to see the IPFS addresses of your peers: -```bash -ipfs cat /ipfs/QmSgvgwxZGaBLqkGyWemEDqikCqU52XxsYLKtdy3vGZ8uq > ~/Desktop/spaceship-launch.jpg -``` + ```bash + ipfs swarm peers + ``` -Using the above command, IPFS searches the network for the CID `QmSgv...` and writes the data into a file called `spaceship-launch.jpg` on your Desktop. + Output similar to the following displays: -Next, try sending objects to the network, and then viewing it in your favorite browser. The example below uses `curl` as the browser, but you can open the IPFS URL in other browsers as well: + ```bash + > /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ + > /ip4/104.236.151.122/tcp/4001/p2p/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx + > /ip4/134.121.64.93/tcp/1035/p2p/QmWHyrPWQnsz1wxHR219ooJDYTvxJPyZuDUPSDpdsAovN5 + > /ip4/178.62.8.190/tcp/4002/p2p/QmdXzZ25cyzSF99csCQmmPZ1NTbWTe8qtKFaZKpZQPdTFB + ``` -```bash -hash=`echo "I <3 IPFS -$(whoami)" | ipfs add -q` -curl "https://ipfs.io/ipfs/$hash" + The addresses displayed are composed of a `` (i.e. `/ip4/104.131.131.82/tcp/4001`) and a `` (i.e. `QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx`), resulting in an address of the form `/p2p/`. -> I <3 IPFS - -``` +1. Now, fetch a cool picture of a spaceship launch from the netwok using `ipfs cat`: -Cool, huh? The gateway served a file _from your computer_. The gateway queried the Distributed hash table (DHT), found your machine, requested the file, your computer sent it to the gateway, and the gateway sent it to your browser. + ```bash + ipfs cat /ipfs/QmSgvgwxZGaBLqkGyWemEDqikCqU52XxsYLKtdy3vGZ8uq > ~/Desktop/spaceship-launch.jpg + ``` -Depending on the state of the network, `curl` may take a while. The public gateways may be overloaded or having a hard time reaching you. + When the above command runs, Kubo searches the IPFS network for the CID specified (`QmSgv...`) and writes the data into a file called `spaceship-launch.jpg`. -You can also check it out at your own local gateway: +1. Verify that a photo of a spaceship launch called `spaceship-launch.jpg` is located in your `~/Desktop`. -```bash -curl "http://127.0.0.1:8080/ipfs/$hash" +1. Next, create a file to add to your node: -> I <3 IPFS - -``` + ```bash + echo "meow" > meow.txt + ``` + +1. Add `meow.txt` using `ipfs add`: + + ```bash + ipfs add meow.txt + ``` + + Output similar to the following displays: + + ```bash + > added QmabZ1pL9npKXJg8JGdMwQMJo2NCVy9yDVYjhiHK4LTJQH meow.txt + ``` + + Make note of the CID (i.e. `QmabZ1..`), as you'll need it in the next step. + +1. View the objects by specifying the CID `` returned in the previous step: + + :::tip + The example below uses `curl` as the browser, but you can open the IPFS url in other browsers. Depending on the state of the network, `curl` may take a while due to public gateways being overloaded or having a hard time reaching you. + ::: + + ```bash + curl "https://ipfs.io/ipfs/" + ``` -By default, your gateway is not exposed to the world. It only works locally. + Output like the following displays: -## Web console + ```bash + > meow + ``` -You can view the web console on your local node by going to `localhost:5001/webui`. This should bring up a console like this: + In this step, the gateway served a file _from your computer_. The gateway queried the distributed hash table (DHT), found your machine, requested the file, your computer sent it to the gateway, and the gateway sent it to your browser. + +1. View the objects on your own local gateway: + + ```bash + curl "http://127.0.0.1:8080/ipfs/" + ``` + + ```bash + > meow + ``` + + By default, your gateway is not exposed to the world. It only works locally. + +## Interact with the node using the web console + +You can view the web console for your local node by navigating to `localhost:5001/webui`. ![Web console connection view](./images/command-line-quick-start/webui-connection.png) -The web console shows files that are in your [Mutable File System (MFS)](../concepts/file-systems.md#mutable-file-system-mfs). MFS is a tool built into the web console that helps you navigate IPFS files in the same way you would a name-based file system. +The web console shows files that are in your [Mutable File System (MFS)](../concepts/file-systems.md#mutable-file-system-mfs). MFS is a tool built into the web console that helps you navigate IPFS files in the same way you would a standard, name-based file system. When you add files using the [CLI command `ipfs add ...`](../reference/kubo/cli.md#ipfs-add), these files are not automatically available within the MFS. To view files in IPFS Desktop that you added using the CLI, you must copy the files over to the MFS: -```shell -ipfs files cp /ipfs/ +1. Enter `localhost:5001/webui` into your browser to view the web console. + +1. In the left sidebar menu, click **Files**. An empty directory displays, along with the following message: + +```plaintext +No files here yet! Add files to your local IPFS node by clicking the Import button above. ``` -## IPFS Companion +1. Navigate back to your original terminal window -While we are at it, [IPFS Companion](https://github.com/ipfs/ipfs-desktop#ipfs-companion) is a browser extension that simplifies access to IPFS resources and adds support for the IPFS protocol. +1. Using the CID `` obtained when adding `meow.txt` to your node in the previous step, copy the files over to the MFS. -It will automatically redirect IPFS gateway requests to your local daemon so that you are not relying on or trusting remote gateways. + ```shell + ipfs files cp /ipfs/ + ``` + +1. Refresh **Files** to see `meow.txt` + +## IPFS Companion -It runs in Firefox (desktop and Android) and various Chromium-based browsers such as Google Chrome or [Brave](https://brave.com). -[Check out its features](https://github.com/ipfs/ipfs-companion#features) and install it today! +You can use IPFS Companion, a browser extension that simplifies access to IPFS resources and adds support for the IPFS protocol, to automatically redirect IPFS gateway requests to your local daemon so that you are not relying on remote gateways. -- [Direct download](https://github.com/ipfs/ipfs-companion#install) -- [Install from Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/ipfs-companion/) -- [Install from Chrome Store](https://chrome.google.com/webstore/detail/ipfs-companion/nibjojkomfdiaoajekhjakgkdhaomnch) +For more information on IPFS companion, including how to install it, see the [IPFS Companion quickstart](../install/ipfs-companion.md). ## Troubleshooting diff --git a/docs/install/ipfs-companion.md b/docs/install/ipfs-companion.md index 06d664278..276e4ed91 100644 --- a/docs/install/ipfs-companion.md +++ b/docs/install/ipfs-companion.md @@ -7,17 +7,24 @@ description: The IPFS Companion browser extension allows you to interact with yo IPFS Companion allows you to interact with your IPFS node and the extended IPFS network through your browser. The add-on is available for Brave, Chrome, Edge, Firefox, and Opera. It enables support for `ipfs://` addresses, automatically loads websites and file paths from an IPFS gateway, allows you to easily import and share a file with IPFS, and more. -IPFS Companion works in tandem with an IPFS node running on your local machine, so make sure you have a [node installed](ipfs-desktop.md) before installing this add-on. +## Prerequsities + +In its standard configuration, IPFS Companion talks to your computer's local IPFS node to work its browser magic, so you'll need to have an IPFS node installed and running on your computer. + +Install one of the following if you've not already done so: + +- [IPFS Desktop](../install/ipfs-desktop.md) +- [IPFS Kubo for Go](../install/command-line.md) +- [IPFS for JavaScript](../install/js-ipfs.md) ## Install -The easiest way to install IPFS Companion is through your browser's add-on store: +The easiest way to install IPFS Companion is through your browser's specific extensions and add-ons store: | [Firefox](https://www.mozilla.org/firefox/new/) \| [Firefox for Android](https://play.google.com/store/apps/details?id=org.mozilla.firefox) | [Chrome](https://www.google.com/chrome/) \| [Brave](https://brave.com/) \| [Opera](https://www.opera.com/) \| [Edge](https://www.microsoftedgeinsider.com/) | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [![Install From AMO](https://ipfs.io/ipfs/QmWNa64XjA78QvK3zG2593bSMizkDXXcubDHjnRDYUivqt)](https://addons.mozilla.org/firefox/addon/ipfs-companion/) | [![Install from Chrome Store](https://ipfs.io/ipfs/QmU4Qm5YEKy5yHmdAgU2fD7PjZLgrYTUUbxTydqG2QK3TT)](https://chrome.google.com/webstore/detail/ipfs-companion/nibjojkomfdiaoajekhjakgkdhaomnch) | -Make sure you have [IPFS installed](https://ipfs.io/#install) on your computer as well. Because IPFS Companion (in its standard configuration) talks to your computer's local IPFS node to work its browser magic, you'll need to have IPFS running on your computer, too. ## Features From 2f72f9b4c5da2d3cbe7e865b2eea6648cfda8ef9 Mon Sep 17 00:00:00 2001 From: ElPaisano <113373882+ElPaisano@users.noreply.github.com> Date: Tue, 24 Jan 2023 12:26:48 -0800 Subject: [PATCH 2/6] nits --- docs/how-to/command-line-quick-start.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/how-to/command-line-quick-start.md b/docs/how-to/command-line-quick-start.md index 3de3330a1..68cc68d59 100644 --- a/docs/how-to/command-line-quick-start.md +++ b/docs/how-to/command-line-quick-start.md @@ -219,21 +219,21 @@ When you add files using the [CLI command `ipfs add ...`](../reference/kubo/cli. 1. In the left sidebar menu, click **Files**. An empty directory displays, along with the following message: -```plaintext -No files here yet! Add files to your local IPFS node by clicking the Import button above. -``` + ```plaintext + No files here yet! Add files to your local IPFS node by clicking the Import button above. + ``` 1. Navigate back to your original terminal window 1. Using the CID `` obtained when adding `meow.txt` to your node in the previous step, copy the files over to the MFS. - ```shell - ipfs files cp /ipfs/ - ``` + ```shell + ipfs files cp /ipfs/ + ``` 1. Refresh **Files** to see `meow.txt` -## IPFS Companion +## Use IPFS Companion You can use IPFS Companion, a browser extension that simplifies access to IPFS resources and adds support for the IPFS protocol, to automatically redirect IPFS gateway requests to your local daemon so that you are not relying on remote gateways. From dc674509d4da9ce2890bf45b01525261f76b2ae2 Mon Sep 17 00:00:00 2001 From: ElPaisano <113373882+ElPaisano@users.noreply.github.com> Date: Wed, 25 Jan 2023 12:15:18 -0700 Subject: [PATCH 3/6] Update subsection title Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com> --- docs/how-to/command-line-quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/command-line-quick-start.md b/docs/how-to/command-line-quick-start.md index 68cc68d59..997609998 100644 --- a/docs/how-to/command-line-quick-start.md +++ b/docs/how-to/command-line-quick-start.md @@ -233,7 +233,7 @@ When you add files using the [CLI command `ipfs add ...`](../reference/kubo/cli. 1. Refresh **Files** to see `meow.txt` -## Use IPFS Companion +## Use IPFS Companion with Kubo You can use IPFS Companion, a browser extension that simplifies access to IPFS resources and adds support for the IPFS protocol, to automatically redirect IPFS gateway requests to your local daemon so that you are not relying on remote gateways. From 66a00d4c56040613c9863fdb291eb4f7d13a5b7a Mon Sep 17 00:00:00 2001 From: ElPaisano <113373882+ElPaisano@users.noreply.github.com> Date: Wed, 25 Jan 2023 12:15:41 -0700 Subject: [PATCH 4/6] Add note about default API port Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com> --- docs/how-to/command-line-quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/command-line-quick-start.md b/docs/how-to/command-line-quick-start.md index 997609998..086d3342b 100644 --- a/docs/how-to/command-line-quick-start.md +++ b/docs/how-to/command-line-quick-start.md @@ -122,7 +122,7 @@ Next, take your node online and interact with the IPFS network: ::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET - The API port provides admin-level access to your Kubo IPFS node. See [RPC API v0 docs](../reference/kubo/rpc.md) for more information. + The API port (by default `5001`) provides admin-level access to your Kubo IPFS node. See [RPC API v0 docs](../reference/kubo/rpc.md) for more information. ::: From 570286688b21a880f939a9ef9616015dda2a2329 Mon Sep 17 00:00:00 2001 From: ElPaisano <113373882+ElPaisano@users.noreply.github.com> Date: Wed, 25 Jan 2023 11:41:54 -0800 Subject: [PATCH 5/6] address 2color feedback --- docs/how-to/command-line-quick-start.md | 12 +++++++++--- docs/install/ipfs-companion.md | 10 +++++----- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/how-to/command-line-quick-start.md b/docs/how-to/command-line-quick-start.md index 086d3342b..4078bcd8e 100644 --- a/docs/how-to/command-line-quick-start.md +++ b/docs/how-to/command-line-quick-start.md @@ -223,15 +223,21 @@ When you add files using the [CLI command `ipfs add ...`](../reference/kubo/cli. No files here yet! Add files to your local IPFS node by clicking the Import button above. ``` -1. Navigate back to your original terminal window +1. Navigate back to your original terminal window. 1. Using the CID `` obtained when adding `meow.txt` to your node in the previous step, copy the files over to the MFS. ```shell - ipfs files cp /ipfs/ + ipfs files cp /ipfs/ /meow.txt ``` -1. Refresh **Files** to see `meow.txt` + For example, if the `` of `meow.txt` is `QmabZ1pL9npKXJg8JGdMwQMJo2NCVy9yDVYjhiHK4LTJQH`, it would be coopied to the MFS with: + + ```shell + ipfs files cp /ipfs/QmabZ1pL9npKXJg8JGdMwQMJo2NCVy9yDVYjhiHK4LTJQH /meow.txt + ``` + +1. In your browser, refresh the **Files** page. The list of files displays `meow.txt`. ## Use IPFS Companion with Kubo diff --git a/docs/install/ipfs-companion.md b/docs/install/ipfs-companion.md index 276e4ed91..8e66b40f9 100644 --- a/docs/install/ipfs-companion.md +++ b/docs/install/ipfs-companion.md @@ -9,13 +9,13 @@ IPFS Companion allows you to interact with your IPFS node and the extended IPFS ## Prerequsities -In its standard configuration, IPFS Companion talks to your computer's local IPFS node to work its browser magic, so you'll need to have an IPFS node installed and running on your computer. +For its full functionality to be enabled, IPFS Companion requires a local IPFS node. As such, it is recommended that you have an IPFS node installed and running on your computer. Any one of the following will satisfy the requirement: -Install one of the following if you've not already done so: +- [Install IPFS Desktop](../install/ipfs-desktop.md) +- [Install IPFS Kubo for Go](../install/command-line.md) +- [Install IPFS for JavaScript](../install/js-ipfs.md) -- [IPFS Desktop](../install/ipfs-desktop.md) -- [IPFS Kubo for Go](../install/command-line.md) -- [IPFS for JavaScript](../install/js-ipfs.md) +You can still use IPFS Companion without a local node running, although you will lose some functionality, such as the ability to load websites with DNSLink via a gateway. ## Install From da000f6964cce5330e4c35c9b52f3257f416a386 Mon Sep 17 00:00:00 2001 From: ElPaisano <113373882+ElPaisano@users.noreply.github.com> Date: Thu, 26 Jan 2023 15:17:05 -0800 Subject: [PATCH 6/6] Typos, nits --- docs/how-to/command-line-quick-start.md | 8 ++++---- docs/install/ipfs-companion.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/how-to/command-line-quick-start.md b/docs/how-to/command-line-quick-start.md index 4078bcd8e..e5346408e 100644 --- a/docs/how-to/command-line-quick-start.md +++ b/docs/how-to/command-line-quick-start.md @@ -88,7 +88,7 @@ If you have not yet installed Kubo, follow the [Kubo install guide](../install/c ./security-notes ``` -1. The respository's `quick-start` directory shows other example commands to try. To display the contents of `quick-start, run: +1. The `quick-start` directory shows other example commands to try. To display the contents of `quick-start, run: ```bash ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/quick-start @@ -145,7 +145,7 @@ Next, take your node online and interact with the IPFS network: The addresses displayed are composed of a `` (i.e. `/ip4/104.131.131.82/tcp/4001`) and a `` (i.e. `QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx`), resulting in an address of the form `/p2p/`. -1. Now, fetch a cool picture of a spaceship launch from the netwok using `ipfs cat`: +1. Now, fetch a cool picture of a spaceship launch from the network using `ipfs cat`: ```bash ipfs cat /ipfs/QmSgvgwxZGaBLqkGyWemEDqikCqU52XxsYLKtdy3vGZ8uq > ~/Desktop/spaceship-launch.jpg @@ -178,7 +178,7 @@ Next, take your node online and interact with the IPFS network: 1. View the objects by specifying the CID `` returned in the previous step: :::tip - The example below uses `curl` as the browser, but you can open the IPFS url in other browsers. Depending on the state of the network, `curl` may take a while due to public gateways being overloaded or having a hard time reaching you. + The example below uses `curl` as the browser, but you can open the IPFS address in other browsers. Depending on the state of the network, `curl` may take a while due to public gateways being overloaded or having a hard time reaching you. ::: ```bash @@ -231,7 +231,7 @@ When you add files using the [CLI command `ipfs add ...`](../reference/kubo/cli. ipfs files cp /ipfs/ /meow.txt ``` - For example, if the `` of `meow.txt` is `QmabZ1pL9npKXJg8JGdMwQMJo2NCVy9yDVYjhiHK4LTJQH`, it would be coopied to the MFS with: + For example, if the `` of `meow.txt` is `QmabZ1pL9npKXJg8JGdMwQMJo2NCVy9yDVYjhiHK4LTJQH`, it would be copied to the MFS with: ```shell ipfs files cp /ipfs/QmabZ1pL9npKXJg8JGdMwQMJo2NCVy9yDVYjhiHK4LTJQH /meow.txt diff --git a/docs/install/ipfs-companion.md b/docs/install/ipfs-companion.md index 8e66b40f9..5fae0f491 100644 --- a/docs/install/ipfs-companion.md +++ b/docs/install/ipfs-companion.md @@ -7,7 +7,7 @@ description: The IPFS Companion browser extension allows you to interact with yo IPFS Companion allows you to interact with your IPFS node and the extended IPFS network through your browser. The add-on is available for Brave, Chrome, Edge, Firefox, and Opera. It enables support for `ipfs://` addresses, automatically loads websites and file paths from an IPFS gateway, allows you to easily import and share a file with IPFS, and more. -## Prerequsities +## Prerequisites For its full functionality to be enabled, IPFS Companion requires a local IPFS node. As such, it is recommended that you have an IPFS node installed and running on your computer. Any one of the following will satisfy the requirement: