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

Commit e68a931

Browse files
vasco-santosAlan Shaw
and
Alan Shaw
authored
chore: apply suggestions from code review
Co-Authored-By: Alan Shaw <[email protected]>
1 parent 27919d6 commit e68a931

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

config.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@ The IPFS daemon exposes an HTTP API that allows to control the node and
2020
run the same commands as you can do from the command line. It is defined
2121
on the [HTTP API Spec](https://docs.ipfs.io/reference/api/http).
2222

23-
Multiaddr describing the address to serve the local HTTP API on.
23+
[Multiaddr](https://github.com/multiformats/multiaddr/) or array of [Multiaddr](https://github.com/multiformats/multiaddr/) describing the address(es) to serve the HTTP API on.
2424

2525
Default: `/ip4/127.0.0.1/tcp/5002`
2626

2727
- `Gateway`
2828
A gateway is exposed by the IPFS daemon, which allows an easy way to
2929
access content from IPFS, using an IPFS path.
3030

31-
Multiaddr describing the address to serve the local gateway on.
31+
[Multiaddr](https://github.com/multiformats/multiaddr/) or array of [Multiaddr](https://github.com/multiformats/multiaddr/) describing the address(es) to serve the gateway on.
3232

3333
Default: `/ip4/127.0.0.1/tcp/9090`
3434

3535
- `Swarm`
36-
Array of multiaddrs describing which addresses to listen on for p2p swarm connections.
36+
Array of [Multiaddr](https://github.com/multiformats/multiaddr/) describing which addresses to listen on for p2p swarm connections.
3737

3838
Default:
3939
```json
@@ -44,15 +44,15 @@ Default:
4444
```
4545

4646
## `Bootstrap`
47-
Bootstrap is an array of multiaddrs of trusted nodes to connect to in order to
47+
Bootstrap is an array of [Multiaddr](https://github.com/multiformats/multiaddr/) of trusted nodes to connect to in order to
4848
initiate a connection to the network.
4949

5050
## `Datastore`
5151
Contains information related to the construction and operation of the on-disk
5252
storage system.
5353

5454
- `Spec`
55-
Spec defines the structure of the ipfs datastore. It is a composable structure, where each datastore is represented by a json object. Datastores can wrap other datastores to provide extra functionality (eg metrics, logging, or caching).
55+
Spec defines the structure of the IPFS datastore. It is a composable structure, where each datastore is represented by a JSON object. Datastores can wrap other datastores to provide extra functionality (e.g. metrics, logging, or caching).
5656

5757
This can be changed manually, however, if you make any changes that require a different on-disk structure, you will need to run the [ipfs-ds-convert tool](https://github.com/ipfs/ipfs-ds-convert) to migrate data into the new structures.
5858

@@ -89,16 +89,16 @@ Default:
8989
```
9090

9191
## `Discovery`
92-
Contains options for configuring ipfs node discovery mechanisms.
92+
Contains options for configuring IPFS node discovery mechanisms.
9393

9494
- `MDNS`
95-
Multicast dns is a discovery protocol that is able to find other peers
95+
Multicast DNS is a discovery protocol that is able to find other peers
9696
on the local network.
9797

98-
Options for multicast dns peer discovery.
98+
Options for Multicast DNS peer discovery.
9999

100100
- `Enabled`
101-
A boolean value for whether or not mdns should be active.
101+
A boolean value for whether or not MDNS should be active.
102102

103103
Default: `true`
104104

0 commit comments

Comments
 (0)