docs(config): clarify RPC vs Gateway
Marcin Rataj committed
Apr 5, 2024 at 23:53 UTC
413de0f83137df2347ab2826149fb68b77b74468
1 file changed
+8
-6
docs/config.md
+8
-6
@@ -345,8 +345,8 @@ Contains information about various listener addresses to be used by this node.
345
346
### `Addresses.API`
347
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`).
350
351
Supported Transports:
352
@@ -359,8 +359,8 @@ Type: `strings` (multiaddrs)
359
360
### `Addresses.Gateway`
361
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.
364
365
Supported Transports:
366
@@ -427,10 +427,12 @@ Default: `[]`
427
Type: `array[string]` (multiaddrs)
428
429
## `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/).
432
433
### `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.
436
437
Example:
438
```json