From 0989f920709f884ef7d5d7777cd5a54c4fe3bcd8 Mon Sep 17 00:00:00 2001 From: Neil Alexander Date: Mon, 17 Dec 2018 17:04:42 +0000 Subject: [PATCH] Update admin.md, configuration.md --- admin.md | 12 +++++++++++- configuration.md | 6 +++--- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/admin.md b/admin.md index 831032f..c28cc70 100644 --- a/admin.md +++ b/admin.md @@ -296,10 +296,20 @@ Expects: - `coords=` `string`, location of the remote node in the network, in the same format as e.g. a `getDHT` response - `target=` `string`, hex-encoded 512-bit NodeID to ask about, affects what the response from the remote node will be, optional -Asks a remote node to respond with information from the DHT +Asks a remote node to respond with information from the DHT. Returns a `nodes` section with information about each node included in the DHT lookup response, indexed by IPv6. For each IPv6 address, this includes: - `box_pub_key` (`string`) contains the `EncryptionPublicKey` of the remote node - `coords` (`string`) contains the coordinates of the node on the spanning tree + +#### `getNodeInfo` + +Expects: +- `box_pub_key=` `string`, hex-encoded public key of the remote node to ping, in the same format as e.g. verbose output from a `getDHT` response +- `coords=` `string`, location of the remote node in the network, in the same format as e.g. a `getDHT` response + +Asks a remote node to respond with their nodeinfo. + +Returns a `nodeinfo` section with the nodeinfo. This can be in any format, containing any keys. diff --git a/configuration.md b/configuration.md index ecc6f26..dd857cb 100644 --- a/configuration.md +++ b/configuration.md @@ -291,9 +291,9 @@ Note that any field not specified in the configuration will use its default valu ``` NodeInfo: { - name: hostname.y.domain.com - contact: email@domain.com - location: Place, Country + name: hostname.y.domain.com + contact: email@domain.com + location: Place, Country } ```