Skip to content

Commit 413de0f

Browse files
authored
docs(config): clarify RPC vs Gateway
1 parent 11183bb commit 413de0f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/config.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -345,8 +345,8 @@ Contains information about various listener addresses to be used by this node.
345345

346346
### `Addresses.API`
347347

348-
Multiaddr or array of multiaddrs describing the address to serve the local HTTP
349-
API on.
348+
Multiaddr or array of multiaddrs describing the address to serve
349+
the local [Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/) (`/api/v0`).
350350

351351
Supported Transports:
352352

@@ -359,8 +359,8 @@ Type: `strings` (multiaddrs)
359359

360360
### `Addresses.Gateway`
361361

362-
Multiaddr or array of multiaddrs describing the address to serve the local
363-
gateway on.
362+
Multiaddr or array of multiaddrs describing the address to serve
363+
the local [HTTP gateway](https://specs.ipfs.tech/http-gateways/) (`/ipfs`, `/ipns`) on.
364364

365365
Supported Transports:
366366

@@ -427,10 +427,12 @@ Default: `[]`
427427
Type: `array[string]` (multiaddrs)
428428

429429
## `API`
430-
Contains information used by the API gateway.
430+
431+
Contains information used by the [Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/).
431432

432433
### `API.HTTPHeaders`
433-
Map of HTTP headers to set on responses from the API HTTP server.
434+
435+
Map of HTTP headers to set on responses from the RPC (`/api/v0`) HTTP server.
434436

435437
Example:
436438
```json

0 commit comments

Comments
 (0)