Skip to content

Commit d8eeb07

Browse files
authored
Merge pull request ipfs#1439 from ipfs/bump-documentation-to-latest-versions
Update release version numbers
2 parents 0f085db + 68eb551 commit d8eeb07

File tree

5 files changed

+207
-358
lines changed

5 files changed

+207
-358
lines changed

docs/install/command-line.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Kubo
33
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.
4-
current-ipfs-version: v0.17.0
4+
current-ipfs-version: v0.18.0
55
---
66

77
# Install IPFS Kubo
@@ -31,13 +31,13 @@ Kubo runs on most Windows, MacOS, Linux, FreeBSD and OpenBSD systems that meet t
3131

3232
Note the following:
3333
- 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.
34-
- 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.17.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
34+
- 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.18.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
3535

3636
### Kubo on resource-constrained systems
3737

3838
If you are running Kubo on a resource-constrained system (such as a Raspberry Pi), you should complete the following steps:
3939

40-
1. Install OpenSSL and rebuild Kubo manually with `make build GOTAGS=openssl`. See the [download and compile](https://github.com/ipfs/kubo/blob/v0.17.0/README.md#download-and-compile-ipfs) section for more information on compiling Kubo.
40+
1. Install OpenSSL and rebuild Kubo manually with `make build GOTAGS=openssl`. See the [download and compile](https://github.com/ipfs/kubo/blob/v0.18.0/README.md#download-and-compile-ipfs) section for more information on compiling Kubo.
4141
1. Initialize your daemon with the `lowpower` profile. This reduces daemon overhead on the system but may degrade performance of content discovery and data fetching.
4242

4343
```bash
@@ -73,27 +73,27 @@ For installation instructions for your operating system, select the appropriate
7373
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
7474

7575
```powershell
76-
wget https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_windows-amd64.zip -Outfile kubo_v0.17.0.zip
76+
wget https://dist.ipfs.tech/kubo/v0.18.0/kubo_v0.18.0_windows-amd64.zip -Outfile kubo_v0.18.0.zip
7777
```
7878

79-
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.17.0`.
79+
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.18.0`.
8080

8181
```powershell
82-
Expand-Archive -Path kubo_v0.17.0.zip -DestinationPath ~\Apps\kubo_v0.17.0
82+
Expand-Archive -Path kubo_v0.18.0.zip -DestinationPath ~\Apps\kubo_v0.18.0
8383
```
8484

85-
1. Move into the `kubo_v0.17.0` folder
85+
1. Move into the `kubo_v0.18.0` folder
8686

8787
```powershell
88-
cd ~\Apps\kubo_v0.17.0\kubo
88+
cd ~\Apps\kubo_v0.18.0\kubo
8989
```
9090

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

9393
```powershell
9494
.\ipfs.exe --version
9595
96-
> ipfs version 0.17.0
96+
> ipfs version 0.18.0
9797
```
9898

9999
At this point, Kubo is usable. However, it's strongly recommended that you first add `ipfs.exe` to your `PATH` using the following steps:
@@ -139,7 +139,7 @@ For installation instructions for your operating system, select the appropriate
139139
```powershell
140140
ipfs --version
141141
142-
> ipfs version 0.17.0
142+
> ipfs version 0.18.0
143143
```
144144

145145
:::
@@ -160,28 +160,28 @@ For installation instructions for your operating system, select the appropriate
160160
1. Download the appropriate macOS binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo) based on your hardware. For example:
161161

162162
```bash
163-
curl -O https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_darwin-amd64.tar.gz
163+
curl -O https://dist.ipfs.tech/kubo/v0.18.0/kubo_v0.18.0_darwin-amd64.tar.gz
164164
```
165165

166166
> :warning:
167167
> 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.
168168
169-
- _If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.17.0` for an Apple-based system, run the following command:
169+
- _If you are using hardware with Apple Silicon, download the `darwin-arm64` binary._ For example, to download the IPFS binary for `Kubo v0.18.0` for an Apple-based system, run the following command:
170170

171171
```bash
172-
curl -O https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_darwin-arm64.tar.gz
172+
curl -O https://dist.ipfs.tech/kubo/v0.18.0/kubo_v0.18.0_darwin-arm64.tar.gz
173173
```
174174

175-
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for `Kubo v0.17.0` for an Intel-based system, run the following command:
175+
- _If you are using hardware with an Intel Processor, download the `darwin-amd64` binary._ For example, to download the IPFS binary for `Kubo v0.18.0` for an Intel-based system, run the following command:
176176

177177
```bash
178-
curl -O https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_darwin-amd64.tar.gz
178+
curl -O https://dist.ipfs.tech/kubo/v0.18.0/kubo_v0.18.0_darwin-amd64.tar.gz
179179
```
180180

181-
1. Unzip the file. For example, to unzip `Kubo v0.17.0` for an Intel-based system:
181+
1. Unzip the file. For example, to unzip `Kubo v0.18.0` for an Intel-based system:
182182

183183
```bash
184-
tar -xvzf kubo_v0.17.0_darwin-amd64.tar.gz
184+
tar -xvzf kubo_v0.18.0_darwin-amd64.tar.gz
185185
```
186186

187187
The following output displays:
@@ -219,7 +219,7 @@ For installation instructions for your operating system, select the appropriate
219219
If Kubo is installed, the version number displays. For example:
220220

221221
```bash
222-
> ipfs version 0.17.0
222+
> ipfs version 0.18.0
223223
```
224224

225225
:::
@@ -231,13 +231,13 @@ For installation instructions for your operating system, select the appropriate
231231
1. Download the Linux binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
232232

233233
```bash
234-
wget https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_linux-amd64.tar.gz
234+
wget https://dist.ipfs.tech/kubo/v0.18.0/kubo_v0.18.0_linux-amd64.tar.gz
235235
```
236236

237237
1. Unzip the file:
238238

239239
```bash
240-
tar -xvzf kubo_v0.17.0_linux-amd64.tar.gz
240+
tar -xvzf kubo_v0.18.0_linux-amd64.tar.gz
241241
242242
> x kubo/install.sh
243243
> x kubo/ipfs
@@ -266,7 +266,7 @@ For installation instructions for your operating system, select the appropriate
266266
```bash
267267
ipfs --version
268268
269-
> ipfs version 0.17.0
269+
> ipfs version 0.18.0
270270
```
271271

272272
:::
@@ -278,13 +278,13 @@ For installation instructions for your operating system, select the appropriate
278278
1. Download the FreeBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
279279

280280
```bash
281-
wget https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_freebsd-amd64.tar.gz
281+
wget https://dist.ipfs.tech/kubo/v0.18.0/kubo_v0.18.0_freebsd-amd64.tar.gz
282282
```
283283

284284
1. Unzip the file:
285285

286286
```bash
287-
tar -xvzf kubo_v0.17.0_freebsd-amd64.tar.gz
287+
tar -xvzf kubo_v0.18.0_freebsd-amd64.tar.gz
288288
289289
> x kubo/install.sh
290290
> x kubo/ipfs
@@ -313,7 +313,7 @@ For installation instructions for your operating system, select the appropriate
313313
```bash
314314
ipfs --version
315315
316-
> ipfs version 0.17.0
316+
> ipfs version 0.18.0
317317
```
318318

319319
:::
@@ -325,13 +325,13 @@ For installation instructions for your operating system, select the appropriate
325325
1. Download the OpenBSD binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
326326

327327
```bash
328-
wget https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_openbsd-amd64.tar.gz
328+
wget https://dist.ipfs.tech/kubo/v0.18.0/kubo_v0.18.0_openbsd-amd64.tar.gz
329329
```
330330

331331
1. Unzip the file:
332332

333333
```bash
334-
tar -xvzf kubo_v0.17.0_openbsd-amd64.tar.gz
334+
tar -xvzf kubo_v0.18.0_openbsd-amd64.tar.gz
335335
336336
> x kubo/install.sh
337337
> x kubo/ipfs
@@ -360,7 +360,7 @@ For installation instructions for your operating system, select the appropriate
360360
```bash
361361
ipfs --version
362362
363-
> ipfs version 0.17.0
363+
> ipfs version 0.18.0
364364
```
365365

366366
:::
@@ -372,7 +372,7 @@ For installation instructions for your operating system, select the appropriate
372372

373373
## Build Kubo from source
374374

375-
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.17.0/README.md#build-from-source) section in the Kubo repository.
375+
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.18.0/README.md#build-from-source) section in the Kubo repository.
376376

377377
## Determining which node to use with the command line
378378

docs/reference/kubo/cli.md

Lines changed: 31 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ description: API documentation for the Kubo command-line executable.
55

66
# Kubo command-line
77

8-
::: tip Generated on 2022-11-22 16:36:20, from kubo 0.17.0
9-
This document was autogenerated from CLI help text in [kubo 0.17.0](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
8+
::: tip Generated on 2023-01-24 05:33:54, from kubo 0.18.0
9+
This document was autogenerated from CLI help text in [kubo 0.18.0](https://github.com/ipfs/kubo/releases/tag/v0.18.0)
1010
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.
1111
:::
1212

1313
<!-- DO NOT EDIT THIS FILE. This file is auto-generated from `generate-cli-docs.sh`. Any changes you make to this file will be overwritten. To edit this file, change the contents of the `generate-cli-docs.sh` script. -->
1414

1515
IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like `ipfs swarm peers`, are only supported when online.
1616

17-
The [command-line quickstart guide](../../how-to/command-line-quick-start.md#take-your-node-online) explains how to start the IPFS daemon and take your node online.
17+
The [command-line quickstart guide](/how-to/command-line-quick-start/#take-your-node-online) explains how to start the IPFS daemon and take your node online.
1818

1919

2020

2121
### Alignment with Kubo RPC API
2222

23-
Every command usable from the CLI is also available through the [RPC API v0](../../reference/kubo/rpc.md). For example:
23+
Every command usable from the CLI is also available through the [RPC API v0](/reference/kubo/rpc). For example:
2424

2525
```sh
2626
> ipfs swarm peers
@@ -1044,16 +1044,6 @@ SYNOPSIS
10441044
DESCRIPTION
10451045
10461046
Available profiles:
1047-
'server':
1048-
Disables local host discovery, recommended when
1049-
running IPFS on machines with public IPv4 addresses.
1050-
'default-datastore':
1051-
Configures the node to use the default datastore (flatfs).
1052-
1053-
Read the "flatfs" profile description for more information on this datastore.
1054-
1055-
This profile may only be applied when first initializing the node.
1056-
10571047
'flatfs':
10581048
Configures the node to use the flatfs datastore.
10591049
@@ -1070,15 +1060,6 @@ DESCRIPTION
10701060
10711061
This profile may only be applied when first initializing the node.
10721062
1073-
'local-discovery':
1074-
Sets default values to fields affected by the server
1075-
profile, enables discovery in local networks.
1076-
'test':
1077-
Reduces external interference of IPFS daemon, this
1078-
is useful when using the daemon in test environments.
1079-
'default-networking':
1080-
Restores default network settings.
1081-
Inverse profile of the test profile.
10821063
'badgerds':
10831064
Configures the node to use the experimental badger datastore.
10841065
@@ -1104,6 +1085,25 @@ DESCRIPTION
11041085
11051086
'randomports':
11061087
Use a random port number for swarm.
1088+
'local-discovery':
1089+
Sets default values to fields affected by the server
1090+
profile, enables discovery in local networks.
1091+
'test':
1092+
Reduces external interference of IPFS daemon, this
1093+
is useful when using the daemon in test environments.
1094+
'default-networking':
1095+
Restores default network settings.
1096+
Inverse profile of the test profile.
1097+
'default-datastore':
1098+
Configures the node to use the default datastore (flatfs).
1099+
1100+
Read the "flatfs" profile description for more information on this datastore.
1101+
1102+
This profile may only be applied when first initializing the node.
1103+
1104+
'server':
1105+
Disables local host discovery, recommended when
1106+
running IPFS on machines with public IPv4 addresses.
11071107
11081108
SUBCOMMANDS
11091109
ipfs config profile apply <profile> - Apply profile to config.
@@ -1236,7 +1236,7 @@ DESCRIPTION
12361236
12371237
ipfs config Addresses.Gateway /ip4/127.0.0.1/tcp/8082
12381238
1239-
The API address can be changed the same way:
1239+
The RPC API address can be changed the same way:
12401240
12411241
ipfs config Addresses.API /ip4/127.0.0.1/tcp/5002
12421242
@@ -1247,14 +1247,14 @@ DESCRIPTION
12471247
12481248
ipfs config Addresses.Gateway /ip4/0.0.0.0/tcp/8080
12491249
1250-
Be careful if you expose the API. It is a security risk, as anyone could
1250+
Be careful if you expose the RPC API. It is a security risk, as anyone could
12511251
control your node remotely. If you need to control the node remotely,
12521252
make sure to protect the port as you would other services or database
12531253
(firewall, authenticated proxy, etc).
12541254
12551255
HTTP Headers
12561256
1257-
ipfs supports passing arbitrary headers to the API and Gateway. You can
1257+
ipfs supports passing arbitrary headers to the RPC API and Gateway. You can
12581258
do this by setting headers on the API.HTTPHeaders and Gateway.HTTPHeaders
12591259
keys:
12601260
@@ -1288,18 +1288,6 @@ DESCRIPTION
12881288
12891289
export IPFS_PATH=/path/to/ipfsrepo
12901290
1291-
Routing
1292-
1293-
IPFS by default will use a DHT for content routing. There is an alternative
1294-
that operates the DHT in a 'client only' mode that can be enabled by
1295-
running the daemon as:
1296-
1297-
ipfs daemon --routing=dhtclient
1298-
1299-
Or you can set routing to dhtclient in the config:
1300-
1301-
ipfs config Routing.Type dhtclient
1302-
13031291
DEPRECATION NOTICE
13041292
13051293
Previously, ipfs used an environment variable as seen below:
@@ -5895,8 +5883,8 @@ ARGUMENTS
58955883
58965884
OPTIONS
58975885
5898-
--min-used-limit-perc int - Display only resources that are using above the
5899-
specified percentage.
5886+
--min-used-limit-perc int - Only display resources that are using above the
5887+
specified percentage of their respective limit.
59005888
59015889
DESCRIPTION
59025890
@@ -5910,6 +5898,9 @@ DESCRIPTION
59105898
- all -- reports the resource usage for all currently active scopes.
59115899
59125900
The output of this command is JSON.
5901+
5902+
To see all resources that are close to hitting their respective limit, one can do something like:
5903+
ipfs swarm stats --min-used-limit-perc=90 all
59135904
59145905
59155906
```

docs/reference/kubo/rpc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ I AM SERIOUS, DO NOT EDIT ANYTHING BELOW ;-D
4747
4848
-->
4949

50-
::: tip Generated on 2023-01-19, from kubo v0.17.0
51-
This document was autogenerated from [v0.17.0](https://github.com/ipfs/kubo/releases/tag/v0.17.0).
50+
::: tip Generated on 2023-01-24, from kubo v0.18.0
51+
This document was autogenerated from [v0.18.0](https://github.com/ipfs/kubo/releases/tag/v0.18.0).
5252
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.
5353
:::
5454

@@ -4362,7 +4362,7 @@ Report resource usage for a scope.
43624362
### Arguments
43634363

43644364
- `arg` [string]: scope of the stat report Required: **yes**.
4365-
- `min-used-limit-perc` [int]: Display only resources that are using above the specified percentage. Required: no.
4365+
- `min-used-limit-perc` [int]: Only display resources that are using above the specified percentage of their respective limit. Required: no.
43664366

43674367

43684368
### Response

tools/http-api-docs/go.mod

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ go 1.16
55
require (
66
github.com/Stebalien/go-json-doc v0.0.2
77
github.com/ipfs/go-cid v0.3.2
8-
github.com/ipfs/go-ipfs-cmds v0.8.1
9-
github.com/ipfs/kubo v0.17.0
8+
github.com/ipfs/go-ipfs-cmds v0.8.2
9+
github.com/ipfs/kubo v0.18.0
1010
github.com/libp2p/go-libp2p-core v0.20.1
11-
github.com/multiformats/go-multiaddr v0.7.0
11+
github.com/multiformats/go-multiaddr v0.8.0
1212
)

0 commit comments

Comments
 (0)