updating Addresses section
config.md: updating the Addresses section Adding documentation on Announce and NoAnnounce. Fixing typo in API default value. License: MIT Signed-off-by: John Reed <john@re2d.xyz>
John Reed committed
Nov 19, 2017 at 20:31 UTC
8391abb06b5fdf61497836385c8ab05b89304464
1 file changed
+11
-1
docs/config.md
+11
-1
@@ -24,7 +24,7 @@ Contains information about various listener addresses to be used by this node.
24
- `API`
25
Multiaddr describing the address to serve the local HTTP API on.
26
27
-Default: `/ip4/127.0.0.1/tcp/4001`
27
+Default: `/ip4/127.0.0.1/tcp/5001`
28
29
- `Gateway`
30
Multiaddr describing the address to serve the local gateway on.
@@ -42,6 +42,16 @@ Default:
42
]
43
```
44
45
+- `Announce`
46
+Array of swarm addresses to announce to the network.
47
+
48
+Default: `[]`
49
+
50
+- `NoAnnounce`
51
+Array of swarm addresses not to announce to the network.
52
+
53
+Default: `[]`
54
+
55
## `API`
56
Contains information used by the API gateway.
57