NATS Notification Settings

This page documents settings for configuring an NATS service as a target for Bucket Notifications. See Publish Events to NATS 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.

Multiple NATS Targets

You can specify multiple NATS service endpoints by appending a unique identifier _ID for each set of related NATS settings on to the top level key.

Example

For example, the following commands set two distinct NATS service endpoints as PRIMARY and SECONDARY respectively:

• Environment Variables
• Configuration Settings

export MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="nats-endpoint.example.net:4222"

export MINIO_NOTIFY_NATS_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_NATS_ADDRESS_SECONDARY="nats-endpoint.example.net:4222"

mc admin config set notify_nats:primary \
   address="nats-endpoint.example.com:4222" \
   subject="minioevents" \
   [ARGUMENT=VALUE ...]

mc admin config set notify_nats:secondary \
   address="nats-endpoint.example.com:4222" \
   subject="minioevents" \
   [ARGUMENT=VALUE ...]

Settings

Enable

Required

• Environment Variable
• Configuration Setting

mc admin config set notify_nats \
  address="nats-endpoint.example.com:4222" \
  subject="minioevents" \
  [ARGUMENT="VALUE"] ... \

Address

Required

• Environment Variable
• Configuration Setting

Specify the NATS service endpoint to which MinIO publishes bucket events. For example, nats-endpoint.example.com:4222.

Subject

Required

• Environment Variable
• Configuration Setting

Specify the subscription to which MinIO associates events published to the NATS endpoint.

Username

Optional

• Environment Variable
• Configuration Setting

Specify the username for connecting to the NATS service endpoint.

Password

Optional

• Environment Variable
• Configuration Setting

Specify the passport for connecting to the NATS service endpoint.

Token

Optional

• Environment Variable
• Configuration Setting

Specify the token for connecting to the NATS service endpoint.

User Credentials File

Optional

• Environment Variable
• Configuration Setting

Specify the to the user credentials file <https://docs.nats.io/using-nats/developer/connecting/creds> to use to connect to the NATS service endpoint.

TLS

Optional

• Environment Variable
• Configuration Setting

Specify on to enable TLS connectivity to the NATS service endpoint.

TLS Skip Verify

Optional

• Environment Variable
• Configuration Setting

Enables or disables TLS verification of the NATS service endpoint TLS certificates.

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

Ping Interval

Optional

• Environment Variable
• Configuration Setting

Specify the duration interval for client pings to the NATS server. MinIO supports the following time units:

• s - seconds, "60s"
• m - minutes, "5m"
• h - hours, "1h"
• d - days, "1d"

Jetstream

Optional

• Environment Variable
• Configuration Setting

Specify on to enable JetStream support for streaming events to a NATS JetStream service endpoint.

Streaming

Deprecated

Optional

• Environment Variable
• Configuration Setting

Specify on to enable asynchronous publishing of events to the NATS service endpoint.

Streaming Async

Deprecated

Optional

• Environment Variable
• Configuration Setting

Specify on to enable asynchronous publishing of events to the NATS service endpoint.

Max ACK Responses In Flight

Deprecated

Optional

• Environment Variable
• Configuration Setting

Specify the number of messages to publish without waiting for an ACK response from the NATS service endpoint.

Streaming Cluster ID

Deprecated

Optional

• Environment Variable
• Configuration Setting

Specify the unique ID for the NATS streaming cluster.

Cert Authority

Optional

• Environment Variable
• Configuration Setting

Specify the path to the Certificate Authority chain used to sign the NATS service endpoint TLS certificates.

Client Cert

Optional

• Environment Variable
• Configuration Setting

Specify the path to the client certificate to use for performing mTLS authentication to the NATS service endpoint.

Client Key

Optional

• Environment Variable
• Configuration Setting

Specify the path to the client private key to use for performing mTLS authentication to the NATS service endpoint.

Queue Directory

Optional

• Environment Variable
• Configuration Setting

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 NATS server/broker is offline and replays the stored events when connectivity resumes.

Queue Limit

Optional

• Environment Variable
• Configuration Setting

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

Comment

Optional

• Environment Variable
• Configuration Setting

Specify a comment to associate with the NATS configuration.