Skip to content

Commit

Permalink
Update release version numbers (#1632)
Browse files Browse the repository at this point in the history
Co-authored-by: hacdias@users.noreply.github.com <hacdias>
  • Loading branch information
github-actions[bot] authored Jul 3, 2023
1 parent a0a2980 commit 8b4134a
Show file tree
Hide file tree
Showing 5 changed files with 418 additions and 125 deletions.
54 changes: 27 additions & 27 deletions docs/install/command-line.md
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.20.0
current-ipfs-version: v0.21.0
---

# 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.20.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.21.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.

### Kubo on resource-constrained systems

Expand Down Expand Up @@ -72,27 +72,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.20.0/kubo_v0.20.0_windows-amd64.zip -Outfile kubo_v0.20.0.zip
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_windows-amd64.zip -Outfile kubo_v0.21.0.zip
```
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.20.0`.
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.21.0`.
```powershell
Expand-Archive -Path kubo_v0.20.0.zip -DestinationPath ~\Apps\kubo_v0.20.0
Expand-Archive -Path kubo_v0.21.0.zip -DestinationPath ~\Apps\kubo_v0.21.0
```
1. Move into the `kubo_v0.20.0` folder
1. Move into the `kubo_v0.21.0` folder
```powershell
cd ~\Apps\kubo_v0.20.0\kubo
cd ~\Apps\kubo_v0.21.0\kubo
```
1. Check that the `ipfs.exe` works:
```powershell
.\ipfs.exe --version
> ipfs version 0.20.0
> ipfs version 0.21.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:
Expand Down Expand Up @@ -138,7 +138,7 @@ For installation instructions for your operating system, select the appropriate
```powershell
ipfs --version
> ipfs version 0.20.0
> ipfs version 0.21.0
```
:::
Expand All @@ -159,28 +159,28 @@ For installation instructions for your operating system, select the appropriate
1. Download the appropriate macOS binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo) based on your hardware. For example:
```bash
curl -O https://dist.ipfs.tech/kubo/v0.20.0/kubo_v0.20.0_darwin-amd64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_darwin-amd64.tar.gz
```
> :warning:
> Ensure that you download and install the appropriate binary, as the binary for an Intel-based system won't work on a system with Apple Silicon, and vice-versa.
- _If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.20.0` for an Apple-based system, run the following command:
- _If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.21.0` for an Apple-based system, run the following command:
```bash
curl -O https://dist.ipfs.tech/kubo/v0.20.0/kubo_v0.20.0_darwin-arm64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_darwin-arm64.tar.gz
```
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for `Kubo v0.20.0` for an Intel-based system, run the following command:
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for `Kubo v0.21.0` for an Intel-based system, run the following command:
```bash
curl -O https://dist.ipfs.tech/kubo/v0.20.0/kubo_v0.20.0_darwin-amd64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_darwin-amd64.tar.gz
```
1. Unzip the file. For example, to unzip `Kubo v0.20.0` for an Intel-based system:
1. Unzip the file. For example, to unzip `Kubo v0.21.0` for an Intel-based system:
```bash
tar -xvzf kubo_v0.20.0_darwin-amd64.tar.gz
tar -xvzf kubo_v0.21.0_darwin-amd64.tar.gz
```
The following output displays:
Expand Down Expand Up @@ -218,7 +218,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.20.0
> ipfs version 0.21.0
```
:::
Expand All @@ -230,13 +230,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.20.0/kubo_v0.20.0_linux-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_linux-amd64.tar.gz
```
1. Unzip the file:
```bash
tar -xvzf kubo_v0.20.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.21.0_linux-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -265,7 +265,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.20.0
> ipfs version 0.21.0
```
:::
Expand All @@ -277,13 +277,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.20.0/kubo_v0.20.0_freebsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_freebsd-amd64.tar.gz
```
1. Unzip the file:
```bash
tar -xvzf kubo_v0.20.0_freebsd-amd64.tar.gz
tar -xvzf kubo_v0.21.0_freebsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -312,7 +312,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.20.0
> ipfs version 0.21.0
```
:::
Expand All @@ -324,13 +324,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.20.0/kubo_v0.20.0_openbsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.21.0/kubo_v0.21.0_openbsd-amd64.tar.gz
```
1. Unzip the file:
```bash
tar -xvzf kubo_v0.20.0_openbsd-amd64.tar.gz
tar -xvzf kubo_v0.21.0_openbsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -359,7 +359,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.20.0
> ipfs version 0.21.0
```
:::
Expand All @@ -371,7 +371,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.20.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.21.0/README.md#build-from-source) section in the Kubo repository.
## Determining which node to use with the command line
Expand Down
64 changes: 38 additions & 26 deletions docs/reference/kubo/cli.md
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 2023-05-09 12:45:57, from kubo 0.20.0
This document was autogenerated from CLI help text in [kubo 0.20.0](https://github.com/ipfs/kubo/releases/tag/v0.20.0)
::: tip Generated on 2023-07-03 11:11:30, from kubo 0.21.0
This document was autogenerated from CLI help text in [kubo 0.21.0](https://github.com/ipfs/kubo/releases/tag/v0.21.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.
:::

Expand Down Expand Up @@ -1047,12 +1047,19 @@ DESCRIPTION
'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.
'test':
Reduces external interference of IPFS daemon, this
is useful when using the daemon in test environments.
'default-networking':
Restores default network settings.
Inverse profile of the test profile.
'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.
'badgerds':
Configures the node to use the experimental badger datastore.
Expand All @@ -1071,21 +1078,9 @@ DESCRIPTION
which is no longer supported by the upstream team.
This profile may only be applied when first initializing the node.
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'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).
Read the "flatfs" profile description for more information on this datastore.
This profile may only be applied when first initializing the node.
'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.
Expand All @@ -1102,6 +1097,11 @@ DESCRIPTION
This profile may only be applied when first initializing the node.
'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.
Expand Down Expand Up @@ -1323,7 +1323,7 @@ SUBCOMMANDS
ipfs dag import <path>... - Import the contents of .car files
ipfs dag put <object data>... - Add a DAG node to IPFS.
ipfs dag resolve <ref> - Resolve IPLD block.
ipfs dag stat <root> - Gets stats for a DAG.
ipfs dag stat <root>... - Gets stats for a DAG.
For more information about each command, use:
'ipfs dag <subcmd> --help'
Expand Down Expand Up @@ -1494,14 +1494,14 @@ DESCRIPTION

```
USAGE
ipfs dag stat <root> - Gets stats for a DAG.
ipfs dag stat <root>... - Gets stats for a DAG.
SYNOPSIS
ipfs dag stat [--progress=false] [--] <root>
ipfs dag stat [--progress=false] [--] <root>...
ARGUMENTS
<root> - CID of a DAG root to get statistics for
<root>... - CID of a DAG root to get statistics for
OPTIONS
Expand Down Expand Up @@ -1668,13 +1668,19 @@ USAGE
system.
SYNOPSIS
ipfs dht put [--] <key> <value-file>
ipfs dht put [--allow-offline] [--] <key> <value-file>
ARGUMENTS
<key> - The key to store the value at.
<value-file> - A path to a file containing the value to store.
OPTIONS
--allow-offline bool - When offline, save the IPNS record to the the local
datastore without broadcasting to the network instead
of simply failing.
DESCRIPTION
Given a key of the form /foo/bar and a valid value for that key, this will write
Expand Down Expand Up @@ -5307,13 +5313,19 @@ USAGE
system.
SYNOPSIS
ipfs routing put [--] <key> <value-file>
ipfs routing put [--allow-offline] [--] <key> <value-file>
ARGUMENTS
<key> - The key to store the value at.
<value-file> - A path to a file containing the value to store.
OPTIONS
--allow-offline bool - When offline, save the IPNS record to the the local
datastore without broadcasting to the network instead
of simply failing.
DESCRIPTION
Given a key of the form /foo/bar and a valid value for that key, this will write
Expand Down
Loading

0 comments on commit 8b4134a

Please sign in to comment.