Skip to content

Commit d6152c0

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

File tree

7 files changed

+391
-263
lines changed

7 files changed

+391
-263
lines changed

‎docs/how-to/websites-on-ipfs/deploy-github-action.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Deploy static apps to IPFS with GitHub Actions
33
description: Guide on how to setup GitHub Actions to deploy static sites/apps to IPFS using the IPFS Deploy Action.
4-
current-ipfs-version: v0.34.1
4+
current-ipfs-version: v0.35.0
55
current-ipfs-cluster-version: v1.1.4
66
---
77

@@ -170,7 +170,7 @@ You can also customize the Kubo version and [`ipfs add` parameters](https://docs
170170
uses: ipfs/ipfs-deploy-action@v1
171171
with:
172172
# ... other inputs ...
173-
kubo-version: 'v0.34.1' # Default, change if needed
173+
kubo-version: 'v0.35.0' # Default, change if needed
174174
ipfs-add-options: '--cid-version 1 --chunker size-1048576' # Default options
175175
```
176176

‎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.1
4+
current-ipfs-version: v0.35.0
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.1/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.35.0/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.1/kubo_v0.34.1_linux-amd64.tar.gz
72+
wget https://dist.ipfs.tech/kubo/v0.35.0/kubo_v0.35.0_linux-amd64.tar.gz
7373
```
7474

7575
1. Unzip the file:
7676

7777
```bash
78-
tar -xvzf kubo_v0.34.1_linux-amd64.tar.gz
78+
tar -xvzf kubo_v0.35.0_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.1
107+
> ipfs version 0.35.0
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.1/kubo_v0.34.1_windows-amd64.zip -Outfile kubo_v0.34.1.zip
119+
wget https://dist.ipfs.tech/kubo/v0.35.0/kubo_v0.35.0_windows-amd64.zip -Outfile kubo_v0.35.0.zip
120120
```
121121

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

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

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

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

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

136136
```powershell
137137
.\ipfs.exe --version
138138
139-
> ipfs version 0.34.1
139+
> ipfs version 0.35.0
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.1
185+
> ipfs version 0.35.0
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.1
213+
> ipfs version 0.35.0
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.1/kubo_v0.34.1_freebsd-amd64.tar.gz
224+
wget https://dist.ipfs.tech/kubo/v0.35.0/kubo_v0.35.0_freebsd-amd64.tar.gz
225225
```
226226

227227
1. Unzip the file:
228228

229229
```bash
230-
tar -xvzf kubo_v0.34.1_freebsd-amd64.tar.gz
230+
tar -xvzf kubo_v0.35.0_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.1
259+
> ipfs version 0.35.0
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.1/kubo_v0.34.1_openbsd-amd64.tar.gz
271+
wget https://dist.ipfs.tech/kubo/v0.35.0/kubo_v0.35.0_openbsd-amd64.tar.gz
272272
```
273273

274274
1. Unzip the file:
275275

276276
```bash
277-
tar -xvzf kubo_v0.34.1_openbsd-amd64.tar.gz
277+
tar -xvzf kubo_v0.35.0_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.1
306+
> ipfs version 0.35.0
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.1/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.35.0/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.1
4+
current-ipfs-version: v0.35.0
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.1
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.35.0
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.1
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.35.0
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.1
122+
ipfs/kubo:v0.35.0
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.1
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.35.0
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.1
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.35.0
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.1
146+
docker run -d --name ipfs-test -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.35.0
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.1 key rotate -o old-self -t ed25519
150+
docker run --rm -it -v /path/to/persisted/.ipfs:/data/ipfs ipfs/kubo:v0.35.0 key rotate -o old-self -t ed25519
151151
docker start ipfs-test # will start with the new key
152152
```

0 commit comments

Comments
 (0)