Skip to content

Commit

Permalink
Bumped documentation & installation docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
laurentsenta@users.noreply.github.com committed Jun 6, 2022
1 parent c08fedc commit 7b1e371
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 28 deletions.
20 changes: 10 additions & 10 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.10.2
current-ipfs-version: v0.12.2
---

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

## System requirements

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/cli/#ipfs-daemon) and adjust the [default maximum disk storage](https://github.com/ipfs/go-ipfs/blob/v0.10.2/docs/config.md#datastorestoragemax) for data retrieved from other peers.
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/cli/#ipfs-daemon) and adjust the [default maximum disk storage](https://github.com/ipfs/go-ipfs/blob/v0.12.2/docs/config.md#datastorestoragemax) for data retrieved from other peers.

## Official distributions

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

```powershell
cd ~\
wget https://dist.ipfs.io/go-ipfs/v0.10.2/go-ipfs_v0.10.2_windows-amd64.zip -Outfile go-ipfs_v0.10.2.zip
wget https://dist.ipfs.io/go-ipfs/v0.12.2/go-ipfs_v0.12.2_windows-amd64.zip -Outfile go-ipfs_v0.12.2.zip
```

1. Unzip the file and move it somewhere handy.

```powershell
Expand-Archive -Path go-ipfs_v0.10.2.zip -DestinationPath ~\Apps\go-ipfs_v0.10.2
Expand-Archive -Path go-ipfs_v0.12.2.zip -DestinationPath ~\Apps\go-ipfs_v0.12.2
```

1. Move into the `go-ipfs_v0.10.2` folder and check that the `ipfs.exe` works:
1. Move into the `go-ipfs_v0.12.2` folder and check that the `ipfs.exe` works:

```powershell
cd ~\Apps\go-ipfs_v0.10.2\go-ipfs
cd ~\Apps\go-ipfs_v0.12.2\go-ipfs
.\ipfs.exe --version
> ipfs version 0.12.0
Expand Down Expand Up @@ -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.io`](https://dist.ipfs.io/#go-ipfs).

```bash
curl -O https://dist.ipfs.io/go-ipfs/v0.10.2/go-ipfs_v0.10.2_darwin-amd64.tar.gz
curl -O https://dist.ipfs.io/go-ipfs/v0.12.2/go-ipfs_v0.12.2_darwin-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf go-ipfs_v0.10.2_darwin-amd64.tar.gz
tar -xvzf go-ipfs_v0.12.2_darwin-amd64.tar.gz
> x go-ipfs/install.sh
> x go-ipfs/ipfs
Expand Down Expand Up @@ -134,13 +134,13 @@ You can install IPFS on M1-based Macs by using the `darwin-arm64` binary instead
1. Download the Linux binary from [`dist.ipfs.io`](https://dist.ipfs.io/#go-ipfs).

```bash
wget https://dist.ipfs.io/go-ipfs/v0.10.2/go-ipfs_v0.10.2_linux-amd64.tar.gz
wget https://dist.ipfs.io/go-ipfs/v0.12.2/go-ipfs_v0.12.2_linux-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf go-ipfs_v0.10.2_linux-amd64.tar.gz
tar -xvzf go-ipfs_v0.12.2_linux-amd64.tar.gz
> x go-ipfs/install.sh
> x go-ipfs/ipfs
Expand Down
26 changes: 13 additions & 13 deletions docs/install/ipfs-updater.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: IPFS updater
description: The IPFS updater is a command-line tool originally used to help users update their IPFS version. Learn how to install, upgrade, and downgrade Go-IPFS using the IPFS updater.
current-ipfs-updater-version: v1.1.0-rc2
current-ipfs-updater-version: v1.8.0
---

# IPFS updater
Expand All @@ -18,19 +18,19 @@ You can download pre-built binaries from [`dist.ipfs.io`](https://dist.ipfs.io/#

```powershell
cd ~
wget https://dist.ipfs.io/ipfs-update/v1.1.0-rc2/ipfs-update_v1.1.0-rc2_windows-amd64.zip -Outfile ipfs-update_v1.1.0-rc2_windows-amd64.zip
wget https://dist.ipfs.io/ipfs-update/v1.8.0/ipfs-update_v1.8.0_windows-amd64.zip -Outfile ipfs-update_v1.8.0_windows-amd64.zip
```

2. Unzip the file and move it somewhere handy:

```powershell
Expand-Archive -Path ipfs-update_v1.1.0-rc2_windows-amd64.zip -DestinationPath ~\Apps\ipfs-update_v1.1.0-rc2
Expand-Archive -Path ipfs-update_v1.8.0_windows-amd64.zip -DestinationPath ~\Apps\ipfs-update_v1.8.0
```

3. Move into the `ipfs-update_v1.1.0-rc2` folder and check that the `ipfs-update.exe` works:
3. Move into the `ipfs-update_v1.8.0` folder and check that the `ipfs-update.exe` works:

```powershell
cd Apps\ipfs-update_v1.1.0-rc2\ipfs-update\
cd Apps\ipfs-update_v1.8.0\ipfs-update\
.\ipfs-update.exe --version
> ipfs-update version 1.8.0
Expand All @@ -45,7 +45,7 @@ You can download pre-built binaries from [`dist.ipfs.io`](https://dist.ipfs.io/#
> Path
> ----
> C:\Users\Johnny\Apps\ipfs-update_v1.1.0-rc2\ipfs-update
> C:\Users\Johnny\Apps\ipfs-update_v1.8.0\ipfs-update
```

5. Check if a profile file for PowerShell already exists:
Expand All @@ -71,7 +71,7 @@ You can download pre-built binaries from [`dist.ipfs.io`](https://dist.ipfs.io/#
7. Add the address you just copied to PowerShell's `PATH` by adding it to the end of the `Microsoft.PowerShell_profile.ps1` file stored in `Documents\WindowsPowerShell`:

```powershell
Add-Content C:\Users\Johnny\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 "[System.Environment]::SetEnvironmentVariable('PATH',`$Env:PATH+';;C:\Users\Johnny\Apps\ipfs-update_v1.1.0-rc2\ipfs-update')"
Add-Content C:\Users\Johnny\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 "[System.Environment]::SetEnvironmentVariable('PATH',`$Env:PATH+';;C:\Users\Johnny\Apps\ipfs-update_v1.8.0\ipfs-update')"
```

8. Close and reopen your PowerShell window. Test that your `PATH` is set correctly by going to your home folder and asking `ipfs-update` for the version:
Expand All @@ -90,13 +90,13 @@ You can download pre-built binaries from [`dist.ipfs.io`](https://dist.ipfs.io/#
1. Download the macOS binary from [`dist.ipfs.io`](https://dist.ipfs.io/#ipfs-update).

```bash
curl -O https://dist.ipfs.io/ipfs-update/v1.1.0-rc2/ipfs-update_v1.1.0-rc2_darwin-amd64.tar.gz
curl -O https://dist.ipfs.io/ipfs-update/v1.8.0/ipfs-update_v1.8.0_darwin-amd64.tar.gz
```

2. Unzip the file:

```bash
tar -xvzf ipfs-update_v1.1.0-rc2_darwin-amd64.tar.gz
tar -xvzf ipfs-update_v1.8.0_darwin-amd64.tar.gz
> x ipfs-update/install.sh
> x ipfs-update/ipfs-update
Expand Down Expand Up @@ -124,13 +124,13 @@ You can download pre-built binaries from [`dist.ipfs.io`](https://dist.ipfs.io/#
1. Download the Linux binary from [`dist.ipfs.io`](https://dist.ipfs.io/#ipfs-update).

```bash
wget https://dist.ipfs.io/ipfs-update/v1.1.0-rc2/ipfs-update_v1.1.0-rc2_linux-amd64.tar.gz
wget https://dist.ipfs.io/ipfs-update/v1.8.0/ipfs-update_v1.8.0_linux-amd64.tar.gz
```

2. Unzip the file:

```bash
tar -xvzf ipfs-update_v1.1.0-rc2_linux-amd64.tar.gz
tar -xvzf ipfs-update_v1.8.0_linux-amd64.tar.gz
> x ipfs-update/install.sh
> x ipfs-update/ipfs-update
Expand Down Expand Up @@ -190,13 +190,13 @@ To uninstall IPFS Update, delete the binary and `ipfs-update` from your `PATH` v
```powershell
gci -recurse -filter ipfs-update.exe -File -ErrorAction SilentlyContinue
> Directory: C:\Users\Johnny\Apps\ipfs-update_v1.1.0-rc2\ipfs-update
> Directory: C:\Users\Johnny\Apps\ipfs-update_v1.8.0\ipfs-update
```

2. Remove the `ipfs-update` directory:

```powershell
Remove-Item -Recurse -Force C:\Users\Johnny\Apps\ipfs-update_v1.1.0-rc2
Remove-Item -Recurse -Force C:\Users\Johnny\Apps\ipfs-update_v1.8.0
```

3. Delete the `ipfs-update` directory from the `PATH` variable. This process differs between Windows installations, so please check the [Microsoft documentation for details](https://docs.microsoft.com/en-us/cpp/build/setting-the-path-and-environment-variables-for-command-line-builds?view=msvc-160).
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
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: v0.9.1
current-ipfs-cluster-version: v1.0.1
---

# Server infrastructure
Expand Down Expand Up @@ -38,13 +38,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.io](https://dist.ipfs.io/#ipfs-cluster-ctl):

```shell
wget https://dist.ipfs.io/ipfs-cluster-ctl/v0.9.1/ipfs-cluster-ctl_v0.9.1_linux-amd64.tar.gz
wget https://dist.ipfs.io/ipfs-cluster-ctl/v1.0.1/ipfs-cluster-ctl_v1.0.1_linux-amd64.tar.gz
```

1. Unzip the package:

```shell
tar xvzf ipfs-cluster-ctl_v0.9.1_linux-amd64.tar.gz
tar xvzf ipfs-cluster-ctl_v1.0.1_linux-amd64.tar.gz
> ipfs-cluster-ctl/ipfs-cluster-ctl
> ipfs-cluster-ctl/LICENSE
Expand All @@ -53,10 +53,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/v0.9.1/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.1/docker-compose.yml) and place it into the `ipfs-cluster-ctl` directory:

```shell
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v0.9.1/docker-compose.yml
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.0.1/docker-compose.yml
```

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

0 comments on commit 7b1e371

Please sign in to comment.