@dxos/signal

DxOS signal server.

Install

$ npm install -g @dxos/signal

Usage

$ signal --help

signal [topic]

start a signal server

Options:
  --version        Show version number                                 [boolean]
  --help           Show help                                           [boolean]
  --topic          topic to find other signal servers[string] [default: "#dxos"]
  --port, -p       defines a port to listening                   [default: 4000]
  --bootstrap, -b  defines a list of bootstrap nodes                     [array]
  --asBootstrap    enable the signal as a bootstrap node
                                                      [boolean] [default: false]
  --repl, -r       start a repl console with your signal               [boolean]
  --logLevel, -l   defines the log level
                   [choices: "debug", "info", "warn", "error"] [default: "info"]
  --logFormat      defines the log format
                  [choices: "full", "short", "simple", "json"] [default: "full"]
  --logDir         defines a log directory                              [string]

const { createBroker } = require('@dxos/signal')

const topic = randomBytes(32)

createBroker(topic, opts).start()

API

...

Contributing

PRs accepted.

License

GPL-3.0 © dxos

DxOS Signal Server