Skip to content

Commit

Permalink
docs(config): clarify RPC vs Gateway
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel authored Apr 5, 2024
1 parent 11183bb commit 413de0f
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,8 +345,8 @@ Contains information about various listener addresses to be used by this node.

### `Addresses.API`

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

Supported Transports:

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

### `Addresses.Gateway`

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

Supported Transports:

Expand Down Expand Up @@ -427,10 +427,12 @@ Default: `[]`
Type: `array[string]` (multiaddrs)

## `API`
Contains information used by the API gateway.

Contains information used by the [Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/).

### `API.HTTPHeaders`
Map of HTTP headers to set on responses from the API HTTP server.

Map of HTTP headers to set on responses from the RPC (`/api/v0`) HTTP server.

Example:
```json
Expand Down

0 comments on commit 413de0f

Please sign in to comment.