Skip to content

Commit

Permalink
chore: kubo 0.33.1 (#1990)
Browse files Browse the repository at this point in the history
Co-authored-by: [email protected] <lidel>
  • Loading branch information
github-actions[bot] authored Feb 4, 2025
1 parent 5c87dc0 commit 6cb430e
Show file tree
Hide file tree
Showing 6 changed files with 82 additions and 80 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.33.0
current-ipfs-version: v0.33.1
---

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

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

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

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

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

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

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

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.33.0
> ipfs version 0.33.1
```

:::
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.33.0
> ipfs version 0.33.1
```
:::

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.33.0/kubo_v0.33.0_linux-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_linux-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.33.0_linux-amd64.tar.gz
tar -xvzf kubo_v0.33.1_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.33.0
> ipfs version 0.33.1
```

:::
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.33.0/kubo_v0.33.0_freebsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_freebsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.33.0_freebsd-amd64.tar.gz
tar -xvzf kubo_v0.33.1_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.33.0
> ipfs version 0.33.1
```

:::
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.33.0/kubo_v0.33.0_openbsd-amd64.tar.gz
wget https://dist.ipfs.tech/kubo/v0.33.1/kubo_v0.33.1_openbsd-amd64.tar.gz
```

1. Unzip the file:

```bash
tar -xvzf kubo_v0.33.0_openbsd-amd64.tar.gz
tar -xvzf kubo_v0.33.1_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.33.0
> ipfs version 0.33.1
```

:::
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.33.0/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.1/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.33.0
current-ipfs-version: v0.33.1
---

# 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.33.0
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.1
```

::: 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.33.0
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.1
```

## 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.33.0
ipfs/kubo:v0.33.1
```

## 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.33.0
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.1
```

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.33.0
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.1
```

## 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.33.0
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.1
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.33.0 key rotate -o old-self -t ed25519
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.33.1 key rotate -o old-self -t ed25519
docker start ipfs-test # will start with the new key
```
88 changes: 44 additions & 44 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 2025-01-29 23:45:27, from kubo 0.33.0
This document was autogenerated from CLI help text in [kubo 0.33.0](https://github.com/ipfs/kubo/releases/tag/v0.33.0)
::: tip Generated on 2025-02-04 22:02:31, from kubo 0.33.1
This document was autogenerated from CLI help text in [kubo 0.33.1](https://github.com/ipfs/kubo/releases/tag/v0.33.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 @@ -1038,13 +1038,13 @@ DESCRIPTION
Examples:
Get the value of the 'Datastore.Path' key:
Get the value of the 'Routing.Type' key:
$ ipfs config Datastore.Path
$ ipfs config Routing.Type
Set the value of the 'Datastore.Path' key:
Set the value of the 'Routing.Type' key:
$ ipfs config Datastore.Path ~/.ipfs/datastore
$ ipfs config Routing.Type auto
Set multiple values in the 'Addresses.AppendAnnounce' array:
Expand Down Expand Up @@ -1092,27 +1092,14 @@ SYNOPSIS
DESCRIPTION
Available profiles:
'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.
'announce-on':
Re-enables Reprovide system (reverts announce-off profile).
'legacy-cid-v0':
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
'randomports':
Use a random port number for swarm.
'test-cid-v1':
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'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.
'announce-on':
Re-enables Reprovide system (reverts announce-off profile).
'flatfs':
Configures the node to use the flatfs datastore.
Expand All @@ -1133,26 +1120,6 @@ DESCRIPTION
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile flatfs'
'lowpower':
Reduces daemon overhead on the system. May affect node
functionality - performance of content discovery and data
fetching may be degraded.
'announce-off':
Disables Reprovide system (and announcing to Amino DHT).
USE WITH CAUTION:
The main use case for this is setups with manual Peering.Peers config.
Data from this node will not be announced on the DHT. This will make
DHT-based routing and data retrieval impossible if this node is the only
one hosting it, and other peers are not already connected to it.
'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.
'pebbleds':
Configures the node to use the pebble high-performance datastore.
Expand All @@ -1172,6 +1139,37 @@ DESCRIPTION
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile pebbleds'
'randomports':
Use a random port number for swarm.
'announce-off':
Disables Reprovide system (and announcing to Amino DHT).
USE WITH CAUTION:
The main use case for this is setups with manual Peering.Peers config.
Data from this node will not be announced on the DHT. This will make
DHT-based routing and data retrieval impossible if this node is the only
one hosting it, and other peers are not already connected to it.
'legacy-cid-v0':
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
'server':
Disables local host discovery, recommended when
running IPFS on machines with public IPv4 addresses.
'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.
'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.
'badgerds':
Configures the node to use the legacy badgerv1 datastore.
Expand All @@ -1194,6 +1192,8 @@ DESCRIPTION
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
via 'ipfs init --profile badgerds'
'test-cid-v1':
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
SUBCOMMANDS
ipfs config profile apply <profile> - Apply profile to config.
Expand Down
6 changes: 4 additions & 2 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 2025-01-29, from kubo v0.33.0
This document was autogenerated from [v0.33.0](https://github.com/ipfs/kubo/releases/tag/v0.33.0).
::: tip Generated on 2025-02-04, from kubo v0.33.1
This document was autogenerated from [v0.33.1](https://github.com/ipfs/kubo/releases/tag/v0.33.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 @@ -3182,6 +3182,8 @@ On success, the call to this endpoint will return with 200 and the following bod
"AvgProvideDuration": "<duration-ns>",
"LastReprovideBatchSize": "<uint64>",
"LastReprovideDuration": "<duration-ns>",
"LastRun": "<timestamp>",
"ReprovideInterval": "<duration-ns>",
"TotalProvides": "<uint64>"
}

Expand Down
4 changes: 2 additions & 2 deletions tools/http-api-docs/go.mod
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.4.1
github.com/ipfs/go-ipfs-cmds v0.14.1
github.com/ipfs/kubo v0.33.0
github.com/ipfs/kubo v0.33.1
github.com/libp2p/go-libp2p v0.38.2
github.com/multiformats/go-multiaddr v0.14.0
)
Expand Down Expand Up @@ -79,7 +79,7 @@ require (
github.com/ipfs-shipyard/nopfs v0.0.14 // indirect
github.com/ipfs-shipyard/nopfs/ipfs v0.25.0 // indirect
github.com/ipfs/bbloom v0.0.4 // indirect
github.com/ipfs/boxo v0.27.2 // indirect
github.com/ipfs/boxo v0.27.4 // indirect
github.com/ipfs/go-bitfield v1.1.0 // indirect
github.com/ipfs/go-block-format v0.2.0 // indirect
github.com/ipfs/go-blockservice v0.5.2 // indirect
Expand Down
Loading

0 comments on commit 6cb430e

Please sign in to comment.