Skip to content

Commit

Permalink
Bumped documentation & installation docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel@users.noreply.github.com committed Aug 30, 2022
1 parent 517ed21 commit 7d5a69e
Show file tree
Hide file tree
Showing 5 changed files with 154 additions and 119 deletions.
28 changes: 14 additions & 14 deletions docs/install/command-line.md
View file
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.14.0
current-ipfs-version: v0.15.0
---

# 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.14.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.15.0/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.14.0/kubo_v0.14.0_windows-amd64.zip -Outfile kubo_v0.14.0.zip
wget https://dist.ipfs.tech/kubo/v0.15.0/kubo_v0.15.0_windows-amd64.zip -Outfile kubo_v0.15.0.zip
```

1. Unzip the file and move it somewhere handy.

```powershell
Expand-Archive -Path kubo_v0.14.0.zip -DestinationPath ~\Apps\kubo_v0.14.0
Expand-Archive -Path kubo_v0.15.0.zip -DestinationPath ~\Apps\kubo_v0.15.0
```

1. Move into the `kubo_v0.14.0` folder and check that the `ipfs.exe` works:
1. Move into the `kubo_v0.15.0` folder and check that the `ipfs.exe` works:

```powershell
cd ~\Apps\kubo_v0.14.0\kubo
cd ~\Apps\kubo_v0.15.0\kubo
.\ipfs.exe --version
> ipfs version 0.14.0
> ipfs version 0.15.0
```

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.14.0
> ipfs version 0.15.0
```

### 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.14.0/kubo_v0.14.0_darwin-amd64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.15.0/kubo_v0.15.0_darwin-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.14.0_darwin-amd64.tar.gz
tar -xvzf kubo_v0.15.0_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.14.0
> ipfs version 0.15.0
```

### Linux

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

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

1. Unzip the file:

```bash
tar -xvzf kubo_v0.14.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.15.0_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.14.0
> ipfs version 0.15.0
```

## Compile manually
Expand Down
83 changes: 46 additions & 37 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 2022-07-21 12:35:26, from kubo 0.14.0
This document was autogenerated from CLI help text in [kubo 0.14.0](https://github.com/ipfs/kubo/releases/tag/v0.14.0)
::: tip Generated on 2022-08-30 14:41:04, from kubo 0.15.0
This document was autogenerated from CLI help text in [kubo 0.15.0](https://github.com/ipfs/kubo/releases/tag/v0.15.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 @@ -94,6 +94,7 @@ SUBCOMMANDS
ADVANCED COMMANDS
daemon Start a long-running daemon process
shutdown Shut down the daemon process
resolve Resolve any type of content path
name Publish and resolve IPNS names
key Create and list IPNS name keypairs
Expand Down Expand Up @@ -259,10 +260,16 @@ DESCRIPTION
QmerURi9k4XzKCaaPbsK6BL5pMEjF7PGphjDvkkjDtsVf3 868
QmQB28iwSriSUSMqG2nXDTLtdPHgWb4rebBrU7Q1j4vxPv 338
Finally, a note on hash determinism. While not guaranteed, adding the same
file/directory with the same flags will almost always result in the same output
hash. However, almost all of the flags provided by this command (other than pin,
only-hash, and progress/status related flags) will change the final hash.
Finally, a note on hash (CID) determinism and 'ipfs add' command.
Almost all the flags provided by this command will change the final CID, and
new flags may be added in the future. It is not guaranteed for the implicit
defaults of 'ipfs add' to remain the same in future Kubo releases, or for other
IPFS software to use the same import parameters as Kubo.
If you need to back up or transport content-addressed data using a non-IPFS
medium, CID can be preserved with CAR files.
See 'dag export' and 'dag import' for more information.
```
Expand Down Expand Up @@ -994,46 +1001,16 @@ SYNOPSIS
DESCRIPTION
Available profiles:
'local-discovery':
Sets default values to fields affected by the server
profile, enables discovery in local networks.
'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.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'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.
'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.
This profile may only be applied when first initializing the node.
'badgerds':
Configures the node to use the experimental badger datastore.
Expand All @@ -1054,6 +1031,36 @@ DESCRIPTION
This profile may only be applied when first initializing the node.
'randomports':
Use a random port number for swarm.
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'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.
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.
This profile may only be applied when first initializing the node.
SUBCOMMANDS
ipfs config profile apply <profile> - Apply profile to config.
Expand Down Expand Up @@ -1316,6 +1323,7 @@ DESCRIPTION
'ipfs dag export' fetches a DAG and streams it out as a well-formed .car file.
Note that at present only single root selections / .car files are supported.
The output of blocks happens in strict DAG-traversal, first-seen, order.
CAR file follows the CARv1 format: https://ipld.io/specs/transport/car/carv1/
```
Expand Down Expand Up @@ -1390,7 +1398,8 @@ DESCRIPTION
currently present in the blockstore does not represent a complete DAG,
pinning of that individual root will fail.
Maximum supported CAR version: 1
Maximum supported CAR version: 2
Specification of CAR formats: https://ipld.io/specs/transport/car/
```
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 2022-07-21, from kubo v0.14.0
This document was autogenerated from [v0.14.0](https://github.com/ipfs/kubo/releases/tag/v0.14.0).
::: tip Generated on 2022-08-30, from kubo v0.15.0
This document was autogenerated from [v0.15.0](https://github.com/ipfs/kubo/releases/tag/v0.15.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 @@ -6,7 +6,7 @@ require (
github.com/Stebalien/go-json-doc v0.0.2
github.com/ipfs/go-cid v0.2.0
github.com/ipfs/go-ipfs-cmds v0.8.1
github.com/ipfs/kubo v0.14.0
github.com/libp2p/go-libp2p-core v0.16.1
github.com/multiformats/go-multiaddr v0.5.0
github.com/ipfs/kubo v0.15.0
github.com/libp2p/go-libp2p-core v0.19.1
github.com/multiformats/go-multiaddr v0.6.0
)
Loading

0 comments on commit 7d5a69e

Please sign in to comment.