Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/install/command-line.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Command-line
description: Using IPFS 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.17.0
current-ipfs-version: v0.18.1
---

# Command-line
Expand All @@ -12,7 +12,7 @@ Installing IPFS through the command-line is handy if you plan on building applic

## System requirements

Kubo IPFS requires 512MiB of memory and can run an IPFS node on a Raspberry Pi. However, how much disk space your IPFS installation takes up depends on how much data you're sharing. A base installation takes up about 12MB of disk space. One can enable automatic garbage collection via [--enable-gc](/reference/kubo/cli/#ipfs-daemon) and adjust the [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.17.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
Kubo IPFS requires 512MiB of memory and can run an IPFS node on a Raspberry Pi. However, how much disk space your IPFS installation takes up depends on how much data you're sharing. A base installation takes up about 12MB of disk space. One can enable automatic garbage collection via [--enable-gc](/reference/kubo/cli/#ipfs-daemon) and adjust the [default maximum disk storage](https://github.com/ipfs/kubo/blob/v0.18.1/docs/config.md#datastorestoragemax) for data retrieved from other peers.

## Official distributions

Expand All @@ -28,22 +28,22 @@ The IPFS team manages the [dist.ipfs.tech website](https://dist.ipfs.tech/) to h

```powershell
cd ~\
wget https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_windows-amd64.zip -Outfile kubo_v0.17.0.zip
wget https://dist.ipfs.tech/kubo/v0.18.1/kubo_v0.18.1_windows-amd64.zip -Outfile kubo_v0.18.1.zip
```

1. Unzip the file and move it somewhere handy.

```powershell
Expand-Archive -Path kubo_v0.17.0.zip -DestinationPath ~\Apps\kubo_v0.17.0
Expand-Archive -Path kubo_v0.18.1.zip -DestinationPath ~\Apps\kubo_v0.18.1
```

1. Move into the `kubo_v0.17.0` folder and check that the `ipfs.exe` works:
1. Move into the `kubo_v0.18.1` folder and check that the `ipfs.exe` works:

```powershell
cd ~\Apps\kubo_v0.17.0\kubo
cd ~\Apps\kubo_v0.18.1\kubo
.\ipfs.exe --version

> ipfs version 0.17.0
> ipfs version 0.18.1
```

While you can use IPFS right now, it's better to add `ipfs.exe` to your `PATH` by using the following steps.
Expand Down Expand Up @@ -84,7 +84,7 @@ The IPFS team manages the [dist.ipfs.tech website](https://dist.ipfs.tech/) to h
cd ~
ipfs --version

> ipfs version 0.17.0
> ipfs version 0.18.1
```

### macOS
Expand All @@ -96,13 +96,13 @@ You can install IPFS on M1-based Macs by using the `darwin-arm64` binary instead
1. Download the macOS binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
curl -O https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_darwin-amd64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.18.1/kubo_v0.18.1_darwin-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.17.0_darwin-amd64.tar.gz
tar -xvzf kubo_v0.18.1_darwin-amd64.tar.gz

> x kubo/install.sh
> x kubo/ipfs
Expand All @@ -126,21 +126,21 @@ You can install IPFS on M1-based Macs by using the `darwin-arm64` binary instead
```bash
ipfs --version

> ipfs version 0.17.0
> ipfs version 0.18.1
```

### Linux

1. Download the Linux binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```bash
wget https://dist.ipfs.tech/kubo/v0.17.0/kubo_v0.17.0_linux-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.18.1/kubo_v0.18.1_linux-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.17.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.18.1_linux-amd64.tar.gz

> x kubo/install.sh
> x kubo/ipfs
Expand All @@ -164,7 +164,7 @@ You can install IPFS on M1-based Macs by using the `darwin-arm64` binary instead
```bash
ipfs --version

> ipfs version 0.17.0
> ipfs version 0.18.1
```

## Compile manually
Expand Down
10 changes: 5 additions & 5 deletions docs/install/server-infrastructure.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Server infrastructure with IPFS Cluster
description: IPFS Cluster provides data orchestration across a swarm of IPFS daemons by allocating, replicating, and tracking a global pin-set distributed among multiple peers. Learn how to install it here.
current-ipfs-cluster-version: v1.0.4
current-ipfs-cluster-version: v1.0.6
---

# Server infrastructure
Expand Down Expand Up @@ -46,13 +46,13 @@ If you're having issues here, head over to the [official Docker documentation to
1. Download the latest `ipfs-cluster-ctl` package from [dist.ipfs.tech](https://dist.ipfs.tech/#ipfs-cluster-ctl):

```shell
wget https://dist.ipfs.tech/ipfs-cluster-ctl/v1.0.4/ipfs-cluster-ctl_v1.0.4_linux-amd64.tar.gz
wget https://dist.ipfs.tech/ipfs-cluster-ctl/v1.0.6/ipfs-cluster-ctl_v1.0.6_linux-amd64.tar.gz
```

1. Unzip the package:

```shell
tar xvzf ipfs-cluster-ctl_v1.0.4_linux-amd64.tar.gz
tar xvzf ipfs-cluster-ctl_v1.0.6_linux-amd64.tar.gz

> ipfs-cluster-ctl/ipfs-cluster-ctl
> ipfs-cluster-ctl/LICENSE
Expand All @@ -61,10 +61,10 @@ If you're having issues here, head over to the [official Docker documentation to
> ipfs-cluster-ctl/README.md
```

1. Download the [`docker-compose.yml` file](https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.0.4/docker-compose.yml) and place it into the `ipfs-cluster-ctl` directory:
1. Download the [`docker-compose.yml` file](https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.0.6/docker-compose.yml) and place it into the `ipfs-cluster-ctl` directory:

```shell
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.0.4/docker-compose.yml
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.0.6/docker-compose.yml
```

1. Start the cluster using `docker-compose`. You may have to run as root:
Expand Down
69 changes: 30 additions & 39 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 2022-11-22 16:36:20, from kubo 0.17.0
This document was autogenerated from CLI help text in [kubo 0.17.0](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
::: tip Generated on 2023-03-20 05:36:31, from kubo 0.18.1
This document was autogenerated from CLI help text in [kubo 0.18.1](https://github.com/ipfs/kubo/releases/tag/v0.18.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 @@ -1044,16 +1044,23 @@ 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.

'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'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.
'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.
'flatfs':
Configures the node to use the flatfs datastore.

Expand All @@ -1070,15 +1077,6 @@ DESCRIPTION

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.
'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.
'badgerds':
Configures the node to use the experimental badger datastore.

Expand All @@ -1097,10 +1095,12 @@ 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.
'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.

'randomports':
Use a random port number for swarm.
Expand Down Expand Up @@ -1236,7 +1236,7 @@ DESCRIPTION

ipfs config Addresses.Gateway /ip4/127.0.0.1/tcp/8082

The API address can be changed the same way:
The RPC API address can be changed the same way:

ipfs config Addresses.API /ip4/127.0.0.1/tcp/5002

Expand All @@ -1247,14 +1247,14 @@ DESCRIPTION

ipfs config Addresses.Gateway /ip4/0.0.0.0/tcp/8080

Be careful if you expose the API. It is a security risk, as anyone could
Be careful if you expose the RPC API. It is a security risk, as anyone could
control your node remotely. If you need to control the node remotely,
make sure to protect the port as you would other services or database
(firewall, authenticated proxy, etc).

HTTP Headers

ipfs supports passing arbitrary headers to the API and Gateway. You can
ipfs supports passing arbitrary headers to the RPC API and Gateway. You can
do this by setting headers on the API.HTTPHeaders and Gateway.HTTPHeaders
keys:

Expand Down Expand Up @@ -1288,18 +1288,6 @@ DESCRIPTION

export IPFS_PATH=/path/to/ipfsrepo

Routing

IPFS by default will use a DHT for content routing. There is an alternative
that operates the DHT in a 'client only' mode that can be enabled by
running the daemon as:

ipfs daemon --routing=dhtclient

Or you can set routing to dhtclient in the config:

ipfs config Routing.Type dhtclient

DEPRECATION NOTICE

Previously, ipfs used an environment variable as seen below:
Expand Down Expand Up @@ -5895,8 +5883,8 @@ ARGUMENTS

OPTIONS

--min-used-limit-perc int - Display only resources that are using above the
specified percentage.
--min-used-limit-perc int - Only display resources that are using above the
specified percentage of their respective limit.

DESCRIPTION

Expand All @@ -5910,6 +5898,9 @@ DESCRIPTION
- all -- reports the resource usage for all currently active scopes.

The output of this command is JSON.

To see all resources that are close to hitting their respective limit, one can do something like:
ipfs swarm stats --min-used-limit-perc=90 all


```
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/kubo/rpc.md
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 2022-11-22, from kubo v0.17.0
This document was autogenerated from [v0.17.0](https://github.com/ipfs/kubo/releases/tag/v0.17.0).
::: tip Generated on 2023-03-20, from kubo v0.18.1
This document was autogenerated from [v0.18.1](https://github.com/ipfs/kubo/releases/tag/v0.18.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 Expand Up @@ -4534,7 +4534,7 @@ Report resource usage for a scope.
### Arguments

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


### Response
Expand Down
6 changes: 3 additions & 3 deletions tools/http-api-docs/go.mod
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.3.2
github.com/ipfs/go-ipfs-cmds v0.8.1
github.com/ipfs/kubo v0.17.0
github.com/ipfs/go-ipfs-cmds v0.8.2
github.com/ipfs/kubo v0.18.1
github.com/libp2p/go-libp2p-core v0.20.1
github.com/multiformats/go-multiaddr v0.7.0
github.com/multiformats/go-multiaddr v0.8.0
)
Loading