arablocks / ara-network-node-dns

An Ara Network node that runs a DNS

ara-network-node-dns

An Ara Network node that runs a DNS.

Status

This project is still in alpha development.

Important: While this project is under active development, run npm link in ara-network-node-dns directory & npm link ara-network-node-dns in ara-network directory.

Dependencies

• Node
• ara-network

Installation

$ npm install ara-network ara-network-node-dns

Configuration

ara-runtime-configuration is a dependency of ara-network and will either read from the nearest .ararc. Install ara-runtime-configuration separately to specify default values not present in an .ararc.

Runtime configuration can be specified by targeting the [network.node.dns] INI section or a nested JSON object { network: { node: { dns: { ... }}}}.

Examples

INI format in an .ararc:

[network.node.dns]
multicast = true
loopback = true
port = 5300

JSON format (passed in to ara-runtime-configuration rc function:

"network": {
  "node": {
    "dns": {
      "multicast": true,
      "loopback": true,
      "port": 5300
    }
  }
}

Usage

const dns = require('ara-network-node-dns')

Command Line (ann)

$ ann --type dns --help
usage: ann -t dns [options]

Options:
  --debug, -D  Enable debug output                                     [boolean]
  --conf, -C   Path to configuration file                               [string]
  --help, -h   Show help                                               [boolean]
  --port, -p   Port or ports to listen on          [number] [default: [53,5300]]
  --loopback   Loopback DNS discovery                  [boolean] [default: true]
  --multicast  Multicast DNS discovery                 [boolean] [default: true]

Examples

Command Line (ann)

Invoke a network node with the ann (or ara-network-node) command line interface:

$ ann --type dns --port 5300

Contributing

• Commit message format
• Commit message examples
• How to contribute

See Also

• ara-network
• ara-runtime-configuration
• dns-discovery

License

LGPL-3.0

ara-network-node-dns's Issues

Ara Network Nodes (DNS, DHT & Signalhub) could be merged into 1 single repository

• Currently there are 3 separate repositories for discovery nodes,

1. arablocks/ara-network-node-dns
2. arablocks/ara-network-node-dht
3. arablocks/ara-network-node-signalhub

• This could be merged into 1 single repository as,

1. arablocks/ara-discovery-node