diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 173d349f2f..1956e4ec0d 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -7,6 +7,7 @@ The js-ipfs config file is a JSON document located in the root directory of the - [Profiles](#profiles) - [`Addresses`](#addresses) - [`API`](#api) + - [`RPC`](#rpc) - [`Delegates`](#delegates) - [`Gateway`](#gateway) - [`Swarm`](#swarm) @@ -85,6 +86,14 @@ The IPFS daemon exposes an HTTP API that allows to control the node and run the Default: `/ip4/127.0.0.1/tcp/5002` +### `RPC` + +js-IPFS has a gRPC-over-websockets server that allows it to do things that you cannot do over HTTP like bi-directional streaming. It implements the same API as the [HTTP API Spec](https://docs.ipfs.io/reference/api/http) and can be accessed using the [ipfs-client](https://www.npmjs.com/package/ipfs-client) module. + +Configure the address it listens on using this config key. + +Default: `/ip4/127.0.0.1/tcp/5003` + ### `Delegates` Delegate peers are used to find peers and retrieve content from the network on your behalf.