Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
docs: add rpc addr docs (#3809)
Browse files Browse the repository at this point in the history
Documents RPC config key
  • Loading branch information
achingbrain committed Aug 12, 2021
1 parent 7a920d8 commit 4a8de24
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/CONFIG.md
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 4a8de24

Please sign in to comment.