Skip to content

Commit c84c0dd

Browse files
Kubo v0.32.1 (#1955)
Co-authored-by: [email protected] <lidel>
1 parent 3a12d10 commit c84c0dd

File tree

5 files changed

+86
-86
lines changed

5 files changed

+86
-86
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.32.0
4+
current-ipfs-version: v0.32.1
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.32.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.32.1/docs/config.md#datastorestoragemax) for data retrieved from other peers.
3535

3636

3737
<!-- TODO: hide this footgun until https://github.com/ipfs/kubo/pull/10524 is merged and released in stable kubo
@@ -76,27 +76,27 @@ For installation instructions for your operating system, select the appropriate
7676
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
7777

7878
```powershell
79-
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_windows-amd64.zip -Outfile kubo_v0.32.0.zip
79+
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_windows-amd64.zip -Outfile kubo_v0.32.1.zip
8080
```
8181

82-
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.32.0`.
82+
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.32.1`.
8383

8484
```powershell
85-
Expand-Archive -Path kubo_v0.32.0.zip -DestinationPath ~\Apps\kubo_v0.32.0
85+
Expand-Archive -Path kubo_v0.32.1.zip -DestinationPath ~\Apps\kubo_v0.32.1
8686
```
8787

88-
1. Move into the `kubo_v0.32.0` folder
88+
1. Move into the `kubo_v0.32.1` folder
8989

9090
```powershell
91-
cd ~\Apps\kubo_v0.32.0\kubo
91+
cd ~\Apps\kubo_v0.32.1\kubo
9292
```
9393

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

9696
```powershell
9797
.\ipfs.exe --version
9898
99-
> ipfs version 0.32.0
99+
> ipfs version 0.32.1
100100
```
101101

102102
At this point, Kubo is usable. However, it's strongly recommended that you first add `ipfs.exe` to your `PATH` using the following steps:
@@ -142,7 +142,7 @@ For installation instructions for your operating system, select the appropriate
142142
```powershell
143143
ipfs --version
144144
145-
> ipfs version 0.32.0
145+
> ipfs version 0.32.1
146146
```
147147

148148
:::
@@ -170,7 +170,7 @@ For installation instructions for your operating system, select the appropriate
170170
If Kubo is installed, the version number displays. For example:
171171

172172
```bash
173-
> ipfs version 0.32.0
173+
> ipfs version 0.32.1
174174
```
175175
:::
176176

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

183183
```bash
184-
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_linux-amd64.tar.gz
184+
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_linux-amd64.tar.gz
185185
```
186186

187187
1. Unzip the file:
188188

189189
```bash
190-
tar -xvzf kubo_v0.32.0_linux-amd64.tar.gz
190+
tar -xvzf kubo_v0.32.1_linux-amd64.tar.gz
191191

192192
> x kubo/install.sh
193193
> x kubo/ipfs
@@ -216,7 +216,7 @@ For installation instructions for your operating system, select the appropriate
216216
```bash
217217
ipfs --version
218218

219-
> ipfs version 0.32.0
219+
> ipfs version 0.32.1
220220
```
221221

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

230230
```bash
231-
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_freebsd-amd64.tar.gz
231+
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_freebsd-amd64.tar.gz
232232
```
233233

234234
1. Unzip the file:
235235

236236
```bash
237-
tar -xvzf kubo_v0.32.0_freebsd-amd64.tar.gz
237+
tar -xvzf kubo_v0.32.1_freebsd-amd64.tar.gz
238238

239239
> x kubo/install.sh
240240
> x kubo/ipfs
@@ -263,7 +263,7 @@ For installation instructions for your operating system, select the appropriate
263263
```bash
264264
ipfs --version
265265

266-
> ipfs version 0.32.0
266+
> ipfs version 0.32.1
267267
```
268268

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

277277
```bash
278-
wget https://dist.ipfs.tech/kubo/v0.32.0/kubo_v0.32.0_openbsd-amd64.tar.gz
278+
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_openbsd-amd64.tar.gz
279279
```
280280

281281
1. Unzip the file:
282282

283283
```bash
284-
tar -xvzf kubo_v0.32.0_openbsd-amd64.tar.gz
284+
tar -xvzf kubo_v0.32.1_openbsd-amd64.tar.gz
285285

286286
> x kubo/install.sh
287287
> x kubo/ipfs
@@ -310,7 +310,7 @@ For installation instructions for your operating system, select the appropriate
310310
```bash
311311
ipfs --version
312312

313-
> ipfs version 0.32.0
313+
> ipfs version 0.32.1
314314
```
315315

316316
:::
@@ -322,7 +322,7 @@ For installation instructions for your operating system, select the appropriate
322322

323323
## Build Kubo from source
324324

325-
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.32.0/README.md#build-from-source) section in the Kubo repository.
325+
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.32.1/README.md#build-from-source) section in the Kubo repository.
326326

327327
## Determining which node to use with the command line
328328

docs/reference/kubo/cli.md

Lines changed: 58 additions & 58 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 2024-11-14 02:07:48, from kubo 0.32.0
9-
This document was autogenerated from CLI help text in [kubo 0.32.0](https://github.com/ipfs/kubo/releases/tag/v0.32.0)
8+
::: tip Generated on 2024-11-26 17:36:12, from kubo 0.32.1
9+
This document was autogenerated from CLI help text in [kubo 0.32.1](https://github.com/ipfs/kubo/releases/tag/v0.32.1)
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

@@ -1087,43 +1087,27 @@ SYNOPSIS
10871087
DESCRIPTION
10881088
10891089
Available profiles:
1090-
'test':
1091-
Reduces external interference of IPFS daemon, this
1092-
is useful when using the daemon in test environments.
1093-
'announce-off':
1094-
Disables Reprovide system (and announcing to Amino DHT).
1095-
1096-
USE WITH CAUTION:
1097-
The main use case for this is setups with manual Peering.Peers config.
1098-
Data from this node will not be announced on the DHT. This will make
1099-
DHT-based routing an data retrieval impossible if this node is the only
1100-
one hosting it, and other peers are not already connected to it.
1101-
1102-
'default-datastore':
1103-
Configures the node to use the default datastore (flatfs).
1104-
1105-
Read the "flatfs" profile description for more information on this datastore.
1106-
1107-
This profile may only be applied when first initializing the node.
1090+
'badgerds':
1091+
Configures the node to use the legacy badgerv1 datastore.
11081092
1109-
'pebbleds':
1110-
Configures the node to use the pebble high-performance datastore.
1093+
NOTE: this is badger 1.x, which has known bugs and is no longer supported by the upstream team.
1094+
It is provided here only for pre-existing users, allowing them to migrate away to more modern datastore.
11111095
1112-
Pebble is a LevelDB/RocksDB inspired key-value store focused on performance
1113-
and internal usage by CockroachDB.
1114-
You should use this datastore if:
1096+
Other caveats:
11151097
1116-
- You need a datastore that is focused on performance.
1117-
- You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
1118-
- This datastore is good for multi-terabyte data sets.
1119-
- May benefit from tuning depending on read/write patterns and throughput.
1120-
- Performance is helped significantly by running on a system with plenty of memory.
1098+
* This datastore will not properly reclaim space when your datastore is
1099+
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
1100+
on storing very little data in your IPFS node, and disk usage is more
1101+
critical than performance, consider using flatfs.
1102+
* This datastore uses up to several gigabytes of memory.
1103+
* Good for medium-size datastores, but may run into performance issues
1104+
if your dataset is bigger than a terabyte.
11211105
11221106
See configuration documentation at:
1123-
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#pebbleds
1107+
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#badgerds
11241108
11251109
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
1126-
via 'ipfs init --profile pebbleds'
1110+
via 'ipfs init --profile badgerds'
11271111
11281112
'lowpower':
11291113
Reduces daemon overhead on the system. May affect node
@@ -1132,21 +1116,12 @@ DESCRIPTION
11321116
11331117
'test-cid-v1':
11341118
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
1135-
'server':
1136-
Disables local host discovery, recommended when
1137-
running IPFS on machines with public IPv4 addresses.
1138-
'default-networking':
1139-
Restores default network settings.
1140-
Inverse profile of the test profile.
1141-
'announce-on':
1142-
Re-enables Reprovide system (reverts announce-off profile).
1143-
'randomports':
1144-
Use a random port number for swarm.
1145-
'legacy-cid-v0':
1146-
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
11471119
'local-discovery':
11481120
Sets default values to fields affected by the server
11491121
profile, enables discovery in local networks.
1122+
'test':
1123+
Reduces external interference of IPFS daemon, this
1124+
is useful when using the daemon in test environments.
11501125
'flatfs':
11511126
Configures the node to use the flatfs datastore.
11521127
@@ -1167,28 +1142,53 @@ DESCRIPTION
11671142
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
11681143
via 'ipfs init --profile flatfs'
11691144
1170-
'badgerds':
1171-
Configures the node to use the legacy badgerv1 datastore.
1145+
'server':
1146+
Disables local host discovery, recommended when
1147+
running IPFS on machines with public IPv4 addresses.
1148+
'default-datastore':
1149+
Configures the node to use the default datastore (flatfs).
11721150
1173-
NOTE: this is badger 1.x, which has known bugs and is no longer supported by the upstream team.
1174-
It is provided here only for pre-existing users, allowing them to migrate away to more modern datastore.
1151+
Read the "flatfs" profile description for more information on this datastore.
11751152
1176-
Other caveats:
1153+
This profile may only be applied when first initializing the node.
11771154
1178-
* This datastore will not properly reclaim space when your datastore is
1179-
smaller than several gigabytes. If you run IPFS with --enable-gc, you plan
1180-
on storing very little data in your IPFS node, and disk usage is more
1181-
critical than performance, consider using flatfs.
1182-
* This datastore uses up to several gigabytes of memory.
1183-
* Good for medium-size datastores, but may run into performance issues
1184-
if your dataset is bigger than a terabyte.
1155+
'announce-off':
1156+
Disables Reprovide system (and announcing to Amino DHT).
1157+
1158+
USE WITH CAUTION:
1159+
The main use case for this is setups with manual Peering.Peers config.
1160+
Data from this node will not be announced on the DHT. This will make
1161+
DHT-based routing an data retrieval impossible if this node is the only
1162+
one hosting it, and other peers are not already connected to it.
1163+
1164+
'pebbleds':
1165+
Configures the node to use the pebble high-performance datastore.
1166+
1167+
Pebble is a LevelDB/RocksDB inspired key-value store focused on performance
1168+
and internal usage by CockroachDB.
1169+
You should use this datastore if:
1170+
1171+
- You need a datastore that is focused on performance.
1172+
- You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
1173+
- This datastore is good for multi-terabyte data sets.
1174+
- May benefit from tuning depending on read/write patterns and throughput.
1175+
- Performance is helped significantly by running on a system with plenty of memory.
11851176
11861177
See configuration documentation at:
1187-
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#badgerds
1178+
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#pebbleds
11881179
11891180
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
1190-
via 'ipfs init --profile badgerds'
1181+
via 'ipfs init --profile pebbleds'
11911182
1183+
'announce-on':
1184+
Re-enables Reprovide system (reverts announce-off profile).
1185+
'randomports':
1186+
Use a random port number for swarm.
1187+
'default-networking':
1188+
Restores default network settings.
1189+
Inverse profile of the test profile.
1190+
'legacy-cid-v0':
1191+
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
11921192
11931193
SUBCOMMANDS
11941194
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 2024-11-14, from kubo v0.32.0
51-
This document was autogenerated from [v0.32.0](https://github.com/ipfs/kubo/releases/tag/v0.32.0).
50+
::: tip Generated on 2024-11-26, from kubo v0.32.1
51+
This document was autogenerated from [v0.32.1](https://github.com/ipfs/kubo/releases/tag/v0.32.1).
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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ require (
66
github.com/Stebalien/go-json-doc v0.0.2
77
github.com/ipfs/go-cid v0.4.1
88
github.com/ipfs/go-ipfs-cmds v0.14.0
9-
github.com/ipfs/kubo v0.32.0
9+
github.com/ipfs/kubo v0.32.1
1010
github.com/libp2p/go-libp2p v0.37.0
1111
github.com/multiformats/go-multiaddr v0.13.0
1212
)
@@ -125,7 +125,7 @@ require (
125125
github.com/libp2p/go-doh-resolver v0.4.0 // indirect
126126
github.com/libp2p/go-flow-metrics v0.2.0 // indirect
127127
github.com/libp2p/go-libp2p-asn-util v0.4.1 // indirect
128-
github.com/libp2p/go-libp2p-kad-dht v0.28.0 // indirect
128+
github.com/libp2p/go-libp2p-kad-dht v0.28.1 // indirect
129129
github.com/libp2p/go-libp2p-kbucket v0.6.4 // indirect
130130
github.com/libp2p/go-libp2p-pubsub v0.12.0 // indirect
131131
github.com/libp2p/go-libp2p-pubsub-router v0.6.0 // indirect

tools/http-api-docs/go.sum

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -403,8 +403,8 @@ github.com/ipfs/go-unixfsnode v1.9.2 h1:0A12BYs4XOtDPJTMlwmNPlllDfqcc4yie4e919hc
403403
github.com/ipfs/go-unixfsnode v1.9.2/go.mod h1:v1nuMFHf4QTIhFUdPMvg1nQu7AqDLvIdwyvJ531Ot1U=
404404
github.com/ipfs/go-verifcid v0.0.3 h1:gmRKccqhWDocCRkC+a59g5QW7uJw5bpX9HWBevXa0zs=
405405
github.com/ipfs/go-verifcid v0.0.3/go.mod h1:gcCtGniVzelKrbk9ooUSX/pM3xlH73fZZJDzQJRvOUw=
406-
github.com/ipfs/kubo v0.32.0 h1:0in5oT7WaCkkJ6JyOFH/NiNFYK7z1oELpFLgKTXU7Ak=
407-
github.com/ipfs/kubo v0.32.0/go.mod h1:vtxKR1IburF+anxjesDMp39LT8H5YYmZV/Yk5t5xNAk=
406+
github.com/ipfs/kubo v0.32.1 h1:nkx5qrkMeJ2f1ET7v3vx7U1ycurM0dC9R7AnsuSrNjk=
407+
github.com/ipfs/kubo v0.32.1/go.mod h1:7fi1IMPgW5fupyMFUjJ4d4zbvkTEwq6tV3T+EQvtF28=
408408
github.com/ipld/go-car v0.6.2 h1:Hlnl3Awgnq8icK+ze3iRghk805lu8YNq3wlREDTF2qc=
409409
github.com/ipld/go-car v0.6.2/go.mod h1:oEGXdwp6bmxJCZ+rARSkDliTeYnVzv3++eXajZ+Bmr8=
410410
github.com/ipld/go-car/v2 v2.14.2 h1:9ERr7KXpCC7If0rChZLhYDlyr6Bes6yRKPJnCO3hdHY=
@@ -481,8 +481,8 @@ github.com/libp2p/go-libp2p-asn-util v0.4.1 h1:xqL7++IKD9TBFMgnLPZR6/6iYhawHKHl9
481481
github.com/libp2p/go-libp2p-asn-util v0.4.1/go.mod h1:d/NI6XZ9qxw67b4e+NgpQexCIiFYJjErASrYW4PFDN8=
482482
github.com/libp2p/go-libp2p-core v0.2.4/go.mod h1:STh4fdfa5vDYr0/SzYYeqnt+E6KfEV5VxfIrm0bcI0g=
483483
github.com/libp2p/go-libp2p-core v0.3.0/go.mod h1:ACp3DmS3/N64c2jDzcV429ukDpicbL6+TrrxANBjPGw=
484-
github.com/libp2p/go-libp2p-kad-dht v0.28.0 h1:sDqfW784w7CZQLlnMUwfeqWfXcpedKeZIM/B9/w0Tbk=
485-
github.com/libp2p/go-libp2p-kad-dht v0.28.0/go.mod h1:0wHURlSFdAC42+wF7GEmpLoARw8JuS8do2guCtc/Y/w=
484+
github.com/libp2p/go-libp2p-kad-dht v0.28.1 h1:DVTfzG8Ybn88g9RycIq47evWCRss5f0Wm8iWtpwyHso=
485+
github.com/libp2p/go-libp2p-kad-dht v0.28.1/go.mod h1:0wHURlSFdAC42+wF7GEmpLoARw8JuS8do2guCtc/Y/w=
486486
github.com/libp2p/go-libp2p-kbucket v0.3.1/go.mod h1:oyjT5O7tS9CQurok++ERgc46YLwEpuGoFq9ubvoUOio=
487487
github.com/libp2p/go-libp2p-kbucket v0.6.4 h1:OjfiYxU42TKQSB8t8WYd8MKhYhMJeO2If+NiuKfb6iQ=
488488
github.com/libp2p/go-libp2p-kbucket v0.6.4/go.mod h1:jp6w82sczYaBsAypt5ayACcRJi0lgsba7o4TzJKEfWA=

0 commit comments

Comments
 (0)