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

Commit 4a8de24

Browse files
authoredAug 12, 2021
docs: add rpc addr docs (#3809)
Documents RPC config key
1 parent 7a920d8 commit 4a8de24

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed
 

‎docs/CONFIG.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ The js-ipfs config file is a JSON document located in the root directory of the
77
- [Profiles](#profiles)
88
- [`Addresses`](#addresses)
99
- [`API`](#api)
10+
- [`RPC`](#rpc)
1011
- [`Delegates`](#delegates)
1112
- [`Gateway`](#gateway)
1213
- [`Swarm`](#swarm)
@@ -85,6 +86,14 @@ The IPFS daemon exposes an HTTP API that allows to control the node and run the
8586

8687
Default: `/ip4/127.0.0.1/tcp/5002`
8788

89+
### `RPC`
90+
91+
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.
92+
93+
Configure the address it listens on using this config key.
94+
95+
Default: `/ip4/127.0.0.1/tcp/5003`
96+
8897
### `Delegates`
8998

9099
Delegate peers are used to find peers and retrieve content from the network on your behalf.

0 commit comments

Comments
 (0)
This repository has been archived.