docs/source/includes/common-mc-admin-config.rst

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

Defaults to off.

Specify the AMQP server endpoint to which MinIO publishes bucket events. For example, amqp://myuser:mypassword@localhost:5672.

Specify the name of the AMQP exchange to use.

Specify the type of the AMQP exchange.

Specify the routing key for publishing events.

Specify off to ignore undelivered messages errors. Defaults to on.

Specify on to persist the message queue across broker restarts. Defaults to 'off'.

Specify on to enable non-blocking message delivery. Defaults to 'off'.

Specify on to use the exchange only if it is bound to other exchanges. See the RabbitMQ documentation on Exchange to Exchange Bindings for more information on AMQP exchange binding.

Specify on to automatically delete the message queue if there are no consumers. Defaults to off.

Specify 1 for set the delivery mode to non-persistent queue.

Specify 2 to set the delivery mode to persistent queue.

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

MinIO stores undelivered events in the specified store while the AMQP service is offline and replays the directory when connectivity resumes.

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

Specify a comment for the AMQP configuration.

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

Defaults to off.

Specify the MQTT server/broker endpoint. MinIO supports TCP, TLS, or Websocket connections to the server/broker URL. For example:

• tcp://mqtt.example.net:1883
• tls://mqtt.example.net:1883
• ws://mqtt.example.net:1883

Specify the name of the MQTT topic to associate with events published by MinIO to the MQTT endpoint.

Specify the MQTT username with which MinIO authenticates to the MQTT server/broker.

Specify the password for the MQTT username with which MinIO authenticates to the MQTT server/broker.

Specify the Quality of Service priority for the published events.

Defaults to 0.

Specify the keep-alive interval for the MQTT connections. MinIO supports the following units of time measurement:

• s - seconds, "60s"
• m - minutes, "60m"
• h - hours, "24h"
• d - days, "7d"

Specify the reconnect interval for the MQTT connections. MinIO supports the following units of time measurement:

• s - seconds, "60s"
• m - minutes, "60m"
• h - hours, "24h"
• d - days, "7d"

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

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

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

Specify a comment to associate with the MQTT configuration.

Specify on to enable publishing bucket notifications to an Elasticsearch service endpoint.

Defaults to off.

Specify the Elasticsearch service endpoint to which MinIO publishes bucket events. For example, https://elasticsearch.example.com:9200.

MinIO supports passing authentication information using as URL parameters using the format PROTOCOL://USERNAME:PASSWORD@HOSTNAME:PORT.

Specify the name of the Elasticsearch index in which to store or update MinIO bucket events. Elasticsearch automatically creates the index if it does not exist.

Specify the format of event data written to the Elasticsearch index. MinIO supports the following values:

namespace

For each bucket event, the MinIO creates a JSON document with the bucket and object name from the event as the document ID and the actual event as part of the document body. Additional updates to that object modify the existing index entry for that object. Similarly, deleting the object also deletes the corresponding index entry.

access

For each bucket event, MinIO creates a JSON document with the event details and appends it to the index with an Elasticsearch-generated random ID. Additional updates to an object result in new index entries, and existing entries remain unmodified.

The username for connecting to an Elasticsearch service endpoint which enforces authentication.

The password for connecting to an Elasticsearch service endpoint which enforces authentication.

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

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

MinIO stores undelivered events in the specified store while the Elasticsearch service is offline and replays the directory when connectivity resumes.

Specify a comment to associate with the Elasticsearch configuration.

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

Specify the NSQ server address. For example:

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

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

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

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.

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

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

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

Specify a comment to associate with the NSQ configuration.

Specify on to enable publishing bucket notifications to a Redis service endpoint.

Defaults to off.

Specify the Redis service endpoint to which MinIO publishes bucket events. For example, https://redis.example.com:6369.

Specify the Redis key to use for storing and updating events. Redis auto-creates the key if it does not exist.

Specify the format of event data written to the Redis service endpoint. MinIO supports the following values:

namespace

For each bucket event, the MinIO creates a JSON document with the bucket and object name from the event as the document ID and the actual event as part of the document body. Additional updates to that object modify the existing index entry for that object. Similarly, deleting the object also deletes the corresponding index entry.

access

For each bucket event, MinIO creates a JSON document with the event details and appends it to the key with a Redis-generated random ID. Additional updates to an object result in new index entries, and existing entries remain unmodified.

Specify the password for the Redis server.

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

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

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

Specify a comment to associate with the Redis configuration.

Specify on to enable publishing bucket notifications to an NATS service endpoint.

Defaults to off.

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

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

Specify the username for connecting to the NATS service endpoint.

Specify the passport for connecting to the NATS service endpoint.

Specify the token for connecting to the NATS service endpoint.

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

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.

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"

Specify on to enable streaming events to the NATS service endpoint.

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

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

Specify the unique ID for the NATS streaming cluster.

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

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

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

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

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

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

Specify a comment to associate with the NATS configuration.

Specify on to enable publishing bucket notifications to a PostgreSQL service endpoint.

Defaults to off.

Specify the URI connection string of the PostgreSQL service endpoint. MinIO supports key=value format for the PostgreSQL connection string. For example:

"host=https://postgresql.example.com port=5432 ..."

For more complete documentation on supported PostgreSQL connection string parameters, see the PostgreSQL COnnection Strings documentation .

Specify the name of the PostgreSQL table to which MinIO publishes event notifications.

Specify the format of event data written to the PostgreSQL service endpoint. MinIO supports the following values:

namespace

For each bucket event, the MinIO creates a JSON document with the bucket and object name from the event as the document ID and the actual event as part of the document body. Additional updates to that object modify the existing table entry for that object. Similarly, deleting the object also deletes the corresponding table entry.

access

For each bucket event, MinIO creates a JSON document with the event details and appends it to the table with a PostgreSQL-generated random ID. Additional updates to an object result in new index entries, and existing entries remain unmodified.

Specify the maximum number of open connections to the PostgreSQL database.

Defaults to 2.

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

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

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

Specify a comment to associate with the PostgreSQL configuration.

Specify on to enable publishing bucket notifications to a MySQL service endpoint.

Defaults to off.

Specify the data source name (DSN) of the MySQL service endpoint. MinIO expects the following format:

<user>:<password>@tcp(<host>:<port>)/<database>

For example:

"username:password@tcp(mysql.example.com:3306)/miniodb"

Specify the data source name (DSN) connection string for the MySQL service endpoint. MinIO expects the following format:

<user>:<password>@tcp(<host>:<port>)/<database>

For example:

"username:password@tcp(mysql.example.com:3306)/miniodb"

Specify the name of the MySQL table to which MinIO publishes event notifications.

Specify the format of event data written to the MySQL service endpoint. MinIO supports the following values:

namespace

For each bucket event, the MinIO creates a JSON document with the bucket and object name from the event as the document ID and the actual event as part of the document body. Additional updates to that object modify the existing table entry for that object. Similarly, deleting the object also deletes the corresponding table entry.

access

For each bucket event, MinIO creates a JSON document with the event details and appends it to the table with a MySQL-generated random ID. Additional updates to an object result in new index entries, and existing entries remain unmodified.

Specify the maximum number of open connections to the MySQL database.

Defaults to 2.

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

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

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

Specify a comment to associate with the MySQL configuration.

Specify on to enable publishing bucket notifications to a Kafka service endpoint.

Defaults to off.

Specify a comma-separated list of Kafka broker addresses. For example:

"kafka1.example.com:2021,kafka2.example.com:2021"

Specify the name of the Kafka topic to which MinIO publishes bucket events.

Specify the username for performing SASL/PLAIN or SASL/SCRAM authentication to the Kafka broker(s).

Specify the password for performing SASL/PLAIN or SASL/SCRAM authentication to the Kafka broker(s).

Specify the SASL mechanism to use for authenticating to the Kafka broker(s). MinIO supports the following mechanisms:

• PLAIN (Default)
• SHA256
• SHA512

Specify the client authentication policy of the Kafka broker(s). See ClientAuthType for more information on possible values for this field.

Specify on to enable SASL authentication.

Specify on to enable TLS connectivity to the Kafka broker(s)

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.

Specify the path to the client certificate to use for performing mTLS authentication to the Kafka broker(s).

Specify the path to the client private key to use for performing mTLS authentication to the Kafka broker(s).

Specify the version of the Kafka cluster to assume when performing operations against that cluster. See the sarama reference documentation for more information on this field's behavior.

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

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

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

Specify a comment to associate with the Kafka configuration.

Specify on to enable publishing bucket notifications to a Webhook service endpoint.

Defaults to off.

Specify the URL for the webhook service.

Specify the opaque string or JWT authorization token to use for authenticating to the webhook service.

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

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

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

MinIO stores undelivered events in the specified store while the webhook service is offline and replays the directory when connectivity resumes.

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

Specify a comment to associate with the Webhook configuration.