Skip to content

Commit 6cb430e

Browse files
chore: kubo 0.33.1 (#1990)
Co-authored-by: [email protected] <lidel>
1 parent 5c87dc0 commit 6cb430e

File tree

6 files changed

+82
-80
lines changed

6 files changed

+82
-80
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.33.0
4+
current-ipfs-version: v0.33.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.33.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.33.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.33.0/kubo_v0.33.0_windows-amd64.zip -Outfile kubo_v0.33.0.zip
79+
wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_windows-amd64.zip -Outfile kubo_v0.33.1.zip
8080
```
8181

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

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

88-
1. Move into the `kubo_v0.33.0` folder
88+
1. Move into the `kubo_v0.33.1` folder
8989

9090
```powershell
91-
cd ~\Apps\kubo_v0.33.0\kubo
91+
cd ~\Apps\kubo_v0.33.1\kubo
9292
```
9393

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

9696
```powershell
9797
.\ipfs.exe --version
9898
99-
> ipfs version 0.33.0
99+
> ipfs version 0.33.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.33.0
145+
> ipfs version 0.33.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.33.0
173+
> ipfs version 0.33.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.33.0/kubo_v0.33.0_linux-amd64.tar.gz
184+
wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_linux-amd64.tar.gz
185185
```
186186

187187
1. Unzip the file:
188188

189189
```bash
190-
tar -xvzf kubo_v0.33.0_linux-amd64.tar.gz
190+
tar -xvzf kubo_v0.33.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.33.0
219+
> ipfs version 0.33.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.33.0/kubo_v0.33.0_freebsd-amd64.tar.gz
231+
wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_freebsd-amd64.tar.gz
232232
```
233233

234234
1. Unzip the file:
235235

236236
```bash
237-
tar -xvzf kubo_v0.33.0_freebsd-amd64.tar.gz
237+
tar -xvzf kubo_v0.33.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.33.0
266+
> ipfs version 0.33.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.33.0/kubo_v0.33.0_openbsd-amd64.tar.gz
278+
wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_openbsd-amd64.tar.gz
279279
```
280280

281281
1. Unzip the file:
282282

283283
```bash
284-
tar -xvzf kubo_v0.33.0_openbsd-amd64.tar.gz
284+
tar -xvzf kubo_v0.33.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.33.0
313+
> ipfs version 0.33.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.33.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.33.1/README.md#build-from-source) section in the Kubo repository.
326326

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

docs/install/run-ipfs-inside-docker.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Install IPFS Kubo inside Docker
33
description: You can run IPFS inside Docker to simplify your deployment processes, and horizontally scale your IPFS infrastructure.
4-
current-ipfs-version: v0.33.0
4+
current-ipfs-version: v0.33.1
55
---
66

77
# Install IPFS Kubo inside Docker
@@ -21,7 +21,7 @@ You can run Kubo IPFS inside Docker to simplify your deployment processes, as we
2121
1. Start a container running ipfs and expose ports `4001` (P2P TCP/QUIC transports), `5001` (RPC API) and `8080` (Gateway):
2222

2323
```shell
24-
docker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
24+
docker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.1
2525
```
2626

2727
::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET
@@ -71,7 +71,7 @@ You can run Kubo IPFS inside Docker to simplify your deployment processes, as we
7171
When starting a container running ipfs for the first time with an empty data directory, it will call `ipfs init` to initialize configuration files and generate a new keypair. At this time, you can choose which profile to apply using the `IPFS_PROFILE` environment variable:
7272

7373
```shell
74-
docker run -d --name ipfs_host -e IPFS_PROFILE=server -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
74+
docker run -d --name ipfs_host -e IPFS_PROFILE=server -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.1
7575
```
7676

7777
## Customizing your node
@@ -119,22 +119,22 @@ Example:
119119
docker run # (....)
120120
--cpus="4.0" -e GOMAXPROCS=4 \
121121
--memory="8000m" -e GOMEMLIMIT=7500MiB \
122-
ipfs/kubo:v0.33.0
122+
ipfs/kubo:v0.33.1
123123
```
124124

125125
## Private swarms inside Docker
126126

127127
It is possible to initialize the container with a swarm key file (`/data/ipfs/swarm.key`) using the variables `IPFS_SWARM_KEY` and `IPFS_SWARM_KEY_FILE`. The `IPFS_SWARM_KEY` creates `swarm.key` with the contents of the variable itself, while `IPFS_SWARM_KEY_FILE` copies the key from a path stored in the variable. The `IPFS_SWARM_KEY_FILE` **overwrites** the key generated by `IPFS_SWARM_KEY`.
128128

129129
```shell
130-
docker run -d --name ipfs_host -e IPFS_SWARM_KEY=<your swarm key> -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
130+
docker run -d --name ipfs_host -e IPFS_SWARM_KEY=<your swarm key> -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.1
131131
```
132132

133133
The swarm key initialization can also be done using docker secrets, and requires `docker swarm` or `docker-compose`:
134134

135135
```shell
136136
cat your_swarm.key | docker secret create swarm_key_secret -
137-
docker run -d --name ipfs_host --secret swarm_key_secret -e IPFS_SWARM_KEY_FILE=/run/secrets/swarm_key_secret -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
137+
docker run -d --name ipfs_host --secret swarm_key_secret -e IPFS_SWARM_KEY_FILE=/run/secrets/swarm_key_secret -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.1
138138
```
139139

140140
## Key rotation inside Docker
@@ -143,10 +143,10 @@ It is possible to do key rotation in an ephemeral container that is temporarily
143143

144144
```shell
145145
# given container named 'ipfs-test' that persists repo at /path/to/persisted/.ipfs
146-
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.0
146+
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.1
147147
docker stop ipfs-test
148148
149149
# key rotation works like this (old key saved under 'old-self')
150-
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.0 key rotate -o old-self -t ed25519
150+
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.1 key rotate -o old-self -t ed25519
151151
docker start ipfs-test # will start with the new key
152152
```

docs/reference/kubo/cli.md

Lines changed: 44 additions & 44 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 2025-01-29 23:45:27, from kubo 0.33.0
9-
This document was autogenerated from CLI help text in [kubo 0.33.0](https://github.com/ipfs/kubo/releases/tag/v0.33.0)
8+
::: tip Generated on 2025-02-04 22:02:31, from kubo 0.33.1
9+
This document was autogenerated from CLI help text in [kubo 0.33.1](https://github.com/ipfs/kubo/releases/tag/v0.33.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

@@ -1038,13 +1038,13 @@ DESCRIPTION
10381038
10391039
Examples:
10401040
1041-
Get the value of the 'Datastore.Path' key:
1041+
Get the value of the 'Routing.Type' key:
10421042
1043-
$ ipfs config Datastore.Path
1043+
$ ipfs config Routing.Type
10441044
1045-
Set the value of the 'Datastore.Path' key:
1045+
Set the value of the 'Routing.Type' key:
10461046
1047-
$ ipfs config Datastore.Path ~/.ipfs/datastore
1047+
$ ipfs config Routing.Type auto
10481048
10491049
Set multiple values in the 'Addresses.AppendAnnounce' array:
10501050
@@ -1092,27 +1092,14 @@ SYNOPSIS
10921092
DESCRIPTION
10931093
10941094
Available profiles:
1095-
'default-datastore':
1096-
Configures the node to use the default datastore (flatfs).
1097-
1098-
Read the "flatfs" profile description for more information on this datastore.
1099-
1100-
This profile may only be applied when first initializing the node.
1101-
1102-
'announce-on':
1103-
Re-enables Reprovide system (reverts announce-off profile).
1104-
'legacy-cid-v0':
1105-
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
1106-
'randomports':
1107-
Use a random port number for swarm.
1108-
'test-cid-v1':
1109-
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
1110-
'server':
1111-
Disables local host discovery, recommended when
1112-
running IPFS on machines with public IPv4 addresses.
1095+
'local-discovery':
1096+
Sets default values to fields affected by the server
1097+
profile, enables discovery in local networks.
11131098
'test':
11141099
Reduces external interference of IPFS daemon, this
11151100
is useful when using the daemon in test environments.
1101+
'announce-on':
1102+
Re-enables Reprovide system (reverts announce-off profile).
11161103
'flatfs':
11171104
Configures the node to use the flatfs datastore.
11181105
@@ -1133,26 +1120,6 @@ DESCRIPTION
11331120
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
11341121
via 'ipfs init --profile flatfs'
11351122
1136-
'lowpower':
1137-
Reduces daemon overhead on the system. May affect node
1138-
functionality - performance of content discovery and data
1139-
fetching may be degraded.
1140-
1141-
'announce-off':
1142-
Disables Reprovide system (and announcing to Amino DHT).
1143-
1144-
USE WITH CAUTION:
1145-
The main use case for this is setups with manual Peering.Peers config.
1146-
Data from this node will not be announced on the DHT. This will make
1147-
DHT-based routing and data retrieval impossible if this node is the only
1148-
one hosting it, and other peers are not already connected to it.
1149-
1150-
'local-discovery':
1151-
Sets default values to fields affected by the server
1152-
profile, enables discovery in local networks.
1153-
'default-networking':
1154-
Restores default network settings.
1155-
Inverse profile of the test profile.
11561123
'pebbleds':
11571124
Configures the node to use the pebble high-performance datastore.
11581125
@@ -1172,6 +1139,37 @@ DESCRIPTION
11721139
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
11731140
via 'ipfs init --profile pebbleds'
11741141
1142+
'randomports':
1143+
Use a random port number for swarm.
1144+
'announce-off':
1145+
Disables Reprovide system (and announcing to Amino DHT).
1146+
1147+
USE WITH CAUTION:
1148+
The main use case for this is setups with manual Peering.Peers config.
1149+
Data from this node will not be announced on the DHT. This will make
1150+
DHT-based routing and data retrieval impossible if this node is the only
1151+
one hosting it, and other peers are not already connected to it.
1152+
1153+
'legacy-cid-v0':
1154+
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
1155+
'server':
1156+
Disables local host discovery, recommended when
1157+
running IPFS on machines with public IPv4 addresses.
1158+
'default-networking':
1159+
Restores default network settings.
1160+
Inverse profile of the test profile.
1161+
'lowpower':
1162+
Reduces daemon overhead on the system. May affect node
1163+
functionality - performance of content discovery and data
1164+
fetching may be degraded.
1165+
1166+
'default-datastore':
1167+
Configures the node to use the default datastore (flatfs).
1168+
1169+
Read the "flatfs" profile description for more information on this datastore.
1170+
1171+
This profile may only be applied when first initializing the node.
1172+
11751173
'badgerds':
11761174
Configures the node to use the legacy badgerv1 datastore.
11771175
@@ -1194,6 +1192,8 @@ DESCRIPTION
11941192
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
11951193
via 'ipfs init --profile badgerds'
11961194
1195+
'test-cid-v1':
1196+
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
11971197
11981198
SUBCOMMANDS
11991199
ipfs config profile apply <profile> - Apply profile to config.

docs/reference/kubo/rpc.md

Lines changed: 4 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 2025-01-29, from kubo v0.33.0
51-
This document was autogenerated from [v0.33.0](https://github.com/ipfs/kubo/releases/tag/v0.33.0).
50+
::: tip Generated on 2025-02-04, from kubo v0.33.1
51+
This document was autogenerated from [v0.33.1](https://github.com/ipfs/kubo/releases/tag/v0.33.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

@@ -3182,6 +3182,8 @@ On success, the call to this endpoint will return with 200 and the following bod
31823182
"AvgProvideDuration": "<duration-ns>",
31833183
"LastReprovideBatchSize": "<uint64>",
31843184
"LastReprovideDuration": "<duration-ns>",
3185+
"LastRun": "<timestamp>",
3186+
"ReprovideInterval": "<duration-ns>",
31853187
"TotalProvides": "<uint64>"
31863188
}
31873189

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.1
9-
github.com/ipfs/kubo v0.33.0
9+
github.com/ipfs/kubo v0.33.1
1010
github.com/libp2p/go-libp2p v0.38.2
1111
github.com/multiformats/go-multiaddr v0.14.0
1212
)
@@ -79,7 +79,7 @@ require (
7979
github.com/ipfs-shipyard/nopfs v0.0.14 // indirect
8080
github.com/ipfs-shipyard/nopfs/ipfs v0.25.0 // indirect
8181
github.com/ipfs/bbloom v0.0.4 // indirect
82-
github.com/ipfs/boxo v0.27.2 // indirect
82+
github.com/ipfs/boxo v0.27.4 // indirect
8383
github.com/ipfs/go-bitfield v1.1.0 // indirect
8484
github.com/ipfs/go-block-format v0.2.0 // indirect
8585
github.com/ipfs/go-blockservice v0.5.2 // indirect

0 commit comments

Comments
 (0)