Skip to content

Commit 7e1d698

Browse files
github-actions[bot]github-actions[bot]
authored
Bumped documentation & installation docs. (#2011)
Co-authored-by: [email protected] <lidel>
1 parent e354e1b commit 7e1d698

File tree

6 files changed

+94
-94
lines changed

6 files changed

+94
-94
lines changed

‎docs/install/command-line.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Kubo
33
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.
4-
current-ipfs-version: v0.34.0
4+
current-ipfs-version: v0.34.1
55
---
66

77
# Install IPFS Kubo
@@ -34,7 +34,7 @@ Kubo runs on most Windows, MacOS, Linux, FreeBSD and OpenBSD systems that meet t
3434

3535
Note the following:
3636
- 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.
37-
- 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.34.0/docs/config.md#datastorestoragemax) for data retrieved from other peers.
37+
- 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.34.1/docs/config.md#datastorestoragemax) for data retrieved from other peers.
3838

3939

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

7171
```bash
72-
wget https://dist.ipfs.tech/kubo/v0.34.0/kubo_v0.34.0_linux-amd64.tar.gz
72+
wget https://dist.ipfs.tech/kubo/v0.34.1/kubo_v0.34.1_linux-amd64.tar.gz
7373
```
7474

7575
1. Unzip the file:
7676

7777
```bash
78-
tar -xvzf kubo_v0.34.0_linux-amd64.tar.gz
78+
tar -xvzf kubo_v0.34.1_linux-amd64.tar.gz
7979

8080
> x kubo/install.sh
8181
> x kubo/ipfs
@@ -104,7 +104,7 @@ For installation instructions for your operating system, select the appropriate
104104
```bash
105105
ipfs --version
106106

107-
> ipfs version 0.34.0
107+
> ipfs version 0.34.1
108108
```
109109

110110
:::
@@ -116,27 +116,27 @@ For installation instructions for your operating system, select the appropriate
116116
1. Download the Windows binary from [`dist.ipfs.tech`](https://dist.ipfs.tech/#kubo).
117117

118118
```powershell
119-
wget https://dist.ipfs.tech/kubo/v0.34.0/kubo_v0.34.0_windows-amd64.zip -Outfile kubo_v0.34.0.zip
119+
wget https://dist.ipfs.tech/kubo/v0.34.1/kubo_v0.34.1_windows-amd64.zip -Outfile kubo_v0.34.1.zip
120120
```
121121

122-
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.34.0`.
122+
1. Unzip the file to a sensible location, such as `~\Apps\kubo_v0.34.1`.
123123

124124
```powershell
125-
Expand-Archive -Path kubo_v0.34.0.zip -DestinationPath ~\Apps\kubo_v0.34.0
125+
Expand-Archive -Path kubo_v0.34.1.zip -DestinationPath ~\Apps\kubo_v0.34.1
126126
```
127127

128-
1. Move into the `kubo_v0.34.0` folder
128+
1. Move into the `kubo_v0.34.1` folder
129129

130130
```powershell
131-
cd ~\Apps\kubo_v0.34.0\kubo
131+
cd ~\Apps\kubo_v0.34.1\kubo
132132
```
133133

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

136136
```powershell
137137
.\ipfs.exe --version
138138
139-
> ipfs version 0.34.0
139+
> ipfs version 0.34.1
140140
```
141141

142142
At this point, Kubo is usable. However, it's strongly recommended that you first add `ipfs.exe` to your `PATH` using the following steps:
@@ -182,7 +182,7 @@ For installation instructions for your operating system, select the appropriate
182182
```powershell
183183
ipfs --version
184184
185-
> ipfs version 0.34.0
185+
> ipfs version 0.34.1
186186
```
187187

188188
:::
@@ -210,7 +210,7 @@ For installation instructions for your operating system, select the appropriate
210210
If Kubo is installed, the version number displays. For example:
211211

212212
```bash
213-
> ipfs version 0.34.0
213+
> ipfs version 0.34.1
214214
```
215215
:::
216216

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

223223
```bash
224-
wget https://dist.ipfs.tech/kubo/v0.34.0/kubo_v0.34.0_freebsd-amd64.tar.gz
224+
wget https://dist.ipfs.tech/kubo/v0.34.1/kubo_v0.34.1_freebsd-amd64.tar.gz
225225
```
226226

227227
1. Unzip the file:
228228

229229
```bash
230-
tar -xvzf kubo_v0.34.0_freebsd-amd64.tar.gz
230+
tar -xvzf kubo_v0.34.1_freebsd-amd64.tar.gz
231231

232232
> x kubo/install.sh
233233
> x kubo/ipfs
@@ -256,7 +256,7 @@ For installation instructions for your operating system, select the appropriate
256256
```bash
257257
ipfs --version
258258

259-
> ipfs version 0.34.0
259+
> ipfs version 0.34.1
260260
```
261261

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

270270
```bash
271-
wget https://dist.ipfs.tech/kubo/v0.34.0/kubo_v0.34.0_openbsd-amd64.tar.gz
271+
wget https://dist.ipfs.tech/kubo/v0.34.1/kubo_v0.34.1_openbsd-amd64.tar.gz
272272
```
273273

274274
1. Unzip the file:
275275

276276
```bash
277-
tar -xvzf kubo_v0.34.0_openbsd-amd64.tar.gz
277+
tar -xvzf kubo_v0.34.1_openbsd-amd64.tar.gz
278278

279279
> x kubo/install.sh
280280
> x kubo/ipfs
@@ -303,7 +303,7 @@ For installation instructions for your operating system, select the appropriate
303303
```bash
304304
ipfs --version
305305

306-
> ipfs version 0.34.0
306+
> ipfs version 0.34.1
307307
```
308308

309309
:::
@@ -315,7 +315,7 @@ For installation instructions for your operating system, select the appropriate
315315

316316
## Build Kubo from source
317317

318-
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.34.0/README.md#build-from-source) section in the Kubo repository.
318+
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.34.1/README.md#build-from-source) section in the Kubo repository.
319319

320320
## Determining which node to use with the command line
321321

‎docs/install/run-ipfs-inside-docker.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Install IPFS Kubo inside Docker
33
description: You can run IPFS inside Docker to simplify your deployment processes, and horizontally scale your IPFS infrastructure.
4-
current-ipfs-version: v0.34.0
4+
current-ipfs-version: v0.34.1
55
---
66

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

2323
```shell
24-
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.34.0
24+
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.34.1
2525
```
2626

2727
::: danger NEVER EXPOSE THE RPC API TO THE PUBLIC INTERNET
@@ -71,7 +71,7 @@ You can run Kubo IPFS inside Docker to simplify your deployment processes, as we
7171
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:
7272

7373
```shell
74-
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.34.0
74+
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.34.1
7575
```
7676

7777
## Customizing your node
@@ -119,22 +119,22 @@ Example:
119119
docker run # (....)
120120
--cpus="4.0" -e GOMAXPROCS=4 \
121121
--memory="8000m" -e GOMEMLIMIT=7500MiB \
122-
ipfs/kubo:v0.34.0
122+
ipfs/kubo:v0.34.1
123123
```
124124

125125
## Private swarms inside Docker
126126

127127
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`.
128128

129129
```shell
130-
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.34.0
130+
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.34.1
131131
```
132132

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

135135
```shell
136136
cat your_swarm.key | docker secret create swarm_key_secret -
137-
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.34.0
137+
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.34.1
138138
```
139139

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

144144
```shell
145145
# given container named 'ipfs-test' that persists repo at /path/to/persisted/.ipfs
146-
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.34.0
146+
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.34.1
147147
docker stop ipfs-test
148148
149149
# key rotation works like this (old key saved under 'old-self')
150-
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.34.0 key rotate -o old-self -t ed25519
150+
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.34.1 key rotate -o old-self -t ed25519
151151
docker start ipfs-test # will start with the new key
152152
```

‎docs/reference/kubo/cli.md‎

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ description: API documentation for the Kubo command-line executable.
55

66
# Kubo command-line
77

8-
::: tip Generated on 2025-03-20 22:58:28, from kubo 0.34.0
9-
This document was autogenerated from CLI help text in [kubo 0.34.0](https://github.com/ipfs/kubo/releases/tag/v0.34.0)
8+
::: tip Generated on 2025-03-25 22:49:15, from kubo 0.34.1
9+
This document was autogenerated from CLI help text in [kubo 0.34.1](https://github.com/ipfs/kubo/releases/tag/v0.34.1)
1010
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.
1111
:::
1212

@@ -1102,13 +1102,57 @@ DESCRIPTION
11021102
'local-discovery':
11031103
Sets default values to fields affected by the server
11041104
profile, enables discovery in local networks.
1105+
'test':
1106+
Reduces external interference of IPFS daemon, this
1107+
is useful when using the daemon in test environments.
1108+
'default-networking':
1109+
Restores default network settings.
1110+
Inverse profile of the test profile.
11051111
'default-datastore':
11061112
Configures the node to use the default datastore (flatfs).
11071113
11081114
Read the "flatfs" profile description for more information on this datastore.
11091115
11101116
This profile may only be applied when first initializing the node.
11111117
1118+
'pebbleds':
1119+
Configures the node to use the pebble high-performance datastore.
1120+
1121+
Pebble is a LevelDB/RocksDB inspired key-value store focused on performance
1122+
and internal usage by CockroachDB.
1123+
You should use this datastore if:
1124+
1125+
- You need a datastore that is focused on performance.
1126+
- You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
1127+
- This datastore is good for multi-terabyte data sets.
1128+
- May benefit from tuning depending on read/write patterns and throughput.
1129+
- Performance is helped significantly by running on a system with plenty of memory.
1130+
1131+
See configuration documentation at:
1132+
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#pebbleds
1133+
1134+
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
1135+
via 'ipfs init --profile pebbleds'
1136+
1137+
'lowpower':
1138+
Reduces daemon overhead on the system. May affect node
1139+
functionality - performance of content discovery and data
1140+
fetching may be degraded.
1141+
1142+
'announce-off':
1143+
Disables Reprovide system (and announcing to Amino DHT).
1144+
1145+
USE WITH CAUTION:
1146+
The main use case for this is setups with manual Peering.Peers config.
1147+
Data from this node will not be announced on the DHT. This will make
1148+
DHT-based routing and data retrieval impossible if this node is the only
1149+
one hosting it, and other peers are not already connected to it.
1150+
1151+
'announce-on':
1152+
Re-enables Reprovide system (reverts announce-off profile).
1153+
'server':
1154+
Disables local host discovery, recommended when
1155+
running IPFS on machines with public IPv4 addresses.
11121156
'flatfs':
11131157
Configures the node to use the flatfs datastore.
11141158
@@ -1129,25 +1173,6 @@ DESCRIPTION
11291173
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
11301174
via 'ipfs init --profile flatfs'
11311175
1132-
'pebbleds':
1133-
Configures the node to use the pebble high-performance datastore.
1134-
1135-
Pebble is a LevelDB/RocksDB inspired key-value store focused on performance
1136-
and internal usage by CockroachDB.
1137-
You should use this datastore if:
1138-
1139-
- You need a datastore that is focused on performance.
1140-
- You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
1141-
- This datastore is good for multi-terabyte data sets.
1142-
- May benefit from tuning depending on read/write patterns and throughput.
1143-
- Performance is helped significantly by running on a system with plenty of memory.
1144-
1145-
See configuration documentation at:
1146-
https://github.com/ipfs/kubo/blob/master/docs/datastores.md#pebbleds
1147-
1148-
NOTE: This profile may only be applied when first initializing node at IPFS_PATH
1149-
via 'ipfs init --profile pebbleds'
1150-
11511176
'badgerds':
11521177
Configures the node to use the legacy badgerv1 datastore.
11531178
@@ -1174,33 +1199,8 @@ DESCRIPTION
11741199
Use a random port number for swarm.
11751200
'legacy-cid-v0':
11761201
Makes UnixFS import produce legacy CIDv0 with no raw leaves, sha2-256 and 256 KiB chunks.
1177-
'test':
1178-
Reduces external interference of IPFS daemon, this
1179-
is useful when using the daemon in test environments.
1180-
'default-networking':
1181-
Restores default network settings.
1182-
Inverse profile of the test profile.
1183-
'lowpower':
1184-
Reduces daemon overhead on the system. May affect node
1185-
functionality - performance of content discovery and data
1186-
fetching may be degraded.
1187-
1188-
'announce-off':
1189-
Disables Reprovide system (and announcing to Amino DHT).
1190-
1191-
USE WITH CAUTION:
1192-
The main use case for this is setups with manual Peering.Peers config.
1193-
Data from this node will not be announced on the DHT. This will make
1194-
DHT-based routing and data retrieval impossible if this node is the only
1195-
one hosting it, and other peers are not already connected to it.
1196-
1197-
'announce-on':
1198-
Re-enables Reprovide system (reverts announce-off profile).
11991202
'test-cid-v1':
12001203
Makes UnixFS import produce modern CIDv1 with raw leaves, sha2-256 and 1 MiB chunks.
1201-
'server':
1202-
Disables local host discovery, recommended when
1203-
running IPFS on machines with public IPv4 addresses.
12041204
12051205
SUBCOMMANDS
12061206
ipfs config profile apply <profile> - Apply profile to config.

‎docs/reference/kubo/rpc.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ I AM SERIOUS, DO NOT EDIT ANYTHING BELOW ;-D
4747
4848
-->
4949

50-
::: tip Generated on 2025-03-20, from kubo v0.34.0
51-
This document was autogenerated from [v0.34.0](https://github.com/ipfs/kubo/releases/tag/v0.34.0).
50+
::: tip Generated on 2025-03-25, from kubo v0.34.1
51+
This document was autogenerated from [v0.34.1](https://github.com/ipfs/kubo/releases/tag/v0.34.1).
5252
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.
5353
:::
5454

0 commit comments

Comments
 (0)