Skip to content

Commit ed72508

Browse files
Bumped documentation & installation docs.
1 parent 6e4f93e commit ed72508

File tree

5 files changed

+160
-130
lines changed

5 files changed

+160
-130
lines changed

docs/install/command-line.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Kubo
33
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.
4-
current-ipfs-version: v0.21.0
4+
current-ipfs-version: v0.22.0
55
---
66

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

3232
Note the following:
3333
- 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.
34-
- 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.
34+
- 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.
3535

3636
### Kubo on resource-constrained systems
3737

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

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

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

8080
```powershell
81-
Expand-Archive -Path kubo_v0.21.0.zip -DestinationPath ~\Apps\kubo_v0.21.0
81+
Expand-Archive -Path kubo_v0.22.0.zip -DestinationPath ~\Apps\kubo_v0.22.0
8282
```
8383

84-
1. Move into the `kubo_v0.21.0` folder
84+
1. Move into the `kubo_v0.22.0` folder
8585

8686
```powershell
87-
cd ~\Apps\kubo_v0.21.0\kubo
87+
cd ~\Apps\kubo_v0.22.0\kubo
8888
```
8989

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

9292
```powershell
9393
.\ipfs.exe --version
9494
95-
> ipfs version 0.21.0
95+
> ipfs version 0.22.0
9696
```
9797

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

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

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

165165
> :warning:
166166
> 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.
167167
168-
- _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:
168+
- _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:
169169

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

174-
- _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:
174+
- _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:
175175

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

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

182182
```bash
183-
tar -xvzf kubo_v0.21.0_darwin-amd64.tar.gz
183+
tar -xvzf kubo_v0.22.0_darwin-amd64.tar.gz
184184
```
185185

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

220220
```bash
221-
> ipfs version 0.21.0
221+
> ipfs version 0.22.0
222222
```
223223

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

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

236236
1. Unzip the file:
237237

238238
```bash
239-
tar -xvzf kubo_v0.21.0_linux-amd64.tar.gz
239+
tar -xvzf kubo_v0.22.0_linux-amd64.tar.gz
240240
241241
> x kubo/install.sh
242242
> x kubo/ipfs
@@ -265,7 +265,7 @@ For installation instructions for your operating system, select the appropriate
265265
```bash
266266
ipfs --version
267267
268-
> ipfs version 0.21.0
268+
> ipfs version 0.22.0
269269
```
270270

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

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

283283
1. Unzip the file:
284284

285285
```bash
286-
tar -xvzf kubo_v0.21.0_freebsd-amd64.tar.gz
286+
tar -xvzf kubo_v0.22.0_freebsd-amd64.tar.gz
287287
288288
> x kubo/install.sh
289289
> x kubo/ipfs
@@ -312,7 +312,7 @@ For installation instructions for your operating system, select the appropriate
312312
```bash
313313
ipfs --version
314314
315-
> ipfs version 0.21.0
315+
> ipfs version 0.22.0
316316
```
317317

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

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

330330
1. Unzip the file:
331331

332332
```bash
333-
tar -xvzf kubo_v0.21.0_openbsd-amd64.tar.gz
333+
tar -xvzf kubo_v0.22.0_openbsd-amd64.tar.gz
334334
335335
> x kubo/install.sh
336336
> x kubo/ipfs
@@ -359,7 +359,7 @@ For installation instructions for your operating system, select the appropriate
359359
```bash
360360
ipfs --version
361361
362-
> ipfs version 0.21.0
362+
> ipfs version 0.22.0
363363
```
364364

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

372372
## Build Kubo from source
373373

374-
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.
374+
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.
375375

376376
## Determining which node to use with the command line
377377

docs/reference/kubo/cli.md

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ description: API documentation for the Kubo command-line executable.
55

66
# Kubo command-line
77

8-
::: tip Generated on 2023-07-03 11:11:30, from kubo 0.21.0
9-
This document was autogenerated from CLI help text in [kubo 0.21.0](https://github.com/ipfs/kubo/releases/tag/v0.21.0)
8+
::: tip Generated on 2023-08-09 15:18:37, from kubo 0.22.0
9+
This document was autogenerated from CLI help text in [kubo 0.22.0](https://github.com/ipfs/kubo/releases/tag/v0.22.0)
1010
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.
1111
:::
1212

@@ -1044,12 +1044,14 @@ SYNOPSIS
10441044
DESCRIPTION
10451045
10461046
Available profiles:
1047+
'randomports':
1048+
Use a random port number for swarm.
10471049
'server':
10481050
Disables local host discovery, recommended when
10491051
running IPFS on machines with public IPv4 addresses.
1050-
'test':
1051-
Reduces external interference of IPFS daemon, this
1052-
is useful when using the daemon in test environments.
1052+
'local-discovery':
1053+
Sets default values to fields affected by the server
1054+
profile, enables discovery in local networks.
10531055
'default-networking':
10541056
Restores default network settings.
10551057
Inverse profile of the test profile.
@@ -1060,6 +1062,22 @@ DESCRIPTION
10601062
10611063
This profile may only be applied when first initializing the node.
10621064
1065+
'flatfs':
1066+
Configures the node to use the flatfs datastore.
1067+
1068+
This is the most battle-tested and reliable datastore.
1069+
You should use this datastore if:
1070+
1071+
* You need a very simple and very reliable datastore, and you trust your
1072+
filesystem. This datastore stores each block as a separate file in the
1073+
underlying filesystem so it's unlikely to loose data unless there's an issue
1074+
with the underlying file system.
1075+
* You need to run garbage collection in a way that reclaims free space as soon as possible.
1076+
* You want to minimize memory usage.
1077+
* You are ok with the default speed of data import, or prefer to use --nocopy.
1078+
1079+
This profile may only be applied when first initializing the node.
1080+
10631081
'badgerds':
10641082
Configures the node to use the experimental badger datastore.
10651083
@@ -1078,32 +1096,14 @@ DESCRIPTION
10781096
which is no longer supported by the upstream team.
10791097
10801098
This profile may only be applied when first initializing the node.
1081-
'local-discovery':
1082-
Sets default values to fields affected by the server
1083-
profile, enables discovery in local networks.
1084-
'flatfs':
1085-
Configures the node to use the flatfs datastore.
1086-
1087-
This is the most battle-tested and reliable datastore.
1088-
You should use this datastore if:
1089-
1090-
* You need a very simple and very reliable datastore, and you trust your
1091-
filesystem. This datastore stores each block as a separate file in the
1092-
underlying filesystem so it's unlikely to loose data unless there's an issue
1093-
with the underlying file system.
1094-
* You need to run garbage collection in a way that reclaims free space as soon as possible.
1095-
* You want to minimize memory usage.
1096-
* You are ok with the default speed of data import, or prefer to use --nocopy.
1097-
1098-
This profile may only be applied when first initializing the node.
1099-
11001099
'lowpower':
11011100
Reduces daemon overhead on the system. May affect node
11021101
functionality - performance of content discovery and data
11031102
fetching may be degraded.
11041103
1105-
'randomports':
1106-
Use a random port number for swarm.
1104+
'test':
1105+
Reduces external interference of IPFS daemon, this
1106+
is useful when using the daemon in test environments.
11071107
11081108
SUBCOMMANDS
11091109
ipfs config profile apply <profile> - Apply profile to config.
@@ -3320,7 +3320,7 @@ USAGE
33203320
ipfs name inspect <record> - Inspects an IPNS Record
33213321
33223322
SYNOPSIS
3323-
ipfs name inspect [--verify=<verify>] [--] <record>
3323+
ipfs name inspect [--verify=<verify>] [--dump=false] [--] <record>
33243324
33253325
ARGUMENTS
33263326
@@ -3329,6 +3329,8 @@ ARGUMENTS
33293329
OPTIONS
33303330
33313331
--verify string - CID of the public IPNS key to validate against.
3332+
--dump bool - Include a full hex dump of the raw Protobuf record.
3333+
Default: true.
33323334
33333335
DESCRIPTION
33343336
@@ -3356,7 +3358,8 @@ USAGE
33563358
SYNOPSIS
33573359
ipfs name publish [--resolve=false] [--lifetime=<lifetime> | -t]
33583360
[--allow-offline] [--ttl=<ttl>] [--key=<key> | -k]
3359-
[--quieter | -Q] [--ipns-base=<ipns-base>] [--] <ipfs-path>
3361+
[--quieter | -Q] [--v1compat=false]
3362+
[--ipns-base=<ipns-base>] [--] <ipfs-path>
33603363
33613364
ARGUMENTS
33623365
@@ -3381,6 +3384,9 @@ OPTIONS
33813384
-k, --key string - Name of the key to be used or a valid PeerID, as
33823385
listed by 'ipfs key list -l'. Default: self.
33833386
-Q, --quieter bool - Write only final hash.
3387+
--v1compat bool - Produce a backward-compatible IPNS Record by
3388+
including fields for both V1 and V2 signatures.
3389+
Default: true.
33843390
--ipns-base string - Encoding used for keys: Can either be a multibase
33853391
encoded CID or a base58btc encoded multihash. Takes
33863392
{b58mh|base36|k|base32|b...}. Default: base36.
@@ -5554,7 +5560,7 @@ DESCRIPTION
55545560
SUBCOMMANDS
55555561
ipfs swarm addrs - List known addresses. Useful for
55565562
debugging.
5557-
ipfs swarm connect <address>... - Open connection to a given address.
5563+
ipfs swarm connect <address>... - Open connection to a given peer.
55585564
ipfs swarm disconnect <address>... - Close connection to a given address.
55595565
ipfs swarm filters - Manipulate address filters.
55605566
ipfs swarm peering - Modify the peering subsystem.
@@ -5633,7 +5639,7 @@ DESCRIPTION
56335639

56345640
```
56355641
USAGE
5636-
ipfs swarm connect <address>... - Open connection to a given address.
5642+
ipfs swarm connect <address>... - Open connection to a given peer.
56375643
56385644
SYNOPSIS
56395645
ipfs swarm connect [--] <address>...
@@ -5644,9 +5650,11 @@ ARGUMENTS
56445650
56455651
DESCRIPTION
56465652
5647-
'ipfs swarm connect' opens a new direct connection to a peer address.
5653+
'ipfs swarm connect' attempts to ensure a connection to a given peer.
5654+
5655+
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.
56485656
5649-
The address format is an IPFS multiaddr:
5657+
The address format is a libp2p multiaddr:
56505658
56515659
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
56525660

0 commit comments

Comments
 (0)