From 8391abb06b5fdf61497836385c8ab05b89304464 Mon Sep 17 00:00:00 2001 From: John Reed Date: Sun, 19 Nov 2017 20:31:25 -0600 Subject: [PATCH 1/2] 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 --- docs/config.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/config.md b/docs/config.md index 912cdce75..49e39d59d 100644 --- a/docs/config.md +++ b/docs/config.md @@ -24,7 +24,7 @@ Contains information about various listener addresses to be used by this node. - `API` Multiaddr describing the address to serve the local HTTP API on. -Default: `/ip4/127.0.0.1/tcp/4001` +Default: `/ip4/127.0.0.1/tcp/5001` - `Gateway` Multiaddr describing the address to serve the local gateway on. @@ -42,6 +42,16 @@ Default: ] ``` +- `Announce` +Array of swarm addresses to announce to the network. + +Default: `[]` + +- `NoAnnounce` +Array of swarm addresses not to announce to the network. + +Default: `[]` + ## `API` Contains information used by the API gateway. From 42a0c14f2a321c912356f07ff0f6096fa9c4ea3b Mon Sep 17 00:00:00 2001 From: John Reed Date: Mon, 20 Nov 2017 09:48:19 -0600 Subject: [PATCH 2/2] adding detail on Announce Clarifying that the Announce array is only used when non-empty and will override the default inferred announce addresses. License: MIT Signed-off-by: John Reed --- docs/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.md b/docs/config.md index 49e39d59d..10fe09c47 100644 --- a/docs/config.md +++ b/docs/config.md @@ -43,7 +43,7 @@ Default: ``` - `Announce` -Array of swarm addresses to announce to the network. +If non-empty, this array specifies the swarm addresses to announce to the network. If empty, the daemon will announce inferred swarm addresses. Default: `[]`