Skip to content

Commit

Permalink
Merge pull request #1658 from ipfs/bump-documentation-to-latest-versions
Browse files Browse the repository at this point in the history 
Update release version numbers
  • Loading branch information
@Jorropo
Jorropo authored Aug 9, 2023
2 parents 6e4f93e + ed72508 commit efa06cf
Show file tree
Hide file tree
Showing 5 changed files with 160 additions and 130 deletions.
54 changes: 27 additions & 27 deletions docs/install/command-line.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Kubo
description: Using IPFS Kubo through the command-line allows you to do everything that IPFS Desktop can do, but at a more granular level, since you can specify which commands to run. Learn how to install it here.
current-ipfs-version: v0.21.0
current-ipfs-version: v0.22.0
---

# Install IPFS Kubo
Expand Down Expand Up @@ -31,7 +31,7 @@ Kubo runs on most Windows, MacOS, Linux, FreeBSD and OpenBSD systems that meet t

Note the following:
- The amount of disk space your IPFS installation uses depends on how much data you're sharing. A base installation uses around 12MB of disk space.
- You can enable automatic garbage collection via [--enable-gc](../reference/kubo/cli.md#ipfs-daemon) and adjust using [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.21.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
- You can enable automatic garbage collection via [--enable-gc](../reference/kubo/cli.md#ipfs-daemon) and adjust using [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.22.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.

### Kubo on resource-constrained systems

Expand Down Expand Up @@ -72,27 +72,27 @@ For installation instructions for your operating system, select the appropriate
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```powershell
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_windows-amd64.zip -Outfile kubo_v0.21.0.zip
wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_windows-amd64.zip -Outfile kubo_v0.22.0.zip
```

1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.21.0`.
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.22.0`.

```powershell
Expand-Archive -Path kubo_v0.21.0.zip -DestinationPath ~\Apps\kubo_v0.21.0
Expand-Archive -Path kubo_v0.22.0.zip -DestinationPath ~\Apps\kubo_v0.22.0
```

1. Move into the `kubo_v0.21.0` folder
1. Move into the `kubo_v0.22.0` folder

```powershell
cd ~\Apps\kubo_v0.21.0\kubo
cd ~\Apps\kubo_v0.22.0\kubo
```

1. Check that the `ipfs.exe` works:

```powershell
.\ipfs.exe --version
> ipfs version 0.21.0
> ipfs version 0.22.0
```

At this point, Kubo is usable. However, it's strongly recommended that you first add `ipfs.exe` to your `PATH` using the following steps:
Expand Down Expand Up @@ -138,7 +138,7 @@ For installation instructions for your operating system, select the appropriate
```powershell
ipfs --version
> ipfs version 0.21.0
> ipfs version 0.22.0
```

:::
Expand All @@ -159,28 +159,28 @@ For installation instructions for your operating system, select the appropriate
1. Download the appropriate macOS binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo) based on your hardware. For example:

```bash
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_darwin-amd64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_darwin-amd64.tar.gz
```

> :warning:
> Ensure that you download and install the appropriate binary, as the binary for an Intel-based system won't work on a system with Apple Silicon, and vice-versa.
- _If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.21.0` for an Apple-based system, run the following command:
- _If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.22.0` for an Apple-based system, run the following command:

```bash
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_darwin-arm64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_darwin-arm64.tar.gz
```

- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for `Kubo v0.21.0` for an Intel-based system, run the following command:
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for `Kubo v0.22.0` for an Intel-based system, run the following command:

```bash
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_darwin-amd64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_darwin-amd64.tar.gz
```

1. Unzip the file. For example, to unzip `Kubo v0.21.0` for an Intel-based system:
1. Unzip the file. For example, to unzip `Kubo v0.22.0` for an Intel-based system:

```bash
tar -xvzf kubo_v0.21.0_darwin-amd64.tar.gz
tar -xvzf kubo_v0.22.0_darwin-amd64.tar.gz
```

The following output displays:
Expand Down Expand Up @@ -218,7 +218,7 @@ For installation instructions for your operating system, select the appropriate
If Kubo is installed, the version number displays. For example:

```bash
> ipfs version 0.21.0
> ipfs version 0.22.0
```

:::
Expand All @@ -230,13 +230,13 @@ For installation instructions for your operating system, select the appropriate
1. Download the Linux binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_linux-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_linux-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.21.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.22.0_linux-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -265,7 +265,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.21.0
> ipfs version 0.22.0
```

:::
Expand All @@ -277,13 +277,13 @@ For installation instructions for your operating system, select the appropriate
1. Download the FreeBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_freebsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_freebsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.21.0_freebsd-amd64.tar.gz
tar -xvzf kubo_v0.22.0_freebsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -312,7 +312,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.21.0
> ipfs version 0.22.0
```

:::
Expand All @@ -324,13 +324,13 @@ For installation instructions for your operating system, select the appropriate
1. Download the OpenBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_openbsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_openbsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.21.0_openbsd-amd64.tar.gz
tar -xvzf kubo_v0.22.0_openbsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -359,7 +359,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.21.0
> ipfs version 0.22.0
```

:::
Expand All @@ -371,7 +371,7 @@ For installation instructions for your operating system, select the appropriate

## Build Kubo from source

For the current instructions on how to manually download, compile and build Kubo from source, see the [Build from Source](https://github.com/ipfs/kubo/blob/v0.21.0/README.md#build-from-source) section in the Kubo repository.
For the current instructions on how to manually download, compile and build Kubo from source, see the [Build from Source](https://github.com/ipfs/kubo/blob/v0.22.0/README.md#build-from-source) section in the Kubo repository.

## Determining which node to use with the command line

Expand Down
72 changes: 40 additions & 32 deletions docs/reference/kubo/cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ description: API documentation for the Kubo command-line executable.

# Kubo command-line

::: tip Generated on 2023-07-03 11:11:30, from kubo 0.21.0
This document was autogenerated from CLI help text in [kubo 0.21.0](https://github.com/ipfs/kubo/releases/tag/v0.21.0)
::: tip Generated on 2023-08-09 15:18:37, from kubo 0.22.0
This document was autogenerated from CLI help text in [kubo 0.22.0](https://github.com/ipfs/kubo/releases/tag/v0.22.0)
For issues and support, check out the [generate-cli-docs.sh](https://github.com/ipfs/ipfs-docs/blob/main/docs/reference/kubo/generate-cli-docs.sh) script on GitHub.
:::

Expand Down Expand Up @@ -1044,12 +1044,14 @@ SYNOPSIS
DESCRIPTION
Available profiles:
'randomports':
Use a random port number for swarm.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
Expand All @@ -1060,6 +1062,22 @@ DESCRIPTION
This profile may only be applied when first initializing the node.
'flatfs':
Configures the node to use the flatfs datastore.
This is the most battle-tested and reliable datastore.
You should use this datastore if:
* You need a very simple and very reliable datastore, and you trust your
filesystem. This datastore stores each block as a separate file in the
underlying filesystem so it's unlikely to loose data unless there's an issue
with the underlying file system.
* You need to run garbage collection in a way that reclaims free space as soon as possible.
* You want to minimize memory usage.
* You are ok with the default speed of data import, or prefer to use --nocopy.
This profile may only be applied when first initializing the node.
'badgerds':
Configures the node to use the experimental badger datastore.
Expand All @@ -1078,32 +1096,14 @@ DESCRIPTION
which is no longer supported by the upstream team.
This profile may only be applied when first initializing the node.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'flatfs':
Configures the node to use the flatfs datastore.
This is the most battle-tested and reliable datastore.
You should use this datastore if:
* You need a very simple and very reliable datastore, and you trust your
filesystem. This datastore stores each block as a separate file in the
underlying filesystem so it's unlikely to loose data unless there's an issue
with the underlying file system.
* You need to run garbage collection in a way that reclaims free space as soon as possible.
* You want to minimize memory usage.
* You are ok with the default speed of data import, or prefer to use --nocopy.
This profile may only be applied when first initializing the node.
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'randomports':
Use a random port number for swarm.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
SUBCOMMANDS
ipfs config profile apply <profile> - Apply profile to config.
Expand Down Expand Up @@ -3320,7 +3320,7 @@ USAGE
ipfs name inspect <record> - Inspects an IPNS Record
SYNOPSIS
ipfs name inspect [--verify=<verify>] [--] <record>
ipfs name inspect [--verify=<verify>] [--dump=false] [--] <record>
ARGUMENTS
Expand All @@ -3329,6 +3329,8 @@ ARGUMENTS
OPTIONS
--verify string - CID of the public IPNS key to validate against.
--dump bool - Include a full hex dump of the raw Protobuf record.
Default: true.
DESCRIPTION
Expand Down Expand Up @@ -3356,7 +3358,8 @@ USAGE
SYNOPSIS
ipfs name publish [--resolve=false] [--lifetime=<lifetime> | -t]
[--allow-offline] [--ttl=<ttl>] [--key=<key> | -k]
[--quieter | -Q] [--ipns-base=<ipns-base>] [--] <ipfs-path>
[--quieter | -Q] [--v1compat=false]
[--ipns-base=<ipns-base>] [--] <ipfs-path>
ARGUMENTS
Expand All @@ -3381,6 +3384,9 @@ OPTIONS
-k, --key string - Name of the key to be used or a valid PeerID, as
listed by 'ipfs key list -l'. Default: self.
-Q, --quieter bool - Write only final hash.
--v1compat bool - Produce a backward-compatible IPNS Record by
including fields for both V1 and V2 signatures.
Default: true.
--ipns-base string - Encoding used for keys: Can either be a multibase
encoded CID or a base58btc encoded multihash. Takes
{b58mh|base36|k|base32|b...}. Default: base36.
Expand Down Expand Up @@ -5554,7 +5560,7 @@ DESCRIPTION
SUBCOMMANDS
ipfs swarm addrs - List known addresses. Useful for
debugging.
ipfs swarm connect <address>... - Open connection to a given address.
ipfs swarm connect <address>... - Open connection to a given peer.
ipfs swarm disconnect <address>... - Close connection to a given address.
ipfs swarm filters - Manipulate address filters.
ipfs swarm peering - Modify the peering subsystem.
Expand Down Expand Up @@ -5633,7 +5639,7 @@ DESCRIPTION

```
USAGE
ipfs swarm connect <address>... - Open connection to a given address.
ipfs swarm connect <address>... - Open connection to a given peer.
SYNOPSIS
ipfs swarm connect [--] <address>...
Expand All @@ -5644,9 +5650,11 @@ ARGUMENTS
DESCRIPTION
'ipfs swarm connect' opens a new direct connection to a peer address.
'ipfs swarm connect' attempts to ensure a connection to a given peer.
Multiaddresses given are advisory, for example the node may already be aware of other addresses for a given peer or may already have an established connection to the peer.
The address format is an IPFS multiaddr:
The address format is a libp2p multiaddr:
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
Expand Down
Loading

0 comments on commit efa06cf

Please sign in to comment.