Skip to content

Commit aa91354

Browse files
authored
Merge pull request #1730 from ipfs/bump-documentation-to-latest-versions
Update release version numbers
2 parents 802df42 + 62a5cfd commit aa91354

File tree

5 files changed

+157
-111
lines changed

5 files changed

+157
-111
lines changed

docs/install/command-line.md

Lines changed: 20 additions & 20 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.22.0
4+
current-ipfs-version: v0.23.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.22.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.23.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.22.0/kubo_v0.22.0_windows-amd64.zip -Outfile kubo_v0.22.0.zip
75+
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_windows-amd64.zip -Outfile kubo_v0.23.0.zip
7676
```
7777

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

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

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

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

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

9292
```powershell
9393
.\ipfs.exe --version
9494
95-
> ipfs version 0.22.0
95+
> ipfs version 0.23.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.22.0
141+
> ipfs version 0.23.0
142142
```
143143

144144
:::
@@ -166,7 +166,7 @@ For installation instructions for your operating system, select the appropriate
166166
If Kubo is installed, the version number displays. For example:
167167

168168
```bash
169-
> ipfs version 0.22.0
169+
> ipfs version 0.23.0
170170
```
171171
:::
172172

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

179179
```bash
180-
wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_linux-amd64.tar.gz
180+
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_linux-amd64.tar.gz
181181
```
182182

183183
1. Unzip the file:
184184

185185
```bash
186-
tar -xvzf kubo_v0.22.0_linux-amd64.tar.gz
186+
tar -xvzf kubo_v0.23.0_linux-amd64.tar.gz
187187

188188
> x kubo/install.sh
189189
> x kubo/ipfs
@@ -212,7 +212,7 @@ For installation instructions for your operating system, select the appropriate
212212
```bash
213213
ipfs --version
214214

215-
> ipfs version 0.22.0
215+
> ipfs version 0.23.0
216216
```
217217

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

226226
```bash
227-
wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_freebsd-amd64.tar.gz
227+
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_freebsd-amd64.tar.gz
228228
```
229229

230230
1. Unzip the file:
231231

232232
```bash
233-
tar -xvzf kubo_v0.22.0_freebsd-amd64.tar.gz
233+
tar -xvzf kubo_v0.23.0_freebsd-amd64.tar.gz
234234

235235
> x kubo/install.sh
236236
> x kubo/ipfs
@@ -259,7 +259,7 @@ For installation instructions for your operating system, select the appropriate
259259
```bash
260260
ipfs --version
261261

262-
> ipfs version 0.22.0
262+
> ipfs version 0.23.0
263263
```
264264

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

273273
```bash
274-
wget https://dist.ipfs.tech/kubo/v0.22.0/kubo_v0.22.0_openbsd-amd64.tar.gz
274+
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_openbsd-amd64.tar.gz
275275
```
276276

277277
1. Unzip the file:
278278

279279
```bash
280-
tar -xvzf kubo_v0.22.0_openbsd-amd64.tar.gz
280+
tar -xvzf kubo_v0.23.0_openbsd-amd64.tar.gz
281281

282282
> x kubo/install.sh
283283
> x kubo/ipfs
@@ -306,7 +306,7 @@ For installation instructions for your operating system, select the appropriate
306306
```bash
307307
ipfs --version
308308

309-
> ipfs version 0.22.0
309+
> ipfs version 0.23.0
310310
```
311311

312312
:::
@@ -318,7 +318,7 @@ For installation instructions for your operating system, select the appropriate
318318

319319
## Build Kubo from source
320320

321-
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.
321+
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.23.0/README.md#build-from-source) section in the Kubo repository.
322322

323323
## Determining which node to use with the command line
324324

docs/reference/kubo/cli.md

Lines changed: 54 additions & 28 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-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)
8+
::: tip Generated on 2023-10-05 18:30:12, from kubo 0.23.0
9+
This document was autogenerated from CLI help text in [kubo 0.23.0](https://github.com/ipfs/kubo/releases/tag/v0.23.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

@@ -911,6 +911,7 @@ SYNOPSIS
911911
SUBCOMMANDS
912912
ipfs commands completion bash - Generate bash shell completions.
913913
ipfs commands completion fish - Generate fish shell completions.
914+
ipfs commands completion zsh - Generate zsh shell completions.
914915
915916
For more information about each command, use:
916917
'ipfs commands completion <subcmd> --help'
@@ -966,6 +967,31 @@ DESCRIPTION
966967
/etc/fish/completions or ~/.config/fish/completions or sourced from your ~/.config/fish/config.fish file.
967968
968969
970+
```
971+
972+
## ipfs commands completion zsh
973+
974+
```
975+
USAGE
976+
ipfs commands completion zsh - Generate zsh shell completions.
977+
978+
SYNOPSIS
979+
ipfs commands completion zsh
980+
981+
DESCRIPTION
982+
983+
Generates command completions for the zsh shell.
984+
985+
The simplest way to see it working is write the completions
986+
to a file and then source it:
987+
988+
> ipfs commands completion zsh > ipfs-completion.zsh
989+
> source ./ipfs-completion.zsh
990+
991+
To install the completions permanently, they can be moved to
992+
/etc/zsh/completions or sourced from your ~/.zshrc file.
993+
994+
969995
```
970996

971997
## ipfs config
@@ -1044,14 +1070,40 @@ SYNOPSIS
10441070
DESCRIPTION
10451071
10461072
Available profiles:
1073+
'lowpower':
1074+
Reduces daemon overhead on the system. May affect node
1075+
functionality - performance of content discovery and data
1076+
fetching may be degraded.
1077+
10471078
'randomports':
10481079
Use a random port number for swarm.
1080+
'badgerds':
1081+
Configures the node to use the experimental badger datastore.
1082+
1083+
Use this datastore if some aspects of performance,
1084+
especially the speed of adding many gigabytes of files, are critical.
1085+
However, be aware that:
1086+
1087+
* This datastore will not properly reclaim space when your datastore is
1088+
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
1089+
on storing very little data in your IPFS node, and disk usage is more
1090+
critical than performance, consider using flatfs.
1091+
* This datastore uses up to several gigabytes of memory.
1092+
* Good for medium-size datastores, but may run into performance issues
1093+
if your dataset is bigger than a terabyte.
1094+
* The current implementation is based on old badger 1.x
1095+
which is no longer supported by the upstream team.
1096+
1097+
This profile may only be applied when first initializing the node.
10491098
'server':
10501099
Disables local host discovery, recommended when
10511100
running IPFS on machines with public IPv4 addresses.
10521101
'local-discovery':
10531102
Sets default values to fields affected by the server
10541103
profile, enables discovery in local networks.
1104+
'test':
1105+
Reduces external interference of IPFS daemon, this
1106+
is useful when using the daemon in test environments.
10551107
'default-networking':
10561108
Restores default network settings.
10571109
Inverse profile of the test profile.
@@ -1078,32 +1130,6 @@ DESCRIPTION
10781130
10791131
This profile may only be applied when first initializing the node.
10801132
1081-
'badgerds':
1082-
Configures the node to use the experimental badger datastore.
1083-
1084-
Use this datastore if some aspects of performance,
1085-
especially the speed of adding many gigabytes of files, are critical.
1086-
However, be aware that:
1087-
1088-
* This datastore will not properly reclaim space when your datastore is
1089-
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
1090-
on storing very little data in your IPFS node, and disk usage is more
1091-
critical than performance, consider using flatfs.
1092-
* This datastore uses up to several gigabytes of memory.
1093-
* Good for medium-size datastores, but may run into performance issues
1094-
if your dataset is bigger than a terabyte.
1095-
* The current implementation is based on old badger 1.x
1096-
which is no longer supported by the upstream team.
1097-
1098-
This profile may only be applied when first initializing the node.
1099-
'lowpower':
1100-
Reduces daemon overhead on the system. May affect node
1101-
functionality - performance of content discovery and data
1102-
fetching may be degraded.
1103-
1104-
'test':
1105-
Reduces external interference of IPFS daemon, this
1106-
is useful when using the daemon in test environments.
11071133
11081134
SUBCOMMANDS
11091135
ipfs config profile apply <profile> - Apply profile to config.

docs/reference/kubo/rpc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ I AM SERIOUS, DO NOT EDIT ANYTHING BELOW ;-D
4747
4848
-->
4949

50-
::: tip Generated on 2023-08-09, from kubo v0.22.0
51-
This document was autogenerated from [v0.22.0](https://github.com/ipfs/kubo/releases/tag/v0.22.0).
50+
::: tip Generated on 2023-10-05, from kubo v0.23.0
51+
This document was autogenerated from [v0.23.0](https://github.com/ipfs/kubo/releases/tag/v0.23.0).
5252
For issues and support, check out the [http-api-docs](https://github.com/ipfs/ipfs-docs/tree/main/tools/http-api-docs) generator on GitHub.
5353
:::
5454

tools/http-api-docs/go.mod

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ go 1.16
55
require (
66
github.com/Stebalien/go-json-doc v0.0.2
77
github.com/ipfs/go-cid v0.4.1
8-
github.com/ipfs/go-ipfs-cmds v0.9.0
9-
github.com/ipfs/kubo v0.22.0
8+
github.com/ipfs/go-ipfs-cmds v0.10.0
9+
github.com/ipfs/kubo v0.23.0
1010
github.com/libp2p/go-libp2p-core v0.20.1
11-
github.com/multiformats/go-multiaddr v0.10.1
11+
github.com/multiformats/go-multiaddr v0.11.0
1212
)

0 commit comments

Comments
 (0)