Bumped documentation & installation docs. (#1993)

github-actions[bot] · web-flow · commit 536cd11a0bac · 2025-02-14T02:45:28.000+01:00
Co-authored-by: lidel@users.noreply.github.com &lt;lidel&gt;
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.33.1
+current-ipfs-version: v0.33.2
 ---
 
 # Install IPFS Kubo
@@ -31,7 +31,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.33.1/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.33.2/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 
@@ -76,27 +76,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.33.1/kubo_v0.33.1_windows-amd64.zip -Outfile kubo_v0.33.1.zip
+   wget https://dist.ipfs.tech/kubo/v0.33.2/kubo_v0.33.2_windows-amd64.zip -Outfile kubo_v0.33.2.zip
    ```
 
-1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.33.1`.
+1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.33.2`.
 
    ```powershell
-   Expand-Archive -Path kubo_v0.33.1.zip -DestinationPath ~\Apps\kubo_v0.33.1
+   Expand-Archive -Path kubo_v0.33.2.zip -DestinationPath ~\Apps\kubo_v0.33.2
    ```
 
-1. Move into the `kubo_v0.33.1` folder
+1. Move into the `kubo_v0.33.2` folder
 
    ```powershell
-   cd ~\Apps\kubo_v0.33.1\kubo
+   cd ~\Apps\kubo_v0.33.2\kubo
    ```
 
 1. Check that the `ipfs.exe` works:
 
    ```powershell
    .\ipfs.exe --version
 
-   > ipfs version 0.33.1
+   > ipfs version 0.33.2
    ```
 
    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
    ```powershell
    ipfs --version
 
-   > ipfs version 0.33.1
+   > ipfs version 0.33.2
    ```
 
 :::
@@ -170,7 +170,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.33.1
+   > ipfs version 0.33.2
    ```
 :::
 
@@ -181,13 +181,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.33.1/kubo_v0.33.1_linux-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.33.2/kubo_v0.33.2_linux-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.33.1_linux-amd64.tar.gz
+   tar -xvzf kubo_v0.33.2_linux-amd64.tar.gz
 
    > x kubo/install.sh
    > x kubo/ipfs
@@ -216,7 +216,7 @@ For installation instructions for your operating system, select the appropriate
    ```bash
    ipfs --version
 
-   > ipfs version 0.33.1
+   > ipfs version 0.33.2
    ```
 
 :::
@@ -228,13 +228,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.33.1/kubo_v0.33.1_freebsd-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.33.2/kubo_v0.33.2_freebsd-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.33.1_freebsd-amd64.tar.gz
+   tar -xvzf kubo_v0.33.2_freebsd-amd64.tar.gz
 
    > x kubo/install.sh
    > x kubo/ipfs
@@ -263,7 +263,7 @@ For installation instructions for your operating system, select the appropriate
    ```bash
    ipfs --version
 
-   > ipfs version 0.33.1
+   > ipfs version 0.33.2
    ```
 
 :::
@@ -275,13 +275,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.33.1/kubo_v0.33.1_openbsd-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.33.2/kubo_v0.33.2_openbsd-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.33.1_openbsd-amd64.tar.gz
+   tar -xvzf kubo_v0.33.2_openbsd-amd64.tar.gz
 
    > x kubo/install.sh
    > x kubo/ipfs
@@ -310,7 +310,7 @@ For installation instructions for your operating system, select the appropriate
    ```bash
    ipfs --version
 
-   > ipfs version 0.33.1
+   > ipfs version 0.33.2
    ```
 
 :::
@@ -322,7 +322,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.33.1/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.33.2/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.33.1
+current-ipfs-version: v0.33.2
 ---
 
 # 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.33.1
+    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.2
     ```
 
     ::: 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.33.1
+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.2
 ```
 
 ## Customizing your node
@@ -119,22 +119,22 @@ Example:
 docker run # (....)
     --cpus="4.0" -e GOMAXPROCS=4 \
     --memory="8000m" -e GOMEMLIMIT=7500MiB \
-    ipfs/kubo:v0.33.1
+    ipfs/kubo:v0.33.2
 ```
 
 ## 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.33.1
+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.2
 ```
 
 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.33.1
+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.2
 ```
 
 ## 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.33.1
+docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.2
 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.33.1 key rotate -o old-self -t ed25519
+docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.2 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-02-04 22:02:31, from kubo 0.33.1
-This document was autogenerated from CLI help text in [kubo 0.33.1](https://github.com/ipfs/kubo/releases/tag/v0.33.1)
+::: tip Generated on 2025-02-14 01:39:37, from kubo 0.33.2
+This document was autogenerated from CLI help text in [kubo 0.33.2](https://github.com/ipfs/kubo/releases/tag/v0.33.2)
 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.
 :::
 
@@ -1092,14 +1092,9 @@ SYNOPSIS
 DESCRIPTION
 
   Available profiles:
-    'local-discovery':
-      Sets default values to fields affected by the server
-      profile, enables discovery in local networks.
     'test':
       Reduces external interference of IPFS daemon, this
       is useful when using the daemon in test environments.
-    'announce-on':
-      Re-enables Reprovide system (reverts announce-off profile).
     'flatfs':
       Configures the node to use the flatfs datastore.
       
@@ -1120,27 +1115,6 @@ DESCRIPTION
       NOTE: This profile may only be applied when first initializing node at IPFS_PATH
             via 'ipfs init --profile flatfs'
       
-    'pebbleds':
-      Configures the node to use the pebble high-performance datastore.
-      
-      Pebble is a LevelDB/RocksDB inspired key-value store focused on performance
-      and internal usage by CockroachDB.
-      You should use this datastore if:
-      
-      - You need a datastore that is focused on performance.
-      - You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
-      - This datastore is good for multi-terabyte data sets.
-      - May benefit from tuning depending on read/write patterns and throughput.
-      - Performance is helped significantly by running on a system with plenty of memory.
-      
-      See configuration documentation at:
-      https://github.com/ipfs/kubo/blob/master/docs/datastores.md#pebbleds
-      
-      NOTE: This profile may only be applied when first initializing node at IPFS_PATH
-            via 'ipfs init --profile pebbleds'
-      
-    'randomports':
-      Use a random port number for swarm.
     'announce-off':
       Disables Reprovide system (and announcing to Amino DHT).
       
@@ -1150,26 +1124,47 @@ DESCRIPTION
       		DHT-based routing and data retrieval impossible if this node is the only
       		one hosting it, and other peers are not already connected to it.
       
-    'legacy-cid-v0':
-      Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
-    'server':
-      Disables local host discovery, recommended when
-      running IPFS on machines with public IPv4 addresses.
+    'announce-on':
+      Re-enables Reprovide system (reverts announce-off profile).
+    'randomports':
+      Use a random port number for swarm.
     'default-networking':
       Restores default network settings.
       Inverse profile of the test profile.
-    'lowpower':
-      Reduces daemon overhead on the system. May affect node
-      functionality - performance of content discovery and data
-      fetching may be degraded.
-      
     'default-datastore':
       Configures the node to use the default datastore (flatfs).
       
       Read the "flatfs" profile description for more information on this datastore.
       
       This profile may only be applied when first initializing the node.
       
+    'test-cid-v1':
+      Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
+    'server':
+      Disables local host discovery, recommended when
+      running IPFS on machines with public IPv4 addresses.
+    'local-discovery':
+      Sets default values to fields affected by the server
+      profile, enables discovery in local networks.
+    'pebbleds':
+      Configures the node to use the pebble high-performance datastore.
+      
+      Pebble is a LevelDB/RocksDB inspired key-value store focused on performance
+      and internal usage by CockroachDB.
+      You should use this datastore if:
+      
+      - You need a datastore that is focused on performance.
+      - You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
+      - This datastore is good for multi-terabyte data sets.
+      - May benefit from tuning depending on read/write patterns and throughput.
+      - Performance is helped significantly by running on a system with plenty of memory.
+      
+      See configuration documentation at:
+      https://github.com/ipfs/kubo/blob/master/docs/datastores.md#pebbleds
+      
+      NOTE: This profile may only be applied when first initializing node at IPFS_PATH
+            via 'ipfs init --profile pebbleds'
+      
     'badgerds':
       Configures the node to use the legacy badgerv1 datastore.
       
@@ -1192,8 +1187,13 @@ DESCRIPTION
       NOTE: This profile may only be applied when first initializing node at IPFS_PATH
             via 'ipfs init --profile badgerds'
       
-    'test-cid-v1':
-      Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
+    'lowpower':
+      Reduces daemon overhead on the system. May affect node
+      functionality - performance of content discovery and data
+      fetching may be degraded.
+      
+    'legacy-cid-v0':
+      Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
 
 SUBCOMMANDS
   ipfs config profile apply <profile> - Apply profile to config.
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-02-04, from kubo v0.33.1
-This document was autogenerated from [v0.33.1](https://github.com/ipfs/kubo/releases/tag/v0.33.1).
+::: tip Generated on 2025-02-14, from kubo v0.33.2
+This document was autogenerated from [v0.33.2](https://github.com/ipfs/kubo/releases/tag/v0.33.2).
 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,8 +6,8 @@ require (
 	github.com/Stebalien/go-json-doc v0.0.2
 	github.com/ipfs/go-cid v0.4.1
 	github.com/ipfs/go-ipfs-cmds v0.14.1
-	github.com/ipfs/kubo v0.33.1
-	github.com/libp2p/go-libp2p v0.38.2
+	github.com/ipfs/kubo v0.33.2
+	github.com/libp2p/go-libp2p v0.38.3
 	github.com/multiformats/go-multiaddr v0.14.0
 )
 
diff --git a/tools/http-api-docs/go.sum b/tools/http-api-docs/go.sum
@@ -409,8 +409,8 @@ github.com/ipfs/go-unixfsnode v1.9.2 h1:0A12BYs4XOtDPJTMlwmNPlllDfqcc4yie4e919hc
 github.com/ipfs/go-unixfsnode v1.9.2/go.mod h1:v1nuMFHf4QTIhFUdPMvg1nQu7AqDLvIdwyvJ531Ot1U=
 github.com/ipfs/go-verifcid v0.0.3 h1:gmRKccqhWDocCRkC+a59g5QW7uJw5bpX9HWBevXa0zs=
 github.com/ipfs/go-verifcid v0.0.3/go.mod h1:gcCtGniVzelKrbk9ooUSX/pM3xlH73fZZJDzQJRvOUw=
-github.com/ipfs/kubo v0.33.1 h1:dvc1o7j//9HAKjZg1d1ODSPVxmUn5YR7Ut5JPnR+H+Q=
-github.com/ipfs/kubo v0.33.1/go.mod h1:qc3gVRqjx5y9mPvsEz+CO5nc1mXvy4r9Etvqga2lnMo=
+github.com/ipfs/kubo v0.33.2 h1:lHB3FhXk9yFjCiYNTNLqOjlUy7WWrIFQzVvOkJg0Ohg=
+github.com/ipfs/kubo v0.33.2/go.mod h1:Ie+fLMp88GbFt1K3xjG6sxfzXwoAYlYRMM/DFHtYf8I=
 github.com/ipld/go-car v0.6.2 h1:Hlnl3Awgnq8icK+ze3iRghk805lu8YNq3wlREDTF2qc=
 github.com/ipld/go-car v0.6.2/go.mod h1:oEGXdwp6bmxJCZ+rARSkDliTeYnVzv3++eXajZ+Bmr8=
 github.com/ipld/go-car/v2 v2.14.2 h1:9ERr7KXpCC7If0rChZLhYDlyr6Bes6yRKPJnCO3hdHY=
@@ -480,8 +480,8 @@ github.com/libp2p/go-flow-metrics v0.0.1/go.mod h1:Iv1GH0sG8DtYN3SVJ2eG221wMiNpZ
 github.com/libp2p/go-flow-metrics v0.0.3/go.mod h1:HeoSNUrOJVK1jEpDqVEiUOIXqhbnS27omG0uWU5slZs=
 github.com/libp2p/go-flow-metrics v0.2.0 h1:EIZzjmeOE6c8Dav0sNv35vhZxATIXWZg6j/C08XmmDw=
 github.com/libp2p/go-flow-metrics v0.2.0/go.mod h1:st3qqfu8+pMfh+9Mzqb2GTiwrAGjIPszEjZmtksN8Jc=
-github.com/libp2p/go-libp2p v0.38.2 h1:9SZQDOCi82A25An4kx30lEtr6kGTxrtoaDkbs5xrK5k=
-github.com/libp2p/go-libp2p v0.38.2/go.mod h1:QWV4zGL3O9nXKdHirIC59DoRcZ446dfkjbOJ55NEWFo=
+github.com/libp2p/go-libp2p v0.38.3 h1:80lm2PNwBMIFFnkSd6QGaqeKpxFrkGTRHB4AlNxLVR8=
+github.com/libp2p/go-libp2p v0.38.3/go.mod h1:QWV4zGL3O9nXKdHirIC59DoRcZ446dfkjbOJ55NEWFo=
 github.com/libp2p/go-libp2p-asn-util v0.4.1 h1:xqL7++IKD9TBFMgnLPZR6/6iYhawHKHl950SO9L6n94=
 github.com/libp2p/go-libp2p-asn-util v0.4.1/go.mod h1:d/NI6XZ9qxw67b4e+NgpQexCIiFYJjErASrYW4PFDN8=
 github.com/libp2p/go-libp2p-core v0.2.4/go.mod h1:STh4fdfa5vDYr0/SzYYeqnt+E6KfEV5VxfIrm0bcI0g=
