nsq Documentation

File: README.md Copy Chapter

NSQ is a realtime distributed messaging platform designed to operate at scale, handling
billions of messages per day.

It promotes distributed and decentralized topologies without single points of failure,
enabling fault tolerance and high availability coupled with a reliable message delivery
guarantee. See features & guarantees.

Operationally, NSQ is easy to configure and deploy (all parameters are specified on the command
line and compiled binaries have no runtime dependencies). For maximum flexibility, it is agnostic to
data format (messages can be JSON, MsgPack, Protocol Buffers, or anything else). Official Go and
Python libraries are available out of the box (as well as many other client
libraries), and if you're interested in building your own, there's a protocol
spec.

We publish binary releases for Linux, Darwin, FreeBSD and Windows, as well as an official Docker image.

NOTE: master is our development branch and may not be stable at all times.

In Production Copy Chapter

Code of Conduct Copy Chapter

Help us keep NSQ open and inclusive. Please read and follow our Code of Conduct.

Authors Copy Chapter

NSQ was designed and developed by Matt Reiferson (@imsnakes) and Jehiah Czebotar
(@jehiah) but wouldn't have been possible without the support of Bitly,
maintainers (Pierce Lopez), and all our contributors.

Logo created by Wolasi Konu (@kisalow).

File: apps/to_nsq/README.md Copy Chapter

to_nsq

A tool for publishing to an nsq topic with data from stdin.

Usage Copy Chapter

Usage of ./to_nsq:
  -delimiter string
    	character to split input from stdin (default "\n")
  -nsqd-tcp-address value
    	destination nsqd TCP address (may be given multiple times)
  -producer-opt value
    	option to passthrough to nsq.Producer (may be given multiple times, http://godoc.org/github.com/nsqio/go-nsq#Config)
  -rate int
    	Throttle messages to n/second. 0 to disable
  -topic string
    	NSQ topic to publish to

Examples Copy Section

Publish each line of a file:

$ cat source.txt | to_nsq -topic="topic" -nsqd-tcp-address="127.0.0.1:4150"

Publish three messages, in one go:

$ echo "one,two,three" | to_nsq -delimiter="," -topic="topic" -nsqd-tcp-address="127.0.0.1:4150"

File: apps/nsqlookupd/README.md Copy Chapter

nsqlookupd Copy Chapter

nsqlookupd is the daemon that manages topology metadata and serves client requests to
discover the location of topics at runtime.

Read the docs.

File: apps/nsqd/README.md Copy Chapter

nsqd Copy Chapter

nsqd is the daemon that receives, queues, and delivers messages to clients.

Read the docs.

File: nsqadmin/README.md Copy Chapter

nsqadmin Copy Chapter

nsqadmin is a Web UI to view aggregated cluster stats in realtime and perform various
administrative tasks.

Read the docs

Local Development Copy Chapter

Dependencies Copy Section

1. Install NodeJS 16.x (includes npm)

Live Reload Workflow Copy Section

1. $ npm install
2. $ ./gulp --series clean watch
3. $ cd .. && make && ./build/nsqadmin --dev-static-dir=nsqadmin/static/build --lookupd-http-address=<...>
4. make changes to static assets (repeat step 3 only if you make changes to any Go code)

Build Copy Section

1. $ ./gulp --series clean build

File: nsqd/README.md Copy Chapter

nsqd Copy Chapter

nsqd is the daemon that receives, queues, and delivers messages to clients.

Read the docs

File: nsqlookupd/README.md Copy Chapter

nsqlookupd Copy Chapter

nsqlookupd is the daemon that manages topology metadata and serves client requests to
discover the location of topics at runtime.

Read the docs