Skip to content

Commit

Permalink
Merge pull request #1730 from ipfs/bump-documentation-to-latest-versions
Browse files Browse the repository at this point in the history 
Update release version numbers
  • Loading branch information
@Jorropo
Jorropo committed Oct 5, 2023
2 parents 802df42 + 62a5cfd commit aa91354
Show file tree
Hide file tree
Showing 5 changed files with 157 additions and 111 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.22.0
current-ipfs-version: v0.23.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.22.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.23.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.22.0/kubo_v0.22.0_windows-amd64.zip -Outfile kubo_v0.22.0.zip
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_windows-amd64.zip -Outfile kubo_v0.23.0.zip
```
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.22.0`.
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.23.0`.
```powershell
Expand-Archive -Path kubo_v0.22.0.zip -DestinationPath ~\Apps\kubo_v0.22.0
Expand-Archive -Path kubo_v0.23.0.zip -DestinationPath ~\Apps\kubo_v0.23.0
```
1. Move into the `kubo_v0.22.0` folder
1. Move into the `kubo_v0.23.0` folder
```powershell
cd ~\Apps\kubo_v0.22.0\kubo
cd ~\Apps\kubo_v0.23.0\kubo
```
1. Check that the `ipfs.exe` works:
```powershell
.\ipfs.exe --version
> ipfs version 0.22.0
> ipfs version 0.23.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.22.0
> ipfs version 0.23.0
```
:::
Expand Down Expand Up @@ -166,7 +166,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.22.0
> ipfs version 0.23.0
```
:::
Expand All @@ -177,13 +177,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.22.0/kubo_v0.22.0_linux-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_linux-amd64.tar.gz
```
1. Unzip the file:
```bash
tar -xvzf kubo_v0.22.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.23.0_linux-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -212,7 +212,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.22.0
> ipfs version 0.23.0
```
:::
Expand All @@ -224,13 +224,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.22.0/kubo_v0.22.0_freebsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_freebsd-amd64.tar.gz
```
1. Unzip the file:
```bash
tar -xvzf kubo_v0.22.0_freebsd-amd64.tar.gz
tar -xvzf kubo_v0.23.0_freebsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -259,7 +259,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.22.0
> ipfs version 0.23.0
```
:::
Expand All @@ -271,13 +271,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.22.0/kubo_v0.22.0_openbsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.23.0/kubo_v0.23.0_openbsd-amd64.tar.gz
```
1. Unzip the file:
```bash
tar -xvzf kubo_v0.22.0_openbsd-amd64.tar.gz
tar -xvzf kubo_v0.23.0_openbsd-amd64.tar.gz
> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -306,7 +306,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version
> ipfs version 0.22.0
> ipfs version 0.23.0
```
:::
Expand All @@ -318,7 +318,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.22.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.23.0/README.md#build-from-source) section in the Kubo repository.
## Determining which node to use with the command line
Expand Down
82 changes: 54 additions & 28 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 2023-08-09 15:18:37, from kubo 0.22.0
This document was autogenerated from CLI help text in [kubo 0.22.0](https://github.com/ipfs/kubo/releases/tag/v0.22.0)
::: tip Generated on 2023-10-05 18:30:12, from kubo 0.23.0
This document was autogenerated from CLI help text in [kubo 0.23.0](https://github.com/ipfs/kubo/releases/tag/v0.23.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 @@ -911,6 +911,7 @@ SYNOPSIS
SUBCOMMANDS
ipfs commands completion bash - Generate bash shell completions.
ipfs commands completion fish - Generate fish shell completions.
ipfs commands completion zsh - Generate zsh shell completions.
For more information about each command, use:
'ipfs commands completion <subcmd> --help'
Expand Down Expand Up @@ -966,6 +967,31 @@ DESCRIPTION
/etc/fish/completions or ~/.config/fish/completions or sourced from your ~/.config/fish/config.fish file.
```

## ipfs commands completion zsh

```
USAGE
ipfs commands completion zsh - Generate zsh shell completions.
SYNOPSIS
ipfs commands completion zsh
DESCRIPTION
Generates command completions for the zsh shell.
The simplest way to see it working is write the completions
to a file and then source it:
> ipfs commands completion zsh > ipfs-completion.zsh
> source ./ipfs-completion.zsh
To install the completions permanently, they can be moved to
/etc/zsh/completions or sourced from your ~/.zshrc file.
```

## ipfs config
Expand Down Expand Up @@ -1044,14 +1070,40 @@ SYNOPSIS
DESCRIPTION
Available profiles:
'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.
'badgerds':
Configures the node to use the experimental badger datastore.
Use this datastore if some aspects of performance,
especially the speed of adding many gigabytes of files, are critical.
However, be aware that:
* 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.
* 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.
'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.
Expand All @@ -1078,32 +1130,6 @@ DESCRIPTION
This profile may only be applied when first initializing the node.
'badgerds':
Configures the node to use the experimental badger datastore.
Use this datastore if some aspects of performance,
especially the speed of adding many gigabytes of files, are critical.
However, be aware that:
* 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.
* 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.
'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.
SUBCOMMANDS
ipfs config profile apply <profile> - Apply profile to config.
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 2023-08-09, from kubo v0.22.0
This document was autogenerated from [v0.22.0](https://github.com/ipfs/kubo/releases/tag/v0.22.0).
::: tip Generated on 2023-10-05, from kubo v0.23.0
This document was autogenerated from [v0.23.0](https://github.com/ipfs/kubo/releases/tag/v0.23.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.
:::

Expand Down
6 changes: 3 additions & 3 deletions tools/http-api-docs/go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ go 1.16
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.9.0
github.com/ipfs/kubo v0.22.0
github.com/ipfs/go-ipfs-cmds v0.10.0
github.com/ipfs/kubo v0.23.0
github.com/libp2p/go-libp2p-core v0.20.1
github.com/multiformats/go-multiaddr v0.10.1
github.com/multiformats/go-multiaddr v0.11.0
)
Loading

0 comments on commit aa91354

Please sign in to comment.