Skip to content

Commit 8b4134a

Browse files
github-actions[bot]github-actions[bot]
authored
Update release version numbers (#1632)
Co-authored-by: [email protected] <hacdias>
1 parent a0a2980 commit 8b4134a

File tree

5 files changed

+418
-125
lines changed

5 files changed

+418
-125
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.20.0
4+
current-ipfs-version: v0.21.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.20.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.21.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.20.0/kubo_v0.20.0_windows-amd64.zip -Outfile kubo_v0.20.0.zip
75+
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_windows-amd64.zip -Outfile kubo_v0.21.0.zip
7676
```
7777

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

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

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

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

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

9292
```powershell
9393
.\ipfs.exe --version
9494
95-
> ipfs version 0.20.0
95+
> ipfs version 0.21.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.20.0
141+
> ipfs version 0.21.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.20.0/kubo_v0.20.0_darwin-amd64.tar.gz
162+
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.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.20.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.21.0` for an Apple-based system, run the following command:
169169

170170
```bash
171-
curl -O https://dist.ipfs.tech/kubo/v0.20.0/kubo_v0.20.0_darwin-arm64.tar.gz
171+
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.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.20.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.21.0` for an Intel-based system, run the following command:
175175

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

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

182182
```bash
183-
tar -xvzf kubo_v0.20.0_darwin-amd64.tar.gz
183+
tar -xvzf kubo_v0.21.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.20.0
221+
> ipfs version 0.21.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.20.0/kubo_v0.20.0_linux-amd64.tar.gz
233+
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_linux-amd64.tar.gz
234234
```
235235

236236
1. Unzip the file:
237237

238238
```bash
239-
tar -xvzf kubo_v0.20.0_linux-amd64.tar.gz
239+
tar -xvzf kubo_v0.21.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.20.0
268+
> ipfs version 0.21.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.20.0/kubo_v0.20.0_freebsd-amd64.tar.gz
280+
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_freebsd-amd64.tar.gz
281281
```
282282

283283
1. Unzip the file:
284284

285285
```bash
286-
tar -xvzf kubo_v0.20.0_freebsd-amd64.tar.gz
286+
tar -xvzf kubo_v0.21.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.20.0
315+
> ipfs version 0.21.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.20.0/kubo_v0.20.0_openbsd-amd64.tar.gz
327+
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_openbsd-amd64.tar.gz
328328
```
329329

330330
1. Unzip the file:
331331

332332
```bash
333-
tar -xvzf kubo_v0.20.0_openbsd-amd64.tar.gz
333+
tar -xvzf kubo_v0.21.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.20.0
362+
> ipfs version 0.21.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.20.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.21.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: 38 additions & 26 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-05-09 12:45:57, from kubo 0.20.0
9-
This document was autogenerated from CLI help text in [kubo 0.20.0](https://github.com/ipfs/kubo/releases/tag/v0.20.0)
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)
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

@@ -1047,12 +1047,19 @@ DESCRIPTION
10471047
'server':
10481048
Disables local host discovery, recommended when
10491049
running IPFS on machines with public IPv4 addresses.
1050-
'local-discovery':
1051-
Sets default values to fields affected by the server
1052-
profile, enables discovery in local networks.
1050+
'test':
1051+
Reduces external interference of IPFS daemon, this
1052+
is useful when using the daemon in test environments.
10531053
'default-networking':
10541054
Restores default network settings.
10551055
Inverse profile of the test profile.
1056+
'default-datastore':
1057+
Configures the node to use the default datastore (flatfs).
1058+
1059+
Read the "flatfs" profile description for more information on this datastore.
1060+
1061+
This profile may only be applied when first initializing the node.
1062+
10561063
'badgerds':
10571064
Configures the node to use the experimental badger datastore.
10581065
@@ -1071,21 +1078,9 @@ DESCRIPTION
10711078
which is no longer supported by the upstream team.
10721079
10731080
This profile may only be applied when first initializing the node.
1074-
'lowpower':
1075-
Reduces daemon overhead on the system. May affect node
1076-
functionality - performance of content discovery and data
1077-
fetching may be degraded.
1078-
1079-
'test':
1080-
Reduces external interference of IPFS daemon, this
1081-
is useful when using the daemon in test environments.
1082-
'default-datastore':
1083-
Configures the node to use the default datastore (flatfs).
1084-
1085-
Read the "flatfs" profile description for more information on this datastore.
1086-
1087-
This profile may only be applied when first initializing the node.
1088-
1081+
'local-discovery':
1082+
Sets default values to fields affected by the server
1083+
profile, enables discovery in local networks.
10891084
'flatfs':
10901085
Configures the node to use the flatfs datastore.
10911086
@@ -1102,6 +1097,11 @@ DESCRIPTION
11021097
11031098
This profile may only be applied when first initializing the node.
11041099
1100+
'lowpower':
1101+
Reduces daemon overhead on the system. May affect node
1102+
functionality - performance of content discovery and data
1103+
fetching may be degraded.
1104+
11051105
'randomports':
11061106
Use a random port number for swarm.
11071107
@@ -1323,7 +1323,7 @@ SUBCOMMANDS
13231323
ipfs dag import <path>... - Import the contents of .car files
13241324
ipfs dag put <object data>... - Add a DAG node to IPFS.
13251325
ipfs dag resolve <ref> - Resolve IPLD block.
1326-
ipfs dag stat <root> - Gets stats for a DAG.
1326+
ipfs dag stat <root>... - Gets stats for a DAG.
13271327
13281328
For more information about each command, use:
13291329
'ipfs dag <subcmd> --help'
@@ -1494,14 +1494,14 @@ DESCRIPTION
14941494

14951495
```
14961496
USAGE
1497-
ipfs dag stat <root> - Gets stats for a DAG.
1497+
ipfs dag stat <root>... - Gets stats for a DAG.
14981498
14991499
SYNOPSIS
1500-
ipfs dag stat [--progress=false] [--] <root>
1500+
ipfs dag stat [--progress=false] [--] <root>...
15011501
15021502
ARGUMENTS
15031503
1504-
<root> - CID of a DAG root to get statistics for
1504+
<root>... - CID of a DAG root to get statistics for
15051505
15061506
OPTIONS
15071507
@@ -1668,13 +1668,19 @@ USAGE
16681668
system.
16691669
16701670
SYNOPSIS
1671-
ipfs dht put [--] <key> <value-file>
1671+
ipfs dht put [--allow-offline] [--] <key> <value-file>
16721672
16731673
ARGUMENTS
16741674
16751675
<key> - The key to store the value at.
16761676
<value-file> - A path to a file containing the value to store.
16771677
1678+
OPTIONS
1679+
1680+
--allow-offline bool - When offline, save the IPNS record to the the local
1681+
datastore without broadcasting to the network instead
1682+
of simply failing.
1683+
16781684
DESCRIPTION
16791685
16801686
Given a key of the form /foo/bar and a valid value for that key, this will write
@@ -5307,13 +5313,19 @@ USAGE
53075313
system.
53085314
53095315
SYNOPSIS
5310-
ipfs routing put [--] <key> <value-file>
5316+
ipfs routing put [--allow-offline] [--] <key> <value-file>
53115317
53125318
ARGUMENTS
53135319
53145320
<key> - The key to store the value at.
53155321
<value-file> - A path to a file containing the value to store.
53165322
5323+
OPTIONS
5324+
5325+
--allow-offline bool - When offline, save the IPNS record to the the local
5326+
datastore without broadcasting to the network instead
5327+
of simply failing.
5328+
53175329
DESCRIPTION
53185330
53195331
Given a key of the form /foo/bar and a valid value for that key, this will write

0 commit comments

Comments
 (0)