You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how-to/ipfs-updater.md
+62-55Lines changed: 62 additions & 55 deletions
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,20 @@
1
1
---
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.
4
4
current-ipfs-updater-version: v1.9.0
5
5
---
6
6
7
7
# ipfs-update
8
8
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).
12
10
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
+
:::
13
14
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
15
16
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).
16
18
17
19
:::: tabs
18
20
@@ -42,8 +44,6 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
42
44
43
45
```powershell
44
46
.\ipfs-update.exe --version
45
-
46
-
> ipfs-update version 1.9.0
47
47
```
48
48
49
49
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
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
91
81
92
82
```powershell
93
83
ipfs-update --version
94
-
95
-
> ipfs-update version 1.9.0
96
84
```
97
85
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
+
:::
101
89
102
90
103
91
:::
@@ -116,9 +104,6 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
116
104
117
105
```bash
118
106
tar -xvzf ipfs-update_v1.9.0_darwin-amd64.tar.gz
119
-
120
-
> x ipfs-update/install.sh
121
-
> x ipfs-update/ipfs-update
122
107
```
123
108
124
109
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
131
116
132
117
```bash
133
118
sudo bash install.sh
134
-
135
-
> installed /usr/local/bin/ipfs-update
136
119
```
137
120
138
121
4. Check that `ipfs-update` installed properly:
139
122
140
123
```bash
141
124
ipfs-update --version
142
-
143
-
> ipfs-update version 1.9.0
144
125
```
145
126
146
127
:::
@@ -159,9 +140,6 @@ You can download pre-built binaries from [`dist.ipfs.tech`](https://dist.ipfs.te
159
140
160
141
```bash
161
142
tar -xvzf ipfs-update_v1.9.0_linux-amd64.tar.gz
162
-
163
-
> x ipfs-update/install.sh
164
-
> x ipfs-update/ipfs-update
165
143
```
166
144
167
145
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
174
152
175
153
```bash
176
154
sudo bash install.sh
177
-
178
-
> installed /usr/local/bin/ipfs-update
179
155
```
180
156
181
157
4. Test that `ipfs-update` has installed correctly:
182
158
183
159
```bash
184
160
ipfs-update --version
185
-
186
-
> ipfs-update version 1.9.0
187
161
```
188
162
189
163
:::
190
164
191
165
::::
192
166
193
-
## Install IPFS
167
+
## Install Kubo
194
168
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.
196
170
197
-
- To install a specific Kubo `<version-number>`, run:
171
+
### Latest version
198
172
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
+
```
202
178
203
-
- To install the latest release of Kubo, use the `latest` tag:
179
+
### Specific version
180
+
To install a specific Kubo `<version-number>`, run:
204
181
205
-
```bash
206
-
ipfs-update install latest
207
-
```
182
+
```bash
183
+
ipfs-update install <version-number>
184
+
```
208
185
209
186
:::tip
210
187
When `ipfs-update install` is run and a version of IPFS is already installed, that version is _stashed_ and can be reverted to later.
211
188
:::
212
189
213
-
## Downgrade IPFS
190
+
## Roll-back Kubo version
214
191
215
192
Use the `revert` function to roll-back to a previous version of Kubo:
216
193
217
194
```bash
218
195
ipfs-update revert
219
196
```
220
197
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.
222
199
223
-
## Uninstall updater
200
+
## Uninstall ipfs-update
224
201
225
202
To uninstall IPFS Update, delete the binary and `ipfs-update` from your `PATH` variable.
226
203
204
+
:::: tabs
205
+
206
+
::: tab windows id="uninstall-ipfs-update-windows"
207
+
227
208
### Windows
228
209
229
210
1. Find the location of the `ipfs-update.exe` file:
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.
244
223
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).
Copy file name to clipboardExpand all lines: docs/install/command-line.md
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -401,4 +401,7 @@ For example, Brave RPC API runs on port 45001, so the CLI can talk to the Brave
401
401
402
402
## Next steps
403
403
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