Skip to content

Commit ce37e6b

Browse files
authored
Update ipfs-update content (#1555)
1 parent 9bd924a commit ce37e6b

File tree

3 files changed

+67
-57
lines changed

3 files changed

+67
-57
lines changed

docs/.vuepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ module.exports = {
190190
'/how-to/modify-bootstrap-list',
191191
'/how-to/nat-configuration',
192192
'/how-to/default-profile',
193-
['/how-to/ipfs-updater', 'Update Kubo using ipfs-update'],
193+
'/how-to/ipfs-updater',
194194
[
195195
'https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/custom-ipfs-repo',
196196
'Customize an IPFS repo'

docs/how-to/ipfs-updater.md

Lines changed: 62 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
---
2-
title: IPFS updater
3-
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 Kubo using the IPFS updater.
2+
title: Using ipfs-update
3+
description: This page provides installation and usage guidance for ipfs-update, a command-line utility that can be used to install, uninstall, dowgrade and upgrade IPFS Kubo.
44
current-ipfs-updater-version: v1.9.0
55
---
66

77
# ipfs-update
88

9-
The ipfs-update tool is a command-line utility that can be used to install and update Kubo. The easiest way to install ipfs-update is by using the pre-built binaries, detailed below. See the [project repository](https://github.com/ipfs/ipfs-update#from-source) if you'd prefer to build it from source.
10-
11-
## Install ipfs-update
9+
The ipfs-update tool is a command-line utility that can be used to install, uninstall, downgrade and upgrade IPFS [Kubo](../install/command-line.md).
1210

11+
:::callout
12+
See the [project repository](https://github.com/ipfs/ipfs-update#from-source) if you'd prefer to build ipfs-update from source.
13+
:::
1314

14-
You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.tech/#ipfs-update). Binaries are also available from the [IPFS Update GitHub release page](https://github.com/ipfs/ipfs-update/releases).
15+
## Install ipfs-update
1516

17+
The ipfs-update tool can be downloaded using pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.tech/#ipfs-update). Binaries are also available from the [IPFS Update GitHub release page](https://github.com/ipfs/ipfs-update/releases).
1618

1719
:::: tabs
1820

@@ -42,8 +44,6 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
4244

4345
```powershell
4446
.\ipfs-update.exe --version
45-
46-
> ipfs-update version 1.9.0
4747
```
4848

4949
At this point, ipfs-update is usable. However, it's strongly recommended that you first add `ipfs-update.exe` to your `PATH` using the following steps:
@@ -52,18 +52,12 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
5252

5353
```powershell
5454
pwd
55-
56-
> Path
57-
> ----
58-
> C:\Users\<username>\Apps\ipfs-update_v1.9.0\ipfs-update
5955
```
6056

6157
1. Check if a profile file for PowerShell already exists:
6258

6359
```powershell
6460
Test-Path $profile
65-
66-
> false
6761
```
6862

6963
If a profile already file exists, skip the next step and proceed to step 8.
@@ -72,10 +66,6 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
7266

7367
```powershell
7468
New-Item -path $profile -type file –force
75-
76-
> Mode LastWriteTime Length Name
77-
> ---- ------------- ------ ----
78-
> -a---- 11/5/2020 6:38 PM 0 Microsoft.PowerShell_profile.ps1
7969
```
8070

8171
1. Add the address copied in step 5 to PowerShell's `PATH` by adding it to the end of the `Microsoft.PowerShell_profile.ps1` file stored in `Documents\WindowsPowerShell`:
@@ -91,13 +81,11 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
9181

9282
```powershell
9383
ipfs-update --version
94-
95-
> ipfs-update version 1.9.0
9684
```
9785

98-
:::tip
99-
If an error occurs on the next startup of PowerShell while loading the profile file, change the PowerShell `ExecutionPolicy` to `Unrestricted`, as described in the [Microsoft PowerShell documentation](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7).
100-
:::
86+
:::tip
87+
If an error occurs on the next startup of PowerShell while loading the profile file, change the PowerShell `ExecutionPolicy` to `Unrestricted`, as described in the [Microsoft PowerShell documentation](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7).
88+
:::
10189

10290

10391
:::
@@ -116,9 +104,6 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
116104

117105
```bash
118106
tar -xvzf ipfs-update_v1.9.0_darwin-amd64.tar.gz
119-
120-
> x ipfs-update/install.sh
121-
> x ipfs-update/ipfs-update
122107
```
123108

124109
1. Move into the `ipfs-update` folder
@@ -131,16 +116,12 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
131116

132117
```bash
133118
sudo bash install.sh
134-
135-
> installed /usr/local/bin/ipfs-update
136119
```
137120

138121
4. Check that `ipfs-update` installed properly:
139122

140123
```bash
141124
ipfs-update --version
142-
143-
> ipfs-update version 1.9.0
144125
```
145126

146127
:::
@@ -159,9 +140,6 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
159140

160141
```bash
161142
tar -xvzf ipfs-update_v1.9.0_linux-amd64.tar.gz
162-
163-
> x ipfs-update/install.sh
164-
> x ipfs-update/ipfs-update
165143
```
166144

167145
1. Move into the `ipfs-update` folder:
@@ -174,64 +152,65 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
174152

175153
```bash
176154
sudo bash install.sh
177-
178-
> installed /usr/local/bin/ipfs-update
179155
```
180156

181157
4. Test that `ipfs-update` has installed correctly:
182158

183159
```bash
184160
ipfs-update --version
185-
186-
> ipfs-update version 1.9.0
187161
```
188162

189163
:::
190164

191165
::::
192166

193-
## Install IPFS
167+
## Install Kubo
194168

195-
The ipfs-update tool can be used to install Kubo.
169+
The ipfs-update tool can be used to install Kubo. You can install the latest version, or specify a specific version.
196170

197-
- To install a specific Kubo `<version-number>`, run:
171+
### Latest version
198172

199-
```bash
200-
ipfs-update install <version-number>
201-
```
173+
To install the latest release of Kubo, use the `latest` tag:
174+
175+
```bash
176+
ipfs-update install latest
177+
```
202178

203-
- To install the latest release of Kubo, use the `latest` tag:
179+
### Specific version
180+
To install a specific Kubo `<version-number>`, run:
204181

205-
```bash
206-
ipfs-update install latest
207-
```
182+
```bash
183+
ipfs-update install <version-number>
184+
```
208185

209186
:::tip
210187
When `ipfs-update install` is run and a version of IPFS is already installed, that version is _stashed_ and can be reverted to later.
211188
:::
212189

213-
## Downgrade IPFS
190+
## Roll-back Kubo version
214191

215192
Use the `revert` function to roll-back to a previous version of Kubo:
216193

217194
```bash
218195
ipfs-update revert
219196
```
220197

221-
`ipfs-update revert` reverts to the previously installed version of Kubo. This is useful if the newly installed version has issues and you would like to switch back to your older stable installation.
198+
The `revert` function is useful if a newly installed version needs to be reverted to a more stable version, or you want to test or use older versions of Kubo.
222199

223-
## Uninstall updater
200+
## Uninstall ipfs-update
224201

225202
To uninstall IPFS Update, delete the binary and `ipfs-update` from your `PATH` variable.
226203

204+
:::: tabs
205+
206+
::: tab windows id="uninstall-ipfs-update-windows"
207+
227208
### Windows
228209

229210
1. Find the location of the `ipfs-update.exe` file:
230211

231212
```powershell
232213
gci -recurse -filter ipfs-update.exe -File -ErrorAction SilentlyContinue
233-
234-
> Directory: C:\Users\<username>\Apps\ipfs-update_v1.9.0\ipfs-update
235214
```
236215

237216
2. Remove the `ipfs-update` directory:
@@ -240,20 +219,48 @@ To uninstall IPFS Update, delete the binary and `ipfs-update` from your `PATH` v
240219
Remove-Item -Recurse -Force C:\Users\<username>\Apps\ipfs-update_v1.9.0
241220
```
242221

243-
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).
222+
3. Delete the `ipfs-update` directory from the `PATH` variable.
244223

245-
### Linux & macOS
224+
:::tip
225+
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).
226+
:::
227+
228+
:::
229+
230+
::: tab macOS id="uninstall-ipfs-update-macos"
231+
232+
### MacOS
246233

247234
1. Find the location of the `ipfs-update` file:
248235

249236
```bash
250237
sudo find / -name ipfs-update
238+
```
239+
240+
2. Remove the file:
251241

252-
/usr/local/bin/ipfs-update
242+
```bash
243+
sudo rm /usr/local/bin/ipfs-update
244+
```
245+
246+
:::
247+
248+
::: tab linux id="uninstall-ipfs-update-linux"
249+
250+
### Linux
251+
252+
1. Find the location of the `ipfs-update` file:
253+
254+
```bash
255+
sudo find / -name ipfs-update
253256
```
254257

255258
2. Remove the file:
256259

257260
```bash
258261
sudo rm /usr/local/bin/ipfs-update
259262
```
263+
264+
:::
265+
266+
::::

docs/install/command-line.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,4 +401,7 @@ For example, Brave RPC API runs on port 45001, so the CLI can talk to the Brave
401401
402402
## Next steps
403403
404-
Now that you've installed IPFS Kubo, check out the [IPFS Kubo Tutorial in Guides](../how-to/command-line-quick-start.md), which will guide you through taking a Kubo node online and interacting with the network.
404+
Now that you've installed IPFS Kubo:
405+
406+
- Check out the [IPFS Kubo Tutorial in Guides](../how-to/command-line-quick-start.md), which will guide you through taking a Kubo node online and interacting with the network.
407+
- Learn how to quickly install, uninstall, upgrade and downgrade Kubo using [ipfs-update](../how-to/ipfs-updater.md).

0 commit comments

Comments
 (0)