Skip to content

Commit

Permalink
chore: bump versions in installation docs (#1958)
Browse files Browse the repository at this point in the history
Co-authored-by: [email protected] <lidel>
  • Loading branch information
github-actions[bot] authored Jan 30, 2025
1 parent 2e06774 commit d57b24a
Show file tree
Hide file tree
Showing 7 changed files with 237 additions and 218 deletions.
40 changes: 20 additions & 20 deletions docs/install/command-line.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Kubo
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.
current-ipfs-version: v0.32.1
current-ipfs-version: v0.33.0
---

# Install IPFS Kubo
Expand Down Expand Up @@ -31,7 +31,7 @@ Kubo runs on most Windows, MacOS, Linux, FreeBSD and OpenBSD systems that meet t

Note the following:
- 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.
- 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.32.1/docs/config.md#datastorestoragemax) for data retrieved from other peers.
- 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.33.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.


<!-- TODO: hide this footgun until https://github.com/ipfs/kubo/pull/10524 is merged and released in stable kubo
Expand Down Expand Up @@ -76,27 +76,27 @@ For installation instructions for your operating system, select the appropriate
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).

```powershell
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_windows-amd64.zip -Outfile kubo_v0.32.1.zip
wget https://dist.ipfs.tech/kubo/v0.33.0/kubo_v0.33.0_windows-amd64.zip -Outfile kubo_v0.33.0.zip
```

1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.32.1`.
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.33.0`.

```powershell
Expand-Archive -Path kubo_v0.32.1.zip -DestinationPath ~\Apps\kubo_v0.32.1
Expand-Archive -Path kubo_v0.33.0.zip -DestinationPath ~\Apps\kubo_v0.33.0
```

1. Move into the `kubo_v0.32.1` folder
1. Move into the `kubo_v0.33.0` folder

```powershell
cd ~\Apps\kubo_v0.32.1\kubo
cd ~\Apps\kubo_v0.33.0\kubo
```

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

```powershell
.\ipfs.exe --version
> ipfs version 0.32.1
> ipfs version 0.33.0
```

At this point, Kubo is usable. However, it's strongly recommended that you first add `ipfs.exe` to your `PATH` using the following steps:
Expand Down Expand Up @@ -142,7 +142,7 @@ For installation instructions for your operating system, select the appropriate
```powershell
ipfs --version
> ipfs version 0.32.1
> ipfs version 0.33.0
```

:::
Expand Down Expand Up @@ -170,7 +170,7 @@ For installation instructions for your operating system, select the appropriate
If Kubo is installed, the version number displays. For example:

```bash
> ipfs version 0.32.1
> ipfs version 0.33.0
```
:::

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

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

1. Unzip the file:

```bash
tar -xvzf kubo_v0.32.1_linux-amd64.tar.gz
tar -xvzf kubo_v0.33.0_linux-amd64.tar.gz

> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -216,7 +216,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version

> ipfs version 0.32.1
> ipfs version 0.33.0
```

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

```bash
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_freebsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.33.0/kubo_v0.33.0_freebsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.32.1_freebsd-amd64.tar.gz
tar -xvzf kubo_v0.33.0_freebsd-amd64.tar.gz

> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -263,7 +263,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version

> ipfs version 0.32.1
> ipfs version 0.33.0
```

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

```bash
wget https://dist.ipfs.tech/kubo/v0.32.1/kubo_v0.32.1_openbsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.33.0/kubo_v0.33.0_openbsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.32.1_openbsd-amd64.tar.gz
tar -xvzf kubo_v0.33.0_openbsd-amd64.tar.gz

> x kubo/install.sh
> x kubo/ipfs
Expand Down Expand Up @@ -310,7 +310,7 @@ For installation instructions for your operating system, select the appropriate
```bash
ipfs --version

> ipfs version 0.32.1
> ipfs version 0.33.0
```

:::
Expand All @@ -322,7 +322,7 @@ For installation instructions for your operating system, select the appropriate

## Build Kubo from source

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.32.1/README.md#build-from-source) section in the Kubo repository.
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.33.0/README.md#build-from-source) section in the Kubo repository.

## Determining which node to use with the command line

Expand Down
16 changes: 8 additions & 8 deletions docs/install/run-ipfs-inside-docker.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Install IPFS Kubo inside Docker
description: You can run IPFS inside Docker to simplify your deployment processes, and horizontally scale your IPFS infrastructure.
current-ipfs-version: v0.32.1
current-ipfs-version: v0.33.0
---

# Install IPFS Kubo inside Docker
Expand All @@ -21,7 +21,7 @@ You can run Kubo IPFS inside Docker to simplify your deployment processes, as we
1. Start a container running ipfs and expose ports `4001` (P2P TCP/QUIC transports), `5001` (RPC API) and `8080` (Gateway):

```shell
docker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.32.1
docker run -d --name ipfs_host -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
```

::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET
Expand Down Expand Up @@ -71,7 +71,7 @@ You can run Kubo IPFS inside Docker to simplify your deployment processes, as we
When starting a container running ipfs for the first time with an empty data directory, it will call `ipfs init` to initialize configuration files and generate a new keypair. At this time, you can choose which profile to apply using the `IPFS_PROFILE` environment variable:

```shell
docker run -d --name ipfs_host -e IPFS_PROFILE=server -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.32.1
docker run -d --name ipfs_host -e IPFS_PROFILE=server -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
```

## Customizing your node
Expand Down Expand Up @@ -119,22 +119,22 @@ Example:
docker run # (....)
--cpus="4.0" -e GOMAXPROCS=4 \
--memory="8000m" -e GOMEMLIMIT=7500MiB \
ipfs/kubo:v0.32.1
ipfs/kubo:v0.33.0
```

## Private swarms inside Docker

It is possible to initialize the container with a swarm key file (`/data/ipfs/swarm.key`) using the variables `IPFS_SWARM_KEY` and `IPFS_SWARM_KEY_FILE`. The `IPFS_SWARM_KEY` creates `swarm.key` with the contents of the variable itself, while `IPFS_SWARM_KEY_FILE` copies the key from a path stored in the variable. The `IPFS_SWARM_KEY_FILE` **overwrites** the key generated by `IPFS_SWARM_KEY`.

```shell
docker run -d --name ipfs_host -e IPFS_SWARM_KEY=<your swarm key> -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.32.1
docker run -d --name ipfs_host -e IPFS_SWARM_KEY=<your swarm key> -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
```

The swarm key initialization can also be done using docker secrets, and requires `docker swarm` or `docker-compose`:

```shell
cat your_swarm.key | docker secret create swarm_key_secret -
docker run -d --name ipfs_host --secret swarm_key_secret -e IPFS_SWARM_KEY_FILE=/run/secrets/swarm_key_secret -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.32.1
docker run -d --name ipfs_host --secret swarm_key_secret -e IPFS_SWARM_KEY_FILE=/run/secrets/swarm_key_secret -v $ipfs_staging:/export -v $ipfs_data:/data/ipfs -p 4001:4001 -p 4001:4001/udp -p 127.0.0.1:8080:8080 -p 127.0.0.1:5001:5001 ipfs/kubo:v0.33.0
```

## Key rotation inside Docker
Expand All @@ -143,10 +143,10 @@ It is possible to do key rotation in an ephemeral container that is temporarily

```shell
# given container named 'ipfs-test' that persists repo at /path/to/persisted/.ipfs
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.32.1
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.0
docker stop ipfs-test
# key rotation works like this (old key saved under 'old-self')
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.32.1 key rotate -o old-self -t ed25519
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.0 key rotate -o old-self -t ed25519
docker start ipfs-test # will start with the new key
```
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: 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.1.1
current-ipfs-cluster-version: v1.1.2
---

# Set up server infrastructure with IPFS Cluster
Expand Down Expand Up @@ -73,13 +73,13 @@ If you're having issues installing or using Docker or Docker-Compose, see the [o
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.1.1/ipfs-cluster-ctl_v1.1.1_linux-amd64.tar.gz
wget https://dist.ipfs.tech/ipfs-cluster-ctl/v1.1.2/ipfs-cluster-ctl_v1.1.2_linux-amd64.tar.gz
```

1. Unzip the package:

```shell
tar xvzf ipfs-cluster-ctl_v1.1.1_linux-amd64.tar.gz
tar xvzf ipfs-cluster-ctl_v1.1.2_linux-amd64.tar.gz
> ipfs-cluster-ctl/ipfs-cluster-ctl
> ipfs-cluster-ctl/LICENSE
Expand All @@ -88,10 +88,10 @@ If you're having issues installing or using Docker or Docker-Compose, see the [o
> ipfs-cluster-ctl/README.md
```

1. Download the [`docker-compose.yml` file](https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.1.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.1.2/docker-compose.yml) and place it into the `ipfs-cluster-ctl` directory:

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

1. Start the cluster using `docker-compose`:
Expand Down
Loading

0 comments on commit d57b24a

Please sign in to comment.