Bumped documentation & installation docs. (#2158)

github-actions[bot] · web-flow · commit e77031bc0da5 · 2025-10-09T03:31:09.000+02:00
Co-authored-by: lidel@users.noreply.github.com &lt;lidel&gt;
diff --git a/docs/how-to/websites-on-ipfs/deploy-github-action.md b/docs/how-to/websites-on-ipfs/deploy-github-action.md
@@ -1,7 +1,7 @@
 ---
 title: Deploy static apps to IPFS with GitHub Actions
 description: Guide on how to setup GitHub Actions to deploy static sites/apps to IPFS using the IPFS Deploy Action.
-current-ipfs-version: v0.38.0
+current-ipfs-version: v0.38.1
 current-ipfs-cluster-version: v1.1.4
 ---
 
@@ -170,7 +170,7 @@ You can also customize the Kubo version and [`ipfs add` parameters](https://docs
   uses: ipfs/ipfs-deploy-action@v1
   with:
     # ... other inputs ...
-    kubo-version: 'v0.38.0' # Default, change if needed
+    kubo-version: 'v0.38.1' # Default, change if needed
     ipfs-add-options: '--cid-version 1 --chunker size-1048576' # Default options
 ```
 
diff --git a/docs/install/command-line.md b/docs/install/command-line.md
@@ -1,7 +1,7 @@
 ---
 title: Kubo
 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.
-current-ipfs-version: v0.38.0
+current-ipfs-version: v0.38.1
 ---
 
 # Install IPFS Kubo
@@ -34,7 +34,7 @@ Kubo runs on most Windows, MacOS, Linux, FreeBSD and OpenBSD systems that meet t
 
 Note the following:
 - 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.
-- 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.38.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
+- 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.38.1/docs/config.md#datastorestoragemax) for data retrieved from other peers.
 
 
 <!-- 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
 1. Download the Linux binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
 
    ```bash
-   wget https://dist.ipfs.tech/kubo/v0.38.0/kubo_v0.38.0_linux-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.38.1/kubo_v0.38.1_linux-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.38.0_linux-amd64.tar.gz
+   tar -xvzf kubo_v0.38.1_linux-amd64.tar.gz
 
    > x kubo/install.sh
    > x kubo/ipfs
@@ -104,7 +104,7 @@ For installation instructions for your operating system, select the appropriate
    ```bash
    ipfs --version
 
-   > ipfs version 0.38.0
+   > ipfs version 0.38.1
    ```
 
 :::
@@ -116,27 +116,27 @@ For installation instructions for your operating system, select the appropriate
 1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
 
    ```powershell
-   wget https://dist.ipfs.tech/kubo/v0.38.0/kubo_v0.38.0_windows-amd64.zip -Outfile kubo_v0.38.0.zip
+   wget https://dist.ipfs.tech/kubo/v0.38.1/kubo_v0.38.1_windows-amd64.zip -Outfile kubo_v0.38.1.zip
    ```
 
-1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.38.0`.
+1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.38.1`.
 
    ```powershell
-   Expand-Archive -Path kubo_v0.38.0.zip -DestinationPath ~\Apps\kubo_v0.38.0
+   Expand-Archive -Path kubo_v0.38.1.zip -DestinationPath ~\Apps\kubo_v0.38.1
    ```
 
-1. Move into the `kubo_v0.38.0` folder
+1. Move into the `kubo_v0.38.1` folder
 
    ```powershell
-   cd ~\Apps\kubo_v0.38.0\kubo
+   cd ~\Apps\kubo_v0.38.1\kubo
    ```
 
 1. Check that the `ipfs.exe` works:
 
    ```powershell
    .\ipfs.exe --version
 
-   > ipfs version 0.38.0
+   > ipfs version 0.38.1
    ```
 
    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
    ```powershell
    ipfs --version
 
-   > ipfs version 0.38.0
+   > ipfs version 0.38.1
    ```
 
 :::
@@ -210,7 +210,7 @@ For installation instructions for your operating system, select the appropriate
    If Kubo is installed, the version number displays. For example:
 
    ```bash
-   > ipfs version 0.38.0
+   > ipfs version 0.38.1
    ```
 :::
 
@@ -221,13 +221,13 @@ For installation instructions for your operating system, select the appropriate
 1. Download the FreeBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
 
    ```bash
-   wget https://dist.ipfs.tech/kubo/v0.38.0/kubo_v0.38.0_freebsd-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.38.1/kubo_v0.38.1_freebsd-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.38.0_freebsd-amd64.tar.gz
+   tar -xvzf kubo_v0.38.1_freebsd-amd64.tar.gz
 
    > x kubo/install.sh
    > x kubo/ipfs
@@ -256,7 +256,7 @@ For installation instructions for your operating system, select the appropriate
    ```bash
    ipfs --version
 
-   > ipfs version 0.38.0
+   > ipfs version 0.38.1
    ```
 
 :::
@@ -268,13 +268,13 @@ For installation instructions for your operating system, select the appropriate
 1. Download the OpenBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
 
    ```bash
-   wget https://dist.ipfs.tech/kubo/v0.38.0/kubo_v0.38.0_openbsd-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.38.1/kubo_v0.38.1_openbsd-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.38.0_openbsd-amd64.tar.gz
+   tar -xvzf kubo_v0.38.1_openbsd-amd64.tar.gz
 
    > x kubo/install.sh
    > x kubo/ipfs
@@ -303,7 +303,7 @@ For installation instructions for your operating system, select the appropriate
    ```bash
    ipfs --version
 
-   > ipfs version 0.38.0
+   > ipfs version 0.38.1
    ```
 
 :::
@@ -315,7 +315,7 @@ For installation instructions for your operating system, select the appropriate
 
 ## Build Kubo from source
 
-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.38.0/README.md#build-from-source) section in the Kubo repository.
+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.38.1/README.md#build-from-source) section in the Kubo repository.
 
 ## Determining which node to use with the command line
 
diff --git a/docs/install/run-ipfs-inside-docker.md b/docs/install/run-ipfs-inside-docker.md
@@ -1,7 +1,7 @@
 ---
 title: Install IPFS Kubo inside Docker
 description: You can run IPFS inside Docker to simplify your deployment processes, and horizontally scale your IPFS infrastructure.
-current-ipfs-version: v0.38.0
+current-ipfs-version: v0.38.1
 ---
 
 # Install IPFS Kubo inside Docker
@@ -21,7 +21,7 @@ You can run Kubo IPFS inside Docker to simplify your deployment processes, as we
 1. Start a container running ipfs and expose ports `4001` (P2P TCP/QUIC transports), `5001` (RPC API) and `8080` (Gateway):
 
     ```shell
-    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.38.0
+    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.38.1
     ```
 
     ::: 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
 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:
 
 ```shell
-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.38.0
+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.38.1
 ```
 
 ## Customizing your node
@@ -119,22 +119,22 @@ Example:
 docker run # (....)
     --cpus="4.0" -e GOMAXPROCS=4 \
     --memory="8000m" -e GOMEMLIMIT=7500MiB \
-    ipfs/kubo:v0.38.0
+    ipfs/kubo:v0.38.1
 ```
 
 ## Private swarms inside Docker
 
 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`.
 
 ```shell
-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.38.0
+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.38.1
 ```
 
 The swarm key initialization can also be done using docker secrets, and requires `docker swarm` or `docker-compose`:
 
 ```shell
 cat your_swarm.key | docker secret create swarm_key_secret -
-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.38.0
+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.38.1
 ```
 
 ## Key rotation inside Docker
@@ -143,10 +143,10 @@ It is possible to do key rotation in an ephemeral container that is temporarily
 
 ```shell
 # given container named 'ipfs-test' that persists repo at /path/to/persisted/.ipfs
-docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.38.0
+docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.38.1
 docker stop ipfs-test  
 
 # key rotation works like this (old key saved under 'old-self')
-docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.38.0 key rotate -o old-self -t ed25519
+docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.38.1 key rotate -o old-self -t ed25519
 docker start ipfs-test # will start with the new key
 ```
diff --git a/docs/reference/kubo/cli.md b/docs/reference/kubo/cli.md
@@ -5,8 +5,8 @@ description: API documentation for the Kubo command-line executable.
 
 # Kubo command-line
 
-::: tip Generated on 2025-10-02 01:49:45, from kubo 0.38.0
-This document was autogenerated from CLI help text in [kubo 0.38.0](https://github.com/ipfs/kubo/releases/tag/v0.38.0)
+::: tip Generated on 2025-10-09 00:59:20, from kubo 0.38.1
+This document was autogenerated from CLI help text in [kubo 0.38.1](https://github.com/ipfs/kubo/releases/tag/v0.38.1)
 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.
 :::
 
diff --git a/docs/reference/kubo/rpc.md b/docs/reference/kubo/rpc.md
@@ -47,8 +47,8 @@ I AM SERIOUS, DO NOT EDIT ANYTHING BELOW ;-D
 
 -->
 
-::: tip Generated on 2025-10-02, from kubo v0.38.0
-This document was autogenerated from [v0.38.0](https://github.com/ipfs/kubo/releases/tag/v0.38.0).
+::: tip Generated on 2025-10-09, from kubo v0.38.1
+This document was autogenerated from [v0.38.1](https://github.com/ipfs/kubo/releases/tag/v0.38.1).
 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.
 :::
 
diff --git a/tools/http-api-docs/go.mod b/tools/http-api-docs/go.mod
@@ -6,16 +6,18 @@ require (
 	github.com/Stebalien/go-json-doc v0.0.2
 	github.com/ipfs/go-cid v0.5.0
 	github.com/ipfs/go-ipfs-cmds v0.15.0
-	github.com/ipfs/kubo v0.38.0
+	github.com/ipfs/kubo v0.38.1
 	github.com/libp2p/go-libp2p v0.43.0
 	github.com/multiformats/go-multiaddr v0.16.1
 )
 
 require (
 	bazil.org/fuse v0.0.0-20200117225306-7b5117fecadc // indirect
 	github.com/AndreasBriese/bbloom v0.0.0-20190825152654-46b345b51c96 // indirect
-	github.com/DataDog/zstd v1.5.6-0.20230824185856-869dae002e5e // indirect
+	github.com/DataDog/zstd v1.5.7 // indirect
 	github.com/Jorropo/jsync v1.0.1 // indirect
+	github.com/RaduBerinde/axisds v0.0.0-20250419182453-5135a0650657 // indirect
+	github.com/RaduBerinde/btreemap v0.0.0-20250419174037-3d62b7205d54 // indirect
 	github.com/alecthomas/units v0.0.0-20240927000941-0f3dac36c52b // indirect
 	github.com/alexbrainman/goissue34681 v0.0.0-20191006012335-3fc7a47baff5 // indirect
 	github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239 // indirect
@@ -29,11 +31,10 @@ require (
 	github.com/ceramicnetwork/go-dag-jose v0.1.1 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/cheggaaa/pb v1.0.29 // indirect
-	github.com/cockroachdb/crlib v0.0.0-20241015224233-894974b3ad94 // indirect
+	github.com/cockroachdb/crlib v0.0.0-20241112164430-1264a2edc35b // indirect
 	github.com/cockroachdb/errors v1.11.3 // indirect
-	github.com/cockroachdb/fifo v0.0.0-20240606204812-0bbfbd93a7ce // indirect
 	github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b // indirect
-	github.com/cockroachdb/pebble/v2 v2.0.6 // indirect
+	github.com/cockroachdb/pebble/v2 v2.1.0 // indirect
 	github.com/cockroachdb/redact v1.1.5 // indirect
 	github.com/cockroachdb/swiss v0.0.0-20250624142022-d6e517c1d961 // indirect
 	github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06 // indirect
@@ -83,7 +84,7 @@ require (
 	github.com/ipfs/go-ds-flatfs v0.5.5 // indirect
 	github.com/ipfs/go-ds-leveldb v0.5.2 // indirect
 	github.com/ipfs/go-ds-measure v0.2.2 // indirect
-	github.com/ipfs/go-ds-pebble v0.5.1 // indirect
+	github.com/ipfs/go-ds-pebble v0.5.3 // indirect
 	github.com/ipfs/go-dsqueue v0.0.5 // indirect
 	github.com/ipfs/go-fs-lock v0.1.1 // indirect
 	github.com/ipfs/go-ipfs-ds-help v1.1.1 // indirect
@@ -136,6 +137,7 @@ require (
 	github.com/miekg/dns v1.1.68 // indirect
 	github.com/mikioh/tcpinfo v0.0.0-20190314235526-30a79bb1804b // indirect
 	github.com/mikioh/tcpopt v0.0.0-20190314235656-172688c1accc // indirect
+	github.com/minio/minlz v1.0.1-0.20250507153514-87eb42fe8882 // indirect
 	github.com/minio/sha256-simd v1.0.1 // indirect
 	github.com/mr-tron/base58 v1.2.0 // indirect
 	github.com/multiformats/go-base32 v0.1.0 // indirect
diff --git a/tools/http-api-docs/go.sum b/tools/http-api-docs/go.sum
