Bumped documentation & installation docs. (#1942)

ipfs · Oct 17, 2024 · 58c9f3c · 58c9f3c
1 parent 655fc62
commit 58c9f3c
Show file tree

Hide file tree

Showing 5 changed files with 163 additions and 86 deletions.
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.30.0
+current-ipfs-version: v0.31.0
 ---
 
 # 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.30.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.31.0/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.30.0/kubo_v0.30.0_windows-amd64.zip -Outfile kubo_v0.30.0.zip
+   wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_windows-amd64.zip -Outfile kubo_v0.31.0.zip
    ```
 
-1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.30.0`.
+1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.31.0`.
 
    ```powershell
-   Expand-Archive -Path kubo_v0.30.0.zip -DestinationPath ~\Apps\kubo_v0.30.0
+   Expand-Archive -Path kubo_v0.31.0.zip -DestinationPath ~\Apps\kubo_v0.31.0
    ```
 
-1. Move into the `kubo_v0.30.0` folder
+1. Move into the `kubo_v0.31.0` folder
 
    ```powershell
-   cd ~\Apps\kubo_v0.30.0\kubo
+   cd ~\Apps\kubo_v0.31.0\kubo
    ```
 
 1. Check that the `ipfs.exe` works:
 
    ```powershell
    .\ipfs.exe --version
 
-   > ipfs version 0.30.0
+   > ipfs version 0.31.0
    ```
 
    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.30.0
+   > ipfs version 0.31.0
    ```
 
 :::
@@ -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.30.0
+   > ipfs version 0.31.0
    ```
 :::
 
@@ -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.30.0/kubo_v0.30.0_linux-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_linux-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.30.0_linux-amd64.tar.gz
+   tar -xvzf kubo_v0.31.0_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.30.0
+   > ipfs version 0.31.0
    ```
 
 :::
@@ -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.30.0/kubo_v0.30.0_freebsd-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_freebsd-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.30.0_freebsd-amd64.tar.gz
+   tar -xvzf kubo_v0.31.0_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.30.0
+   > ipfs version 0.31.0
    ```
 
 :::
@@ -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.30.0/kubo_v0.30.0_openbsd-amd64.tar.gz
+   wget https://dist.ipfs.tech/kubo/v0.31.0/kubo_v0.31.0_openbsd-amd64.tar.gz
    ```
 
 1. Unzip the file:
 
    ```bash
-   tar -xvzf kubo_v0.30.0_openbsd-amd64.tar.gz
+   tar -xvzf kubo_v0.31.0_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.30.0
+   > ipfs version 0.31.0
    ```
 
 :::
@@ -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.30.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.31.0/README.md#build-from-source) section in the Kubo repository.
 
 ## Determining which node to use with the command line
 

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 2024-09-11 16:30:34, from kubo 0.30.0
-This document was autogenerated from CLI help text in [kubo 0.30.0](https://github.com/ipfs/kubo/releases/tag/v0.30.0)
+::: tip Generated on 2024-10-17 13:53:14, from kubo 0.31.0
+This document was autogenerated from CLI help text in [kubo 0.31.0](https://github.com/ipfs/kubo/releases/tag/v0.31.0)
 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.
 :::
 
@@ -1087,6 +1087,36 @@ SYNOPSIS
 DESCRIPTION
 
   Available profiles:
+    'announce-on':
+      Re-enables Reprovide system (reverts announce-off profile).
+    'randomports':
+      Use a random port number for swarm.
+    'legacy-cid-v0':
+      Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
+    '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'
+      
+    '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.
     'test':
       Reduces external interference of IPFS daemon, this
       is useful when using the daemon in test environments.
@@ -1098,30 +1128,27 @@ DESCRIPTION
       This profile may only be applied when first initializing the node.
       
     'badgerds':
-      Configures the node to use the experimental badger datastore.
+      Configures the node to use the legacy badgerv1 datastore.
+      
+      NOTE: this is badger 1.x, which has known bugs and is no longer supported by the upstream team.
+      It is provided here only for pre-existing users, allowing them to migrate away to more modern datastore.
       
-      Use this datastore if some aspects of performance, 
-      especially the speed of adding many gigabytes of files, are critical.
-      However, be aware that:
+      Other caveats:
       
       * This datastore will not properly reclaim space when your datastore is
         smaller than several gigabytes.  If you run IPFS with --enable-gc, you plan
         on storing very little data in your IPFS node, and disk usage is more
         critical than performance, consider using flatfs.
-      * This datastore uses up to several gigabytes of memory.  
+      * This datastore uses up to several gigabytes of memory.
       * Good for medium-size datastores, but may run into performance issues
         if your dataset is bigger than a terabyte.
-      * The current implementation is based on old badger 1.x
-        which is no longer supported by the upstream team.
       
-      This profile may only be applied when first initializing the node.
-    'legacy-cid-v0':
-      Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
-    '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.
+      See configuration documentation at:
+      https://github.com/ipfs/kubo/blob/master/docs/datastores.md#badgerds
+      
+      NOTE: This profile may only be applied when first initializing node at IPFS_PATH
+            via 'ipfs init --profile badgerds'
+      
     'local-discovery':
       Sets default values to fields affected by the server
       profile, enables discovery in local networks.
@@ -1131,7 +1158,7 @@ DESCRIPTION
     'flatfs':
       Configures the node to use the flatfs datastore.
       
-      This is the most battle-tested and reliable datastore. 
+      This is the most battle-tested and reliable datastore.
       You should use this datastore if:
       
       * You need a very simple and very reliable datastore, and you trust your
@@ -1142,15 +1169,26 @@ DESCRIPTION
       * You want to minimize memory usage.
       * You are ok with the default speed of data import, or prefer to use --nocopy.
       
-      This profile may only be applied when first initializing the node.
+      See configuration documentation at:
+      https://github.com/ipfs/kubo/blob/master/docs/datastores.md#flatfs
+      
+      NOTE: This profile may only be applied when first initializing node at IPFS_PATH
+            via 'ipfs init --profile flatfs'
       
     'lowpower':
       Reduces daemon overhead on the system. May affect node
       functionality - performance of content discovery and data
       fetching may be degraded.
       
-    'randomports':
-      Use a random port number for swarm.
+    'announce-off':
+      Disables Reprovide system (and announcing to Amino DHT).
+      
+      		USE WITH CAUTION:
+      		The main use case for this is setups with manual Peering.Peers config.
+      		Data from this node will not be announced on the DHT. This will make
+      		DHT-based routing an data retrieval impossible if this node is the only
+      		one hosting it, and other peers are not already connected to it.
+      
 
 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 2024-09-11, from kubo v0.30.0
-This document was autogenerated from [v0.30.0](https://github.com/ipfs/kubo/releases/tag/v0.30.0).
+::: tip Generated on 2024-10-17, from kubo v0.31.0
+This document was autogenerated from [v0.31.0](https://github.com/ipfs/kubo/releases/tag/v0.31.0).
 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.
 :::