Skip to content

Commit

Permalink
Bumped documentation & installation docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Nov 21, 2024
1 parent 3a12d10 commit 6baff72
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 93 deletions.
40 changes: 20 additions & 20 deletions docs/install/command-line.md
View file
Original file line number Diff line number Diff line change
@@ -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.32.0
current-ipfs-version: v0.32.1
---

# Install IPFS Kubo
Expand Down Expand Up @@ -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.32.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.32.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
Expand Down Expand Up @@ -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.32.0/kubo_v0.32.0_windows-amd64.zip -Outfile kubo_v0.32.0.zip
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_windows-amd64.zip -Outfile kubo_v0.32.1.zip
```

1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.32.0`.
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.32.1`.

```powershell
Expand-Archive -Path kubo_v0.32.0.zip -DestinationPath ~\Apps\kubo_v0.32.0
Expand-Archive -Path kubo_v0.32.1.zip -DestinationPath ~\Apps\kubo_v0.32.1
```

1. Move into the `kubo_v0.32.0` folder
1. Move into the `kubo_v0.32.1` folder

```powershell
cd ~\Apps\kubo_v0.32.0\kubo
cd ~\Apps\kubo_v0.32.1\kubo
```

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

```powershell
.\ipfs.exe --version
> ipfs version 0.32.0
> ipfs version 0.32.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:
Expand Down Expand Up @@ -142,7 +142,7 @@ For installation instructions for your operating system, select the appropriate
```powershell
ipfs --version
> ipfs version 0.32.0
> ipfs version 0.32.1
```

:::
Expand Down Expand Up @@ -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.32.0
> ipfs version 0.32.1
```
:::

Expand All @@ -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.32.0/kubo_v0.32.0_linux-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_linux-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.32.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.32.1_linux-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -216,7 +216,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.32.0
> ipfs version 0.32.1
```

:::
Expand All @@ -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.32.0/kubo_v0.32.0_freebsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_freebsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.32.0_freebsd-amd64.tar.gz
tar -xvzf kubo_v0.32.1_freebsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -263,7 +263,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.32.0
> ipfs version 0.32.1
```

:::
Expand All @@ -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.32.0/kubo_v0.32.0_openbsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_openbsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.32.0_openbsd-amd64.tar.gz
tar -xvzf kubo_v0.32.1_openbsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -310,7 +310,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.32.0
> ipfs version 0.32.1
```

:::
Expand All @@ -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.32.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.32.1/README.md#build-from-source) section in the Kubo repository.

## Determining which node to use with the command line

Expand Down
130 changes: 65 additions & 65 deletions docs/reference/kubo/cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ description: API documentation for the Kubo command-line executable.

# Kubo command-line

::: tip Generated on 2024-11-14 02:07:48, from kubo 0.32.0
This document was autogenerated from CLI help text in [kubo 0.32.0](https://github.com/ipfs/kubo/releases/tag/v0.32.0)
::: tip Generated on 2024-11-21 17:35:59, from kubo 0.32.1
This document was autogenerated from CLI help text in [kubo 0.32.1](https://github.com/ipfs/kubo/releases/tag/v0.32.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.
:::

Expand Down Expand Up @@ -1087,9 +1087,43 @@ SYNOPSIS
DESCRIPTION
Available profiles:
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'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.
'announce-on':
Re-enables Reprovide system (reverts announce-off profile).
'randomports':
Use a random port number for swarm.
'badgerds':
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.
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.
* Good for medium-size datastores, but may run into performance issues
if your dataset is bigger than a terabyte.
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'
'announce-off':
Disables Reprovide system (and announcing to Amino DHT).
Expand All @@ -1099,12 +1133,25 @@ DESCRIPTION
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.
'default-datastore':
Configures the node to use the default datastore (flatfs).
'flatfs':
Configures the node to use the flatfs datastore.
Read the "flatfs" profile description for more information on this datastore.
This is the most battle-tested and reliable datastore.
You should use this datastore if:
This profile may only be applied when first initializing the node.
* You need a very simple and very reliable datastore, and you trust your
filesystem. This datastore stores each block as a separate file in the
underlying filesystem so it's unlikely to loose data unless there's an issue
with the underlying file system.
* You need to run garbage collection in a way that reclaims free space as soon as possible.
* You want to minimize memory usage.
* You are ok with the default speed of data import, or prefer to use --nocopy.
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'
'pebbleds':
Configures the node to use the pebble high-performance datastore.
Expand All @@ -1125,69 +1172,22 @@ DESCRIPTION
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile pebbleds'
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'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.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
'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.
'test-cid-v1':
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'flatfs':
Configures the node to use the flatfs 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
filesystem. This datastore stores each block as a separate file in the
underlying filesystem so it's unlikely to loose data unless there's an issue
with the underlying file system.
* You need to run garbage collection in a way that reclaims free space as soon as possible.
* You want to minimize memory usage.
* You are ok with the default speed of data import, or prefer to use --nocopy.
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'
'badgerds':
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.
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.
* Good for medium-size datastores, but may run into performance issues
if your dataset is bigger than a terabyte.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'default-datastore':
Configures the node to use the default datastore (flatfs).
See configuration documentation at:
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#badgerds
Read the "flatfs" profile description for more information on this datastore.
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile badgerds'
This profile may only be applied when first initializing the node.
SUBCOMMANDS
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/kubo/rpc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ I AM SERIOUS, DO NOT EDIT ANYTHING BELOW ;-D
-->

::: tip Generated on 2024-11-14, from kubo v0.32.0
This document was autogenerated from [v0.32.0](https://github.com/ipfs/kubo/releases/tag/v0.32.0).
::: tip Generated on 2024-11-21, from kubo v0.32.1
This document was autogenerated from [v0.32.1](https://github.com/ipfs/kubo/releases/tag/v0.32.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.
:::

Expand Down
4 changes: 2 additions & 2 deletions tools/http-api-docs/go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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.0
github.com/ipfs/kubo v0.32.0
github.com/ipfs/kubo v0.32.1
github.com/libp2p/go-libp2p v0.37.0
github.com/multiformats/go-multiaddr v0.13.0
)
Expand Down Expand Up @@ -125,7 +125,7 @@ require (
github.com/libp2p/go-doh-resolver v0.4.0 // indirect
github.com/libp2p/go-flow-metrics v0.2.0 // indirect
github.com/libp2p/go-libp2p-asn-util v0.4.1 // indirect
github.com/libp2p/go-libp2p-kad-dht v0.28.0 // indirect
github.com/libp2p/go-libp2p-kad-dht v0.28.1 // indirect
github.com/libp2p/go-libp2p-kbucket v0.6.4 // indirect
github.com/libp2p/go-libp2p-pubsub v0.12.0 // indirect
github.com/libp2p/go-libp2p-pubsub-router v0.6.0 // indirect
Expand Down
8 changes: 4 additions & 4 deletions tools/http-api-docs/go.sum
View file
Original file line number Diff line number Diff line change
Expand Up @@ -403,8 +403,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.32.0 h1:0in5oT7WaCkkJ6JyOFH/NiNFYK7z1oELpFLgKTXU7Ak=
github.com/ipfs/kubo v0.32.0/go.mod h1:vtxKR1IburF+anxjesDMp39LT8H5YYmZV/Yk5t5xNAk=
github.com/ipfs/kubo v0.32.1 h1:nkx5qrkMeJ2f1ET7v3vx7U1ycurM0dC9R7AnsuSrNjk=
github.com/ipfs/kubo v0.32.1/go.mod h1:7fi1IMPgW5fupyMFUjJ4d4zbvkTEwq6tV3T+EQvtF28=
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=
Expand Down Expand Up @@ -481,8 +481,8 @@ github.com/libp2p/go-libp2p-asn-util v0.4.1 h1:xqL7++IKD9TBFMgnLPZR6/6iYhawHKHl9
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=
github.com/libp2p/go-libp2p-core v0.3.0/go.mod h1:ACp3DmS3/N64c2jDzcV429ukDpicbL6+TrrxANBjPGw=
github.com/libp2p/go-libp2p-kad-dht v0.28.0 h1:sDqfW784w7CZQLlnMUwfeqWfXcpedKeZIM/B9/w0Tbk=
github.com/libp2p/go-libp2p-kad-dht v0.28.0/go.mod h1:0wHURlSFdAC42+wF7GEmpLoARw8JuS8do2guCtc/Y/w=
github.com/libp2p/go-libp2p-kad-dht v0.28.1 h1:DVTfzG8Ybn88g9RycIq47evWCRss5f0Wm8iWtpwyHso=
github.com/libp2p/go-libp2p-kad-dht v0.28.1/go.mod h1:0wHURlSFdAC42+wF7GEmpLoARw8JuS8do2guCtc/Y/w=
github.com/libp2p/go-libp2p-kbucket v0.3.1/go.mod h1:oyjT5O7tS9CQurok++ERgc46YLwEpuGoFq9ubvoUOio=
github.com/libp2p/go-libp2p-kbucket v0.6.4 h1:OjfiYxU42TKQSB8t8WYd8MKhYhMJeO2If+NiuKfb6iQ=
github.com/libp2p/go-libp2p-kbucket v0.6.4/go.mod h1:jp6w82sczYaBsAypt5ayACcRJi0lgsba7o4TzJKEfWA=
Expand Down

0 comments on commit 6baff72

Please sign in to comment.