diff --git a/README.md b/README.md index f9953c3b7..ed1ffe904 100644 --- a/README.md +++ b/README.md @@ -168,7 +168,7 @@ From there: - Open/extract the archive. - Move kubo (`ipfs`) to your path (`install.sh` can do it for you). -If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download kubo (go-ipfs) from: +If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download kubo from: - this project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page - `/ipns/dist.ipfs.tech` at [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway @@ -176,7 +176,7 @@ If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you c ##### Downloading builds using IPFS -List the available versions of Kubo (go-ipfs) implementation: +List the available versions of Kubo implementation: ```console $ ipfs cat /ipns/dist.ipfs.tech/kubo/versions @@ -238,7 +238,7 @@ https://packages.gentoo.org/packages/net-p2p/kubo #### Nix -With the purely functional package manager [Nix](https://nixos.org/nix/) you can install kubo (go-ipfs) like this: +With the purely functional package manager [Nix](https://nixos.org/nix/) you can install kubo like this: ``` $ nix-env -i kubo @@ -258,11 +258,11 @@ You can also install it through the Solus software center. #### openSUSE -[Community Package for go-ipfs](https://software.opensuse.org/package/go-ipfs) +[Community Package for kubo](https://software.opensuse.org/package/kubo) #### Guix -[Community Package for go-ipfs](https://packages.guix.gnu.org/packages/go-ipfs/0.11.0/) is now out-of-date. +[Community Package for kubo](https://packages.guix.gnu.org/search/?query=kubo) is available. #### Snap @@ -323,7 +323,7 @@ PS> scoop install kubo #### MacPorts -The package [ipfs](https://ports.macports.org/port/ipfs) currently points to kubo (go-ipfs) and is being maintained. +The package [ipfs](https://ports.macports.org/port/ipfs) currently points to kubo and is being maintained. ``` $ sudo port install ipfs @@ -383,7 +383,7 @@ $ cd kubo $ make install ``` -Alternatively, you can run `make build` to build the go-ipfs binary (storing it in `cmd/ipfs/ipfs`) without installing it. +Alternatively, you can run `make build` to build the kubo binary (storing it in `cmd/ipfs/ipfs`) without installing it. **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. @@ -400,7 +400,7 @@ make build GOOS=myTargetOS GOARCH=myTargetArchitecture - Separate [instructions are available for building on Windows](docs/windows.md). - `git` is required in order for `go get` to fetch all dependencies. - Package managers often contain out-of-date `golang` packages. - Ensure that `go version` reports at least 1.10. See above for how to install go. + Ensure that `go version` reports the minimum version required (see go.mod). See above for how to install go. - If you are interested in development, please install the development dependencies as well. - 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 the optional arguments it takes. After initialization is complete, you can use `ipfs mount`, `ipfs add` and any of the other commands to explore! +For detailed configuration options, see [docs/config.md](https://github.com/ipfs/kubo/blob/master/docs/config.md). + ### Some things to try Basic proof of 'ipfs working' locally: @@ -436,6 +438,8 @@ For programmatic interaction with Kubo, see our [list of HTTP/RPC clients](docs/ 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. +For more information about configuration options, see [docs/config.md](https://github.com/ipfs/kubo/blob/master/docs/config.md). + Please direct general questions and help requests to our [forums](https://discuss.ipfs.tech). 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! diff --git a/docs/config.md b/docs/config.md index 64e555984..82046b5fa 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,6 +1,6 @@ # The Kubo config file -The Kubo (go-ipfs) config file is a JSON document located at `$IPFS_PATH/config`. It +The Kubo config file is a JSON document located at `$IPFS_PATH/config`. It is read once at node instantiation, either for an offline command, or when starting the daemon. Commands that execute on a running daemon do not read the config file at runtime.