streamr-broker
TypeScript icon, indicating that this package has built-in type declarations

33.4.0 • Public • Published

Streamr

streamr-broker

Broker nodes are Streamr Network nodes that run external to your application. You start up a broker node locally or on a server, and interface with it remotely using one of the supported protocols.

The broker node ships with protocol support for HTTP, WebSocket, and MQTT. As libraries for these common protocols exist in practically every programming language, you can conveniently publish data to and subscribe to streams in the Streamr Network using the programming language of your choice.

Broker nodes can also perform other tasks in addition to (or instead of) serving applications, such as mining.

Table of Contents

Install

npm install -g streamr-broker

Node.js 16.13.x is the minimum required version. Node.js 18.12.x, NPM 8.x and later versions are recommended.

For more information on the different ways of setting up a broker node, see setting up a Broker node.

Run

First install the package globally if you have not yet.

Create a configuration file with interactive tool:

streamr-broker-init 

Then run the command broker with the desired configuration file:

streamr-broker <configFile>

Configuration

See configuration for a description of the configuration options.

Plugins

The broker node ships with a number of plugins that can be enabled and configured selectively to match your specific needs. For easy data integration from any programming language environment, plugins for HTTP, WebSocket, and MQTT are provided.

Read more about available plugins.

Readme

Keywords

none

Package Sidebar

Install

npm i streamr-broker

Weekly Downloads

27

Version

33.4.0

License

STREAMR NETWORK OPEN SOURCE LICENSE

Unpacked Size

376 kB

Total Files

170

Last publish

Collaborators

  • samigabor
  • fonty1
  • hpihkala
  • tumppi
  • harbu
  • mariusz_io
  • pzsavola
  • juslesan
  • jtakalai
  • streamr-dev
  • teogeb
  • samt1803
  • mirpo