Skip to content

Commit

Permalink
Merge pull request #376 from iotaledger/chore/gendoc
Browse files Browse the repository at this point in the history
chore(gendoc): update docs
  • Loading branch information
karimodm authored Sep 27, 2023
2 parents 647fac6 + f14777f commit d81eff5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 15 deletions.
4 changes: 1 addition & 3 deletions config_defaults.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@
"highWatermark": 10,
"lowWatermark": 5
},
"seed": "",
"overwriteStoredSeed": false,
"externalAddress": "auto",
"externalMultiAddresses": [],
"identityPrivateKey": "",
"db": {
"path": "testnet/p2pstore"
Expand Down
20 changes: 8 additions & 12 deletions documentation/docs/references/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,13 @@ Example:

## <a id="p2p"></a> 3. P2p

| Name | Description | Type | Default value |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------------------------------------------- |
| bindMultiAddresses | The bind multi addresses for p2p connections | array | /ip4/0.0.0.0/tcp/14666<br/>/ip6/::/tcp/14666 |
| [connectionManager](#p2p_connectionmanager) | Configuration for connectionManager | object | |
| seed | Private key seed used to derive the node identity; optional base58 or base64 encoded 256-bit string. Prefix with 'base58:' or 'base64', respectively | string | "" |
| overwriteStoredSeed | Whether to overwrite the private key if an existing peerdb exists | boolean | false |
| externalAddress | External IP address under which the node is reachable; or 'auto' to determine it automatically | string | "auto" |
| identityPrivateKey | Private key used to derive the node identity (optional) | string | "" |
| [db](#p2p_db) | Configuration for db | object | |
| Name | Description | Type | Default value |
| ------------------------------------------- | ------------------------------------------------------------- | ------ | -------------------------------------------- |
| bindMultiAddresses | The bind multi addresses for p2p connections | array | /ip4/0.0.0.0/tcp/14666<br/>/ip6/::/tcp/14666 |
| [connectionManager](#p2p_connectionmanager) | Configuration for connectionManager | object | |
| externalMultiAddresses | External reacheable multi addresses advertised to the network | array | |
| identityPrivateKey | Private key used to derive the node identity (optional) | string | "" |
| [db](#p2p_db) | Configuration for db | object | |

### <a id="p2p_connectionmanager"></a> ConnectionManager

Expand Down Expand Up @@ -145,9 +143,7 @@ Example:
"highWatermark": 10,
"lowWatermark": 5
},
"seed": "",
"overwriteStoredSeed": false,
"externalAddress": "auto",
"externalMultiAddresses": [],
"identityPrivateKey": "",
"db": {
"path": "testnet/p2pstore"
Expand Down

0 comments on commit d81eff5

Please sign in to comment.