ara-network-node-signalhub

An Ara network node that runs a signalhub server to coordinate handshaking.

Status

This project is in active development.

Stability

[Stability][stability-index]: 1 - Experimental. This feature is still under active development and subject to non-backwards compatible changes, or even removal, in any future version. Use of the feature is not recommended in production environments. Experimental features are not subject to the Node.js Semantic Versioning model.

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

Dependencies

• Node
• ara-network
• ara-runtime-configuration

Installation

$ npm install ara-network ara-network-node-signalhub

Configuration

ara-runtime-configuration is a dependency of ara-network and will 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: { signalhub: { ... }}}}.

Examples

INI format in an .ararc:

[network.node.signalhub]
maxBroadcasts: Infinity
port = 8881

Usage

const hub = require('ara-network-node-signalhub')

Command Line (ann)

$ ann --type signalhub --help
usage: ann -t . [options]

General Options:
  --help, -h     Show help                                             [boolean]
  --debug, -D    Enable debug output                                   [boolean]
  --version, -V  Show version number                                   [boolean]

Configuration Options:
  --type, -t  Node type to start
  --conf, -C  Path to configuration file

Options:
  --port, -p  Port for server to listen on

Examples

Command Line (ann)

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

$ ann --type signalhub --port 8881

Contributing

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

See Also

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

License

LGPL-3.0