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: README.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -168,15 +168,15 @@ From there:
168
168
- Open/extract the archive.
169
169
- Move kubo (`ipfs`) to your path (`install.sh` can do it for you).
170
170
171
-
If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download kubo (go-ipfs) from:
171
+
If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download kubo from:
172
172
- this project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page
173
173
-`/ipns/dist.ipfs.tech` at [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway
174
174
175
175
#### Updating
176
176
177
177
##### Downloading builds using IPFS
178
178
179
-
List the available versions of Kubo (go-ipfs) implementation:
179
+
List the available versions of Kubo implementation:
180
180
181
181
```console
182
182
$ ipfs cat /ipns/dist.ipfs.tech/kubo/versions
@@ -224,7 +224,7 @@ $ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_windows-amd64.zip
224
224
# pacman -S kubo
225
225
```
226
226
227
-
[](https://aur.archlinux.org/packages/kubo/)
227
+
[](https://archlinux.org/packages/kubo/)
With the purely functional package manager [Nix](https://nixos.org/nix/) you can install kubo (go-ipfs) like this:
241
+
With the purely functional package manager [Nix](https://nixos.org/nix/) you can install kubo like this:
242
242
243
243
```
244
244
$ nix-env -i kubo
@@ -258,11 +258,11 @@ You can also install it through the Solus software center.
258
258
259
259
#### openSUSE
260
260
261
-
[Community Package for go-ipfs](https://software.opensuse.org/package/go-ipfs)
261
+
[Community Package for kubo](https://software.opensuse.org/package/kubo)
262
262
263
263
#### Guix
264
264
265
-
[Community Package for go-ipfs](https://packages.guix.gnu.org/packages/go-ipfs/0.11.0/) is now out-of-date.
265
+
[Community Package for kubo](https://packages.guix.gnu.org/search/?query=kubo) is available.
266
266
267
267
#### Snap
268
268
@@ -323,7 +323,7 @@ PS> scoop install kubo
323
323
324
324
#### MacPorts
325
325
326
-
The package [ipfs](https://ports.macports.org/port/ipfs) currently points to kubo (go-ipfs) and is being maintained.
326
+
The package [ipfs](https://ports.macports.org/port/ipfs) currently points to kubo and is being maintained.
327
327
328
328
```
329
329
$ sudo port install ipfs
@@ -383,7 +383,7 @@ $ cd kubo
383
383
$ make install
384
384
```
385
385
386
-
Alternatively, you can run `make build` to build the go-ipfs binary (storing it in `cmd/ipfs/ipfs`) without installing it.
386
+
Alternatively, you can run `make build` to build the kubo binary (storing it in `cmd/ipfs/ipfs`) without installing it.
387
387
388
388
**NOTE:** If you get an error along the lines of "fatal error: stdlib.h: No such file or directory", you're missing a C compiler. Either re-run `make` with `CGO_ENABLED=0` or install GCC.
389
389
@@ -400,7 +400,7 @@ make build GOOS=myTargetOS GOARCH=myTargetArchitecture
400
400
- Separate [instructions are available for building on Windows](docs/windows.md).
401
401
-`git` is required in order for `go get` to fetch all dependencies.
402
402
- Package managers often contain out-of-date `golang` packages.
403
-
Ensure that `go version` reports at least 1.10. See above for how to install go.
403
+
Ensure that `go version` reports the minimum version required (see go.mod). See above for how to install go.
404
404
- If you are interested in development, please install the development
405
405
dependencies as well.
406
406
- Shell command completions can be generated with one of the `ipfs commands completion` subcommands. Read [docs/command-completion.md](docs/command-completion.md) to learn more.
@@ -418,6 +418,8 @@ system, this is done with `ipfs init`. See `ipfs init --help` for information on
418
418
the optional arguments it takes. After initialization is complete, you can use
419
419
`ipfs mount`, `ipfs add` and any of the other commands to explore!
420
420
421
+
For detailed configuration options, see [docs/config.md](https://github.com/ipfs/kubo/blob/master/docs/config.md).
422
+
421
423
### Some things to try
422
424
423
425
Basic proof of 'ipfs working' locally:
@@ -436,6 +438,8 @@ For programmatic interaction with Kubo, see our [list of HTTP/RPC clients](docs/
436
438
437
439
If you have previously installed IPFS before and you are running into problems getting a newer version to work, try deleting (or backing up somewhere else) your IPFS config directory (~/.ipfs by default) and rerunning `ipfs init`. This will reinitialize the config file to its defaults and clear out the local datastore of any bad entries.
438
440
441
+
For more information about configuration options, see [docs/config.md](https://github.com/ipfs/kubo/blob/master/docs/config.md).
442
+
439
443
Please direct general questions and help requests to our [forums](https://discuss.ipfs.tech).
440
444
441
445
If you believe you've found a bug, check the [issues list](https://github.com/ipfs/kubo/issues) and, if you don't see your problem there, either come talk to us on [Matrix chat](https://docs.ipfs.tech/community/chat/), or file an issue of your own!
0 commit comments