Skip to content

Commit 220d6cd

Browse files
Bumped documentation & installation docs. (#2224)
Co-authored-by: lidel@users.noreply.github.com <lidel>
1 parent 035f9cc commit 220d6cd

File tree

8 files changed

+44
-44
lines changed

8 files changed

+44
-44
lines changed

docs/how-to/websites-on-ipfs/deploy-github-action.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Deploy static apps to IPFS with GitHub Actions
33
description: Guide on how to setup GitHub Actions to deploy static sites/apps to IPFS using the IPFS Deploy Action.
4-
current-ipfs-version: v0.39.0
5-
current-ipfs-cluster-version: v1.1.4
4+
current-ipfs-version: v0.40.1
5+
current-ipfs-cluster-version: v1.1.5
66
---
77

88
# Deploy static apps to IPFS with GitHub Actions
@@ -170,7 +170,7 @@ You can also customize the Kubo version and [`ipfs add` parameters](https://docs
170170
uses: ipshipyard/ipfs-deploy-action@v1
171171
with:
172172
# ... other inputs ...
173-
kubo-version: 'v0.39.0' # Default, change if needed
173+
kubo-version: 'v0.40.1' # Default, change if needed
174174
ipfs-add-options: '--cid-version 1 --chunker size-1048576' # Default options
175175
```
176176

@@ -201,7 +201,7 @@ You can also configure additional IPFS Cluster options:
201201
# ... other inputs ...
202202
cluster-retry-attempts: '5' # Override number of retry attempts
203203
cluster-timeout-minutes: '15' # Override timeout in minutes per attempt
204-
ipfs-cluster-ctl-version: 'v1.1.4' # Default version
204+
ipfs-cluster-ctl-version: 'v1.1.5' # Default version
205205
cluster-pin-expire-in: '720h' # Optional: Set pin to expire after time period (e.g., 30 days)
206206
```
207207

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.39.0
4+
current-ipfs-version: v0.40.1
55
---
66

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

3535
Note the following:
3636
- 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.
37-
- 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.39.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
37+
- 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.40.1/docs/config.md#datastorestoragemax) for data retrieved from other peers.
3838

3939

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

7171
```bash
72-
wget https://dist.ipfs.tech/kubo/v0.39.0/kubo_v0.39.0_linux-amd64.tar.gz
72+
wget https://dist.ipfs.tech/kubo/v0.40.1/kubo_v0.40.1_linux-amd64.tar.gz
7373
```
7474

7575
1. Unzip the file:
7676

7777
```bash
78-
tar -xvzf kubo_v0.39.0_linux-amd64.tar.gz
78+
tar -xvzf kubo_v0.40.1_linux-amd64.tar.gz
7979

8080
> x kubo/install.sh
8181
> x kubo/ipfs
@@ -104,7 +104,7 @@ For installation instructions for your operating system, select the appropriate
104104
```bash
105105
ipfs --version
106106

107-
> ipfs version 0.39.0
107+
> ipfs version 0.40.1
108108
```
109109

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

118118
```powershell
119-
wget https://dist.ipfs.tech/kubo/v0.39.0/kubo_v0.39.0_windows-amd64.zip -Outfile kubo_v0.39.0.zip
119+
wget https://dist.ipfs.tech/kubo/v0.40.1/kubo_v0.40.1_windows-amd64.zip -Outfile kubo_v0.40.1.zip
120120
```
121121

122-
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.39.0`.
122+
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.40.1`.
123123

124124
```powershell
125-
Expand-Archive -Path kubo_v0.39.0.zip -DestinationPath ~\Apps\kubo_v0.39.0
125+
Expand-Archive -Path kubo_v0.40.1.zip -DestinationPath ~\Apps\kubo_v0.40.1
126126
```
127127

128-
1. Move into the `kubo_v0.39.0` folder
128+
1. Move into the `kubo_v0.40.1` folder
129129

130130
```powershell
131-
cd ~\Apps\kubo_v0.39.0\kubo
131+
cd ~\Apps\kubo_v0.40.1\kubo
132132
```
133133

134134
1. Check that the `ipfs.exe` works:
135135

136136
```powershell
137137
.\ipfs.exe --version
138138
139-
> ipfs version 0.39.0
139+
> ipfs version 0.40.1
140140
```
141141

142142
At this point, Kubo is usable. However, it's strongly recommended that you first add `ipfs.exe` to your `PATH` using the following steps:
@@ -182,7 +182,7 @@ For installation instructions for your operating system, select the appropriate
182182
```powershell
183183
ipfs --version
184184
185-
> ipfs version 0.39.0
185+
> ipfs version 0.40.1
186186
```
187187

188188
:::
@@ -210,7 +210,7 @@ For installation instructions for your operating system, select the appropriate
210210
If Kubo is installed, the version number displays. For example:
211211

212212
```bash
213-
> ipfs version 0.39.0
213+
> ipfs version 0.40.1
214214
```
215215
:::
216216

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

223223
```bash
224-
wget https://dist.ipfs.tech/kubo/v0.39.0/kubo_v0.39.0_freebsd-amd64.tar.gz
224+
wget https://dist.ipfs.tech/kubo/v0.40.1/kubo_v0.40.1_freebsd-amd64.tar.gz
225225
```
226226

227227
1. Unzip the file:
228228

229229
```bash
230-
tar -xvzf kubo_v0.39.0_freebsd-amd64.tar.gz
230+
tar -xvzf kubo_v0.40.1_freebsd-amd64.tar.gz
231231

232232
> x kubo/install.sh
233233
> x kubo/ipfs
@@ -256,7 +256,7 @@ For installation instructions for your operating system, select the appropriate
256256
```bash
257257
ipfs --version
258258

259-
> ipfs version 0.39.0
259+
> ipfs version 0.40.1
260260
```
261261

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

270270
```bash
271-
wget https://dist.ipfs.tech/kubo/v0.39.0/kubo_v0.39.0_openbsd-amd64.tar.gz
271+
wget https://dist.ipfs.tech/kubo/v0.40.1/kubo_v0.40.1_openbsd-amd64.tar.gz
272272
```
273273

274274
1. Unzip the file:
275275

276276
```bash
277-
tar -xvzf kubo_v0.39.0_openbsd-amd64.tar.gz
277+
tar -xvzf kubo_v0.40.1_openbsd-amd64.tar.gz
278278

279279
> x kubo/install.sh
280280
> x kubo/ipfs
@@ -303,7 +303,7 @@ For installation instructions for your operating system, select the appropriate
303303
```bash
304304
ipfs --version
305305

306-
> ipfs version 0.39.0
306+
> ipfs version 0.40.1
307307
```
308308

309309
:::
@@ -315,7 +315,7 @@ For installation instructions for your operating system, select the appropriate
315315

316316
## Build Kubo from source
317317

318-
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.39.0/README.md#build-from-source) section in the Kubo repository.
318+
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.40.1/README.md#build-from-source) section in the Kubo repository.
319319

320320
## Determining which node to use with the command line
321321

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.39.0
4+
current-ipfs-version: v0.40.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.39.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.40.1
2525
```
2626

2727
::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET
@@ -75,7 +75,7 @@ You can run Kubo IPFS inside Docker to simplify your deployment processes, as we
7575
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:
7676

7777
```shell
78-
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.39.0
78+
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.40.1
7979
```
8080

8181
## Customizing your node
@@ -123,22 +123,22 @@ Example:
123123
docker run # (....)
124124
--cpus="4.0" -e GOMAXPROCS=4 \
125125
--memory="8000m" -e GOMEMLIMIT=7500MiB \
126-
ipfs/kubo:v0.39.0
126+
ipfs/kubo:v0.40.1
127127
```
128128

129129
## Private swarms inside Docker
130130

131131
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`.
132132

133133
```shell
134-
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.39.0
134+
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.40.1
135135
```
136136

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

139139
```shell
140140
cat your_swarm.key | docker secret create swarm_key_secret -
141-
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.39.0
141+
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.40.1
142142
```
143143

144144
## Key rotation inside Docker
@@ -147,10 +147,10 @@ It is possible to do key rotation in an ephemeral container that is temporarily
147147

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

docs/install/server-infrastructure.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: IPFS Cluster
33
description: IPFS Cluster provides data orchestration across a swarm of IPFS daemons by allocating, replicating, and tracking a global pin-set distributed among multiple peers. Learn how to install it here.
4-
current-ipfs-cluster-version: v1.1.4
4+
current-ipfs-cluster-version: v1.1.5
55
---
66

77
# Set up server infrastructure with IPFS Cluster
@@ -73,13 +73,13 @@ If you're having issues installing or using Docker or Docker-Compose, see the [o
7373
1. Download the latest `ipfs-cluster-ctl` package from [dist.ipfs.tech](https://dist.ipfs.tech/#ipfs-cluster-ctl):
7474

7575
```shell
76-
wget https://dist.ipfs.tech/ipfs-cluster-ctl/v1.1.4/ipfs-cluster-ctl_v1.1.4_linux-amd64.tar.gz
76+
wget https://dist.ipfs.tech/ipfs-cluster-ctl/v1.1.5/ipfs-cluster-ctl_v1.1.5_linux-amd64.tar.gz
7777
```
7878

7979
1. Unzip the package:
8080

8181
```shell
82-
tar xvzf ipfs-cluster-ctl_v1.1.4_linux-amd64.tar.gz
82+
tar xvzf ipfs-cluster-ctl_v1.1.5_linux-amd64.tar.gz
8383
8484
> ipfs-cluster-ctl/ipfs-cluster-ctl
8585
> ipfs-cluster-ctl/LICENSE
@@ -88,10 +88,10 @@ If you're having issues installing or using Docker or Docker-Compose, see the [o
8888
> ipfs-cluster-ctl/README.md
8989
```
9090

91-
1. Download the [`docker-compose.yml` file](https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.1.4/docker-compose.yml) and place it into the `ipfs-cluster-ctl` directory:
91+
1. Download the [`docker-compose.yml` file](https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.1.5/docker-compose.yml) and place it into the `ipfs-cluster-ctl` directory:
9292

9393
```shell
94-
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.1.4/docker-compose.yml
94+
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.1.5/docker-compose.yml
9595
```
9696

9797
1. Start the cluster using `docker-compose`:

docs/reference/kubo/cli.md

Lines changed: 2 additions & 2 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 2026-02-26 02:27:01, from kubo 0.40.0
9-
This document was autogenerated from CLI help text in [kubo 0.40.0](https://github.com/ipfs/kubo/releases/tag/v0.40.0)
8+
::: tip Generated on 2026-03-10 05:47:05, from kubo 0.40.1
9+
This document was autogenerated from CLI help text in [kubo 0.40.1](https://github.com/ipfs/kubo/releases/tag/v0.40.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

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 2026-02-26, from kubo v0.40.0
51-
This document was autogenerated from [v0.40.0](https://github.com/ipfs/kubo/releases/tag/v0.40.0).
50+
::: tip Generated on 2026-03-10, from kubo v0.40.1
51+
This document was autogenerated from [v0.40.1](https://github.com/ipfs/kubo/releases/tag/v0.40.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: 1 addition & 1 deletion
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.6.0
88
github.com/ipfs/go-ipfs-cmds v0.16.0
9-
github.com/ipfs/kubo v0.40.0
9+
github.com/ipfs/kubo v0.40.1
1010
github.com/libp2p/go-libp2p v0.47.0
1111
github.com/multiformats/go-multiaddr v0.16.1
1212
)

tools/http-api-docs/go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -431,8 +431,8 @@ github.com/ipfs/go-test v0.2.3 h1:Z/jXNAReQFtCYyn7bsv/ZqUwS6E7iIcSpJ2CuzCvnrc=
431431
github.com/ipfs/go-test v0.2.3/go.mod h1:QW8vSKkwYvWFwIZQLGQXdkt9Ud76eQXRQ9Ao2H+cA1o=
432432
github.com/ipfs/go-unixfsnode v1.10.3 h1:c8sJjuGNkxXAQH75P+f5ngPda/9T+DrboVA0TcDGvGI=
433433
github.com/ipfs/go-unixfsnode v1.10.3/go.mod h1:2Jlc7DoEwr12W+7l8Hr6C7XF4NHST3gIkqSArLhGSxU=
434-
github.com/ipfs/kubo v0.40.0 h1:l1i9zQtfvT/cTilxZb0XRsac/WYwuHRhZYr29QecE0w=
435-
github.com/ipfs/kubo v0.40.0/go.mod h1:YD/0z7otaeWX/EJB27aFrpn3DeCmlES6gk9rDon+1y8=
434+
github.com/ipfs/kubo v0.40.1 h1:jCUBDTXFKp1lAewSOdAY00zsgrt0QLAgvSFldTSzgkI=
435+
github.com/ipfs/kubo v0.40.1/go.mod h1:TPL/W6+nM8U1hUWLUkpIednwf4mjrog+kp9xmySlfq8=
436436
github.com/ipld/go-car/v2 v2.16.0 h1:LWe0vmN/QcQmUU4tr34W5Nv5mNraW+G6jfN2s+ndBco=
437437
github.com/ipld/go-car/v2 v2.16.0/go.mod h1:RqFGWN9ifcXVmCrTAVnfnxiWZk1+jIx67SYhenlmL34=
438438
github.com/ipld/go-codec-dagpb v1.7.0 h1:hpuvQjCSVSLnTnHXn+QAMR0mLmb1gA6wl10LExo2Ts0=

0 commit comments

Comments
 (0)