Skip to content

Commit

Permalink
Bumped documentation & installation docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Oct 4, 2022
1 parent fef4b76 commit e39d1ba
Show file tree
Hide file tree
Showing 6 changed files with 228 additions and 157 deletions.
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.15.0
current-ipfs-version: v0.16.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.15.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.16.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.15.0/kubo_v0.15.0_windows-amd64.zip -Outfile kubo_v0.15.0.zip
wget https://dist.ipfs.tech/kubo/v0.16.0/kubo_v0.16.0_windows-amd64.zip -Outfile kubo_v0.16.0.zip
```

1. Unzip the file and move it somewhere handy.

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

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

```powershell
cd ~\Apps\kubo_v0.15.0\kubo
cd ~\Apps\kubo_v0.16.0\kubo
.\ipfs.exe --version
> ipfs version 0.15.0
> ipfs version 0.16.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.15.0
> ipfs version 0.16.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.15.0/kubo_v0.15.0_darwin-amd64.tar.gz
curl -O https://dist.ipfs.tech/kubo/v0.16.0/kubo_v0.16.0_darwin-amd64.tar.gz
```

1. Unzip the file:

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

### Linux

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

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

1. Unzip the file:

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

## 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.3
current-ipfs-cluster-version: v1.0.4
---

# 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.3/ipfs-cluster-ctl_v1.0.3_linux-amd64.tar.gz
wget https://dist.ipfs.tech/ipfs-cluster-ctl/v1.0.4/ipfs-cluster-ctl_v1.0.4_linux-amd64.tar.gz
```

1. Unzip the package:

```shell
tar xvzf ipfs-cluster-ctl_v1.0.3_linux-amd64.tar.gz
tar xvzf ipfs-cluster-ctl_v1.0.4_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.3/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.4/docker-compose.yml) and place it into the `ipfs-cluster-ctl` directory:

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

1. Start the cluster using `docker-compose`. You may have to run as root:
Expand Down
Loading

0 comments on commit e39d1ba

Please sign in to comment.