NSQ Notification Settings

This page documents settings for configuring an NSQ service as a target for Bucket Notifications. See Publish Events to NSQ for a tutorial on using these settings.

You can establish or modify settings by defining:

an environment variable on the host system prior to starting or restarting the MinIO Server. Refer to your operating system’s documentation for how to define an environment variable.
a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, MinIO uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

Important

Each configuration setting controls fundamental MinIO behavior and functionality. MinIO strongly recommends testing configuration changes in a lower environment, such as DEV or QA, before applying to production.

Multiple NSQ Targets

You can specify multiple NSQ service endpoints by appending a unique identifier _ID to the end of the top level key for each set of related NSQ settings. For example, the following commands set two distinct NSQ service endpoints as PRIMARY and SECONDARY respectively:

export MINIO_NOTIFY_NSQ_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_NSQ_NSQD_ADDRESS_PRIMARY="https://user:[email protected]:9200"
export MINIO_NOTIFY_NSQ_TOPIC_PRIMARY="bucketevents"

export MINIO_NOTIFY_NSQ_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_NSQ_NSQD_ADDRESS_SECONDARY="https://user:[email protected]:9200"
export MINIO_NOTIFY_NSQ_TOPIC_SECONDARY="bucketevents"

mc admin config set notify_nsq:primary \
   nsqd_address="ENDPOINT" \
   topic="<string>" \
   [ARGUMENT="VALUE"] ... \

mc admin config set notify_nsq:secondary \
   nsqd_address="ENDPOINT" \
   topic="<string>" \
   [ARGUMENT="VALUE"] ... \

Settings

Enable

Required

`MINIO_NOTIFY_NSQ_ENABLE`

envvar

Specify on to enable publishing bucket notifications to an NSQ endpoint.

`notify_nsq`

mc-conf

The top-level configuration key for defining an NSQ server/broker endpoint for use with MinIO bucket notifications.

Use mc admin config set to set or update an NSQ server/broker endpoint. The following arguments are required for each endpoint:

Specify additional optional arguments as a whitespace (" ")-delimited list.

mc admin config set notify_nsq                          \
   nsqd_address="https://nsq-endpoint.example.net:4150" \
   topic="<string>"                                     \
   [ARGUMENT="VALUE"] ...

NSQ Daemon Server Address

Required

`MINIO_NOTIFY_NSQ_NSQD_ADDRESS`

envvar

`notify_nsq nsqd_address`

mc-conf

Specify the NSQ server address where the NSQ Daemon runs. For example:

https://nsq-endpoint.example.net:4150

Changed: RELEASE.2023-05-27T05-56-19Z

MinIO checks the health of the specified URL (if it is resolvable and reachable) prior to adding the target. MinIO no longer blocks adding new notification targets if existing targets are offline.

Topic

Required

`MINIO_NOTIFY_NSQ_TOPIC`

envvar

`notify_nsq topic`

mc-conf

Specify the name of the NSQ topic MinIO uses when publishing events to the broker.

TLS

Optional

`MINIO_NOTIFY_NSQ_TLS`

envvar

`notify_nsq tls`

mc-conf

Specify on to enable TLS connectivity to the NSQ service broker.

TLS Skip Verify

Optional

`MINIO_NOTIFY_NSQ_TLS_SKIP_VERIFY`

envvar

`notify_nsq tls_skip_verify`

mc-conf

Enables or disables TLS verification of the NSQ service broker TLS certificates.

Specify on to disable TLS verification (Default).
Specify off to enable TLS verification.

Queue Directory

Optional

`MINIO_NOTIFY_NSQ_QUEUE_DIR`

envvar

`notify_nsq queue_dir`

mc-conf

Specify the directory path to enable MinIO’s persistent event store for undelivered messages, such as /opt/minio/events.

MinIO stores undelivered events in the specified store while the NSQ server/broker is offline and replays the stored events when connectivity resumes.

Queue Limit

Optional

`MINIO_NOTIFY_NSQ_QUEUE_LIMIT`

envvar

`notify_nsq queue_limit`

mc-conf

Specify the maximum limit for undelivered messages. Defaults to 100000.

Comment

Optional

`MINIO_NOTIFY_NSQ_COMMENT`

envvar

`notify_nsq comment`

mc-conf

Specify a comment to associate with the NSQ configuration.

Last modified August 2, 2026: init commit (8338d5b)