Welcome to the upcoming version of the MinIO Documentation! The content on this page is under active development and may change at any time. If you can't find what you're looking for, check our legacy documentation. Thank you for your patience.

MinIO Server

MinIO Server

The minio server command starts the MinIO server process:

minio server /mnt/disk{1...4}

For examples of deploying minio server on a bare metal environment, see Installation.

For examples of deploying minio server on a Kubernetes environment, see Kubernetes documentation.

Configuration Settings

The minio server process stores its configuration in the storage backend directory. You can modify configuration options using the mc admin config command.

Syntax

Starts the minio server process.

The command has the following syntax:

minio server [FLAGS] HOSTNAME/DIRECTORIES [HOSTNAME/DIRECTORIES..]

The command accepts the following arguments:

HOSTNAME

The hostname of a minio server process.

For standalone deployments, this field is optional. You can start a standalone server process with only the DIRECTORIES argument.

For distributed deployments, specify the hostname of each minio server in the deployment. The group of minio server processes represent a single Server Pool.

HOSTNAME supports MinIO expansion notation {x...y} to denote a sequential series of hostnames. MinIO requires sequential hostnames to identify each minio server process in the set.

For example, https://minio{1...4}.example.net expands to:

  • https://minio1.example.net

  • https://minio2.example.net

  • https://minio3.example.net

  • https://minio4.example.net

You must run the minio server command with the same combination of HOSTNAME and DIRECTORIES on each host in the Server Pool.

Each additional HOSTNAME/DIRECTORIES pair denotes an additional Server Set for the purpose of horizontal expansion of the MinIO deployment. For more information on Server Pools, see Server Pool.

DIRECTORIES

The directories or drives the minio server process uses as the storage backend.

DIRECTORIES supports MinIO expansion notation {x...y} to denote a sequential series of folders or drives. For example, /mnt/disk{1...4} expands to:

  • /mnt/disk1

  • /mnt/disk2

  • /mnt/disk3

  • /mnt/disk4

The DIRECTORIES path(s) must be empty when first starting the minio process.

The minio server process requires at least 4 drives or directories to enable erasure coding.

Important

MinIO recommends locally-attached drives, where the DIRECTORIES path points to each disk on the host machine. MinIO recommends against using network-attached storage, as network latency reduces performance of those drives compared to locally-attached storage.

For development or evaluation, you can specify multiple logical directories or partitions on a single physical volume to enable erasure coding on the deployment.

For production environments, MinIO does not recommend using multiple logical directories or partitions on a single physical disk. While MinIO supports those configurations, the potential cost savings come at the risk of decreased reliability.

--address

Optional Binds the minio server process to a specific network address and port number. Specify the address and port as ADDRESS:PORT, where ADDRESS is an IP address or hostname and PORT is a valid and open port on the host system.

To change the port number for all IP addresses or hostnames configured on the host machine, specify :PORT where PORT is a valid and open port on the host.

If omitted, minio binds to port 9000 on all configured IP addresses or hostnames on the host machine.

--certs-dir, ---S

Optional Specifies the path to the folder containing certificates the minio process uses for configuring TLS/SSL connectivity.

Omit to use the default directory paths:

  • Linux/OSX: ${HOME}/.minio/certs

  • Windows: %%USERPROFILE%%\.minio\certs.

See MinIO Transport Layer Security for more information on TLS/SSL connectivity.

--quiet

Optional Disables startup information.

--anonymous

Optional Hides sensitive information from logging.

--json

Optional Outputs server logs and startup information in JSON format.

Environment Variables

The minio server processes uses the following environment variables during startup to set configuration settings.

Root Credentials

MINIO_ACCESS_KEY

The access key for the root user.

Warning

If MINIO_ACCESS_KEY is unset, minio defaults to minioadmin.

NEVER use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random MINIO_ACCESS_KEY value for all environments.

MINIO_SECRET_KEY

The secret key for the root user.

Warning

If MINIO_SECRET_KEY is unset, minio defaults to minioadmin.

NEVER use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random MINIO_ACCESS_KEY value for all environments.

MINIO_ACCESS_KEY_OLD

Used for rotating the root user access key.

Restart the minio server process with all of the following environment variables to rotate the root credentials:

The minio server process automatically detects and re-encrypts the server configuration with the new credentials. After the process restarts successfully, you can restart it without MINIO_ACCESS_KEY_OLD.

MINIO_SECRET_KEY_OLD

Used for rotating the root user secret key.

Restart the minio server process with all of the following environment variables to rotate the root credentials:

The minio server process automatically detects and re-encrypts the server configuration with the new credentials. After the process restarts successfully, you can restart it without MINIO_SECRET_KEY_OLD.

Storage Class

These environment variables configure the parity to use for objects written to the MinIO cluster.

MinIO Storage Classes are distinct from AWS Storage Classes, where the latter refers to the specific storage tier on which to store a given object.

MINIO_STORAGE_CLASS_STANDARD

The number of parity blocks to create for objects with the standard (default) storage class. MinIO uses the EC:N notation to refer to the number of parity blocks (N). This environment variable only applies to deployments with Erasure Coding enabled.

Defaults to 4.

MINIO_STORAGE_CLASS_REDUCED

The number of parity blocks to create for objects with the reduced redundancy storage class. MinIO uses the EC:N notation to refer to the number of parity blocks (N). This environment variable only applies to deployments with Erasure Coding enabled.

Defaults to 2.

MINIO_STORAGE_CLASS_COMMENT

Adds a comment to the storage class settings.

Bucket Notifications

These environment variables configure notification targets for use with MinIO Bucket Notifications:

AMQP Service for Bucket Notifications

The following section documents environment variables for configuring an AMQP service as a target for MinIO Bucket Notifications. See Publish Events to AMQP (RabbitMQ) for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_AMQP_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_AMQP_URL_PRIMARY="amqp://user:password@amqp-endpoint.example.net:5672"

set MINIO_NOTIFY_AMQP_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_AMQP_URL_SECONDARY="amqp://user:password@amqp-endpoint.example.net:5672"

For example, MINIO_NOTIFY_AMQP_ENABLE_PRIMARY indicates the environment variable is associated to an AMQP service endpoint with ID of PRIMARY.

MINIO_NOTIFY_AMQP_ENABLE

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

Defaults to off.

Requires specifying MINIO_NOTIFY_AMQP_URL if set to on.

MINIO_NOTIFY_AMQP_URL

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

This field is required if MINIO_NOTIFY_AMQP_ENABLE is on. All other AMQP-related variables are optional.

This variable corresponds to the notify_amqp url configuration setting.

MINIO_NOTIFY_AMQP_EXCHANGE

Specify the name of the AMQP exchange to use.

This variable corresponds to the notify_amqp exchange configuration setting.

MINIO_NOTIFY_AMQP_EXCHANGE_TYPE

Specify the type of the AMQP exchange.

This variable corresponds to the notify_amqp exchange_type configuration setting.

MINIO_NOTIFY_AMQP_ROUTING_KEY

Specify the routing key for publishing events.

This variable corresponds to the notify_amqp routing_key configuration setting.

MINIO_NOTIFY_AMQP_MANDATORY

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

This variable corresponds to the notify_amqp mandatory configuration setting.

MINIO_NOTIFY_AMQP_DURABLE

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

This variable corresponds to the notify_amqp durable configuration setting.

MINIO_NOTIFY_AMQP_NO_WAIT

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

This variable corresponds to the notify_amqp no_wait configuration setting.

MINIO_NOTIFY_AMQP_INTERNAL

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.

This variable corresponds to the notify_amqp internal configuration setting.

MINIO_NOTIFY_AMQP_AUTO_DELETED

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

This variable corresponds to the notify_amqp auto_deleted configuration setting.

MINIO_NOTIFY_AMQP_DELIVERY_MODE

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

Specify 2 to set the delivery mode to persistent queue.

This variable corresponds to the notify_amqp delivery_mode configuration setting.

MINIO_NOTIFY_AMQP_QUEUE_DIR

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.

This variable corresponds to the notify_amqp queue_dir configuration setting.

MINIO_NOTIFY_AMQP_QUEUE_LIMIT

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

This variable corresponds to the notify_amqp queue_limit configuration setting.

MINIO_NOTIFY_AMQP_COMMENT

Specify a comment for the AMQP configuration.

This variable corresponds to the notify_amqp comment configuration setting.

MQTT Service for Bucket Notifications

The following section documents environment variables for configuring an MQTT service as a target for MinIO Bucket Notifications. See Publish Events to MQTT for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_MQTT_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_MQTT_BROKER_PRIMARY="tcp://user:password@mqtt-endpoint.example.net:1883"

set MINIO_NOTIFY_MQTT_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_MQTT_BROKER_SECONDARY="tcp://user:password@mqtt-endpoint.example.net:1883"

For example, MINIO_NOTIFY_MQTT_ENABLE_PRIMARY indicates the environment variable is associated to an MQTT service endpoint with ID of PRIMARY.

MINIO_NOTIFY_MQTT_ENABLE

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

Defaults to off.

This variable corresponds to the notify_mqtt configuration setting.

MINIO_NOTIFY_MQTT_BROKER

Required

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

This variable corresponds to the notify_mqtt broker configuration setting.

MINIO_NOTIFY_MQTT_TOPIC

Required

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

This variable corresponds to the notify_mqtt topic configuration setting.

MINIO_NOTIFY_MQTT_USERNAME

Required if the MQTT server/broker enforces authentication/authorization

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

This variable corresponds to the notify_mqtt username configuration setting.

MINIO_NOTIFY_MQTT_PASSWORD

Required if the MQTT server/broker enforces authentication/authorization

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

This variable corresponds to the notify_mqtt password configuration setting.

MINIO_NOTIFY_MQTT_QOS

Specify the Quality of Service priority for the published events.

Defaults to 0.

This variable corresponds to the notify_mqtt qos configuration setting.

MINIO_NOTIFY_MQTT_KEEP_ALIVE_INTERVAL

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”

This variable corresponds to the notify_mqtt keep_alive_interval configuration setting.

MINIO_NOTIFY_MQTT_RECONNECT_INTERVAL

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”

This variable corresponds to the notify_mqtt reconnect_interval configuration setting.

MINIO_NOTIFY_MQTT_QUEUE_DIR

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.

This variable corresponds to the notify_mqtt queue_dir configuration setting.

MINIO_NOTIFY_MQTT_QUEUE_LIMIT

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

This variable corresponds to the notify_mqtt queue_limit configuration setting.

MINIO_NOTIFY_MQTT_COMMENT

Specify a comment to associate with the MQTT configuration.

This variable corresponds to the notify_mqtt comment configuration setting.

Elasticsearch Service for Bucket Notifications

The following section documents environment variables for configuring an Elasticsearch service as a target for MinIO Bucket Notifications. See Publish Events to Elasticsearch for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_ELASTICSEARCH_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_ELASTICSEARCH_URL_PRIMARY="https://user:password@elasticsearch-endpoint.example.net:9200"
set MINIO_NOTIFY_ELASTICSEARCH_INDEX_PRIMARY="bucketevents"
set MINIO_NOTIFY_ELASTICSEARCH_FORMAT_PRIMARY="namespace"

set MINIO_NOTIFY_ELASTICSEARCH_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_ELASTICSEARCH_URL_SECONDARY="https://user:password@elasticsearch-endpoint.example.net:9200"
set MINIO_NOTIFY_ELASTICSEARCH_INDEX_SECONDARY="bucketevents"
set MINIO_NOTIFY_ELASTICSEARCH_FORMAT_SECONDARY="namespace"
MINIO_NOTIFY_ELASTICSEARCH_ENABLE

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

Defaults to off.

Requires specifying the following additional environment variables if set to on:

This variable corresponds to the notify_elasticsearch configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_URL

Required

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.

This variable corresponds to the notify_elasticsearch url configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_INDEX

Required

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.

This variable corresponds to the notify_elasticsearch index configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_FORMAT

Required

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.

This variable corresponds to the notify_elasticsearch format configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_USERNAME

Optional

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

This variable corresponds to the notify_elasticsearch username configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_PASSWORD

Optional

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

This variable corresponds to the notify_elasticsearch password configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_QUEUE_DIR

Optional

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.

This variable corresponds to the notify_elasticsearch queue_dir configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_QUEUE_LIMIT

Optional

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

This variable corresponds to the notify_elasticsearch queue_limit configuration setting.

MINIO_NOTIFY_ELASTICSEARCH_COMMENT

Optional

Specify a comment to associate with the Elasticsearch configuration.

This variable corresponds to the notify_elasticsearch comment configuration setting.

NSQ Service for Bucket Notifications

The following section documents environment variables for configuring an NSQ service as a target for MinIO Bucket Notifications. See Publish Events to NSQ for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_NSQ_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_NSQ_NSQD_ADDRESS_PRIMARY="https://user:password@nsq-endpoint.example.net:9200"
set MINIO_NOTIFY_NSQ_TOPIC_PRIMARY="bucketevents"

set MINIO_NOTIFY_NSQ_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_NSQ_NSQD_ADDRESS_SECONDARY="https://user:password@nsq-endpoint.example.net:9200"
set MINIO_NOTIFY_NSQ_TOPIC_SECONDARY="bucketevents"
MINIO_NOTIFY_NSQ_ENABLE

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

This variable corresponds to the notify_nsq configuration setting.

MINIO_NOTIFY_NSQ_NSQD_ADDRESS

Required

Specify the NSQ server address. For example:

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

This variable corresponds to the notify_nsq nsqd_address configuration setting.

MINIO_NOTIFY_NSQ_TOPIC

Required

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

This variable corresponds to the notify_nsq topic configuration setting.

MINIO_NOTIFY_NSQ_TLS

Optional

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

This variable corresponds to the notify_nsq tls configuration setting.

MINIO_NOTIFY_NSQ_TLS_SKIP_VERIFY

Optional

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.

This variable corresponds to the notify_nsq tls_skip_verify configuration setting.

MINIO_NOTIFY_NSQ_QUEUE_DIR

Optional

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.

This variable corresponds to the notify_nsq queue_dir configuration setting.

MINIO_NOTIFY_NSQ_QUEUE_LIMIT

Optional

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

This variable corresponds to the notify_nsq queue_limit configuration setting.

MINIO_NOTIFY_NSQ_COMMENT

Optional

Specify a comment to associate with the NSQ configuration.

This variable corresponds to the notify_nsq comment configuration setting.

Redis Service for Bucket Notifications

The following section documents environment variables for configuring an Redis service as a target for MinIO Bucket Notifications. See Publish Events to Redis for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_REDIS_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_REDIS_REDIS_ADDRESS_PRIMARY="https://user:password@redis-endpoint.example.net:9200"
set MINIO_NOTIFY_REDIS_KEY_PRIMARY="bucketevents"
set MINIO_NOTIFY_REDIS_FORMAT_PRIMARY="namespace"


set MINIO_NOTIFY_REDIS_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_REDIS_REDIS_ADDRESS_SECONDARY="https://user:password@redis-endpoint.example.net:9200"
set MINIO_NOTIFY_REDIS_KEY_SECONDARY="bucketevents"
set MINIO_NOTIFY_REDIS_FORMAT_SECONDARY="namespace"
MINIO_NOTIFY_REDIS_ENABLE

Required

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

Defaults to off.

Requires specifying the following additional environment variables if set to on:

This variable corresponds to the notify_redis configuration setting.

MINIO_NOTIFY_REDIS_ADDRESS

Required

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

This variable corresponds to the notify_redis address configuration setting.

MINIO_NOTIFY_REDIS_KEY

Required

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

This variable corresponds to the notify_redis key configuration setting.

MINIO_NOTIFY_REDIS_FORMAT

Required

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.

This variable corresponds to the notify_redis format configuration setting.

MINIO_NOTIFY_REDIS_PASSWORD

Optional

Specify the password for the Redis server.

This variable corresponds to the notify_redis password configuration setting.

MINIO_NOTIFY_REDIS_QUEUE_DIR

Optional

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.

This variable corresponds to the notify_redis queue_dir configuration setting.

MINIO_NOTIFY_REDIS_QUEUE_LIMIT

Optional

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

This variable corresponds to the notify_redis queue_limit configuration setting.

MINIO_NOTIFY_REDIS_COMMENT

Optional

Specify a comment to associate with the Redis configuration.

This variable corresponds to the notify_redis comment configuration setting.

NATS Service for Bucket Notifications

The following section documents environment variables for configuring an NATS service as a target for MinIO Bucket Notifications. See Publish Events to NATS for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="https://nats-endpoint.example.net:4222"
set MINIO_NOTIFY_NATS_SUBJECT="minioevents"

set MINIO_NOTIFY_NATS_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_NATS_ADDRESS_SECONDARY="https://nats-endpoint.example.net:4222"
set MINIO_NOTIFY_NATS_SUBJECT="minioevents"

For example, MINIO_NOTIFY_NATS_ENABLE_PRIMARY indicates the environment variable is associated to an NATS service endpoint with ID of PRIMARY.

MINIO_NOTIFY_NATS_ENABLE

Required

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

Defaults to off.

This environment variable corresponds with the notify_nats configuration setting.

MINIO_NOTIFY_NATS_ADDRESS

Required

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

This environment variable corresponds with the notify_nats address configuration setting.

MINIO_NOTIFY_NATS_SUBJECT

Required

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

This environment variable corresponds with the notify_nats subject configuration setting.

MINIO_NOTIFY_NATS_USERNAME

Optional

Specify the username for connecting to the NATS service endpoint.

This environment variable corresponds with the notify_nats username configuration setting.

MINIO_NOTIFY_NATS_PASSWORD

Optional

Specify the passport for connecting to the NATS service endpoint.

This environment variable corresponds with the notify_nats password configuration setting.

MINIO_NOTIFY_NATS_TOKEN

Optional

Specify the token for connecting to the NATS service endpoint.

This environment variable corresponds with the notify_nats token configuration setting.

MINIO_NOTIFY_NATS_TLS

Optional

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

This environment variable corresponds with the notify_nats tls configuration setting.

MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY

Optional

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.

This environment variable corresponds with the notify_nats tls_skip_verify configuration setting.

MINIO_NOTIFY_NATS_PING_INTERVAL

Optional

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"

This environment variable corresponds with the notify_nats ping_interval configuration setting.

MINIO_NOTIFY_NATS_STREAMING

Optional

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

This environment variable corresponds with the notify_nats streaming configuration setting.

MINIO_NOTIFY_NATS_STREAMING_ASYNC

Optional

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

This environment variable corresponds with the notify_nats streaming_async configuration setting.

MINIO_NOTIFY_NATS_STREAMING_MAX_PUB_ACKS_IN_FLIGHT

Optional

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

This environment variable corresponds with the notify_nats streaming_max_pub_acks_in_flight configuration setting.

MINIO_NOTIFY_NATS_STREAMING_CLUSTER_ID

Optional

Specify the unique ID for the NATS streaming cluster.

This environment variable corresponds with the notify_nats streaming_cluster_id configuration setting.

MINIO_NOTIFY_NATS_CERT_AUTHORITY

Optional

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

This environment variable corresponds with the notify_nats cert_authority configuration setting.

MINIO_NOTIFY_NATS_CLIENT_CERT

Optional

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

This environment variable corresponds with the notify_nats client_cert configuration setting.

MINIO_NOTIFY_NATS_CLIENT_KEY

Optional

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

This environment variable corresponds with the notify_nats client_key configuration setting.

MINIO_NOTIFY_NATS_QUEUE_DIR

Optional

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.

This environment variable corresponds with the notify_nats queue_dir configuration setting.

MINIO_NOTIFY_NATS_QUEUE_LIMIT

Optional

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

This environment variable corresponds with the notify_nats queue_limit configuration setting.

MINIO_NOTIFY_NATS_COMMENT

Optional

Specify a comment to associate with the NATS configuration.

This environment variable corresponds with the notify_nats comment configuration setting.

PostgreSQL Service for Bucket Notifications

The following section documents environment variables for configuring an POSTGRESQL service as a target for MinIO Bucket Notifications. See Publish Events to PostgreSQL for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_POSTGRESQL_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_POSTGRESQL_CONNECTION_STRING_PRIMARY="host=postgresql-endpoint.example.net port=4222..."
set MINIO_NOTIFY_POSTGRESQL_TABLE_PRIMARY="minioevents"
set MINIO_NOTIFY_POSTGRESQL_FORMAT_PRIMARY="namespace"

set MINIO_NOTIFY_POSTGRESQL_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_POSTGRESQL_CONNECTION_STRING_SECONDARY="host=postgresql-endpoint.example.net port=4222..."
set MINIO_NOTIFY_POSTGRESQL_TABLE_SECONDARY="minioevents"
set MINIO_NOTIFY_POSTGRESQL_FORMAT_SECONDARY="namespace"

For example, MINIO_NOTIFY_POSTGRESQL_ENABLE_PRIMARY indicates the environment variable is associated to an PostgreSQL service endpoint with ID of PRIMARY.

MINIO_NOTIFY_POSTGRESQL_ENABLE

Required

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

Defaults to off.

Requires specifying the following additional environment variables if set to on:

This environment variable corresponds with the notify_postgresql configuration setting.

MINIO_NOTIFY_POSTGRESQL_CONNECTION_STRING

Required

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 .

This environment variable corresponds with the notify_postgresql connection_string configuration setting.

MINIO_NOTIFY_POSTGRESQL_TABLE

Required

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

This environment variable corresponds with the notify_postgresql table configuration setting.

MINIO_NOTIFY_POSTGRESQL_FORMAT

Required

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.

This environment variable corresponds with the notify_postgresql format configuration setting.

MINIO_NOTIFY_POSTGRESQL_MAX_OPEN_CONNECTIONS

Optional

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

Defaults to 2.

This environment variable corresponds with the notify_postgresql max_open_connections configuration setting.

MINIO_NOTIFY_POSTGRESQL_QUEUE_DIR

Optional

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.

This environment variable corresponds with the notify_postgresql queue_dir configuration setting.

MINIO_NOTIFY_POSTGRESQL_QUEUE_LIMIT

Optional

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

This environment variable corresponds with the notify_postgresql queue_limit configuration setting.

MINIO_NOTIFY_POSTGRESQL_COMMENT

Optional

Specify a comment to associate with the PostgreSQL configuration.

This environment variable corresponds with the notify_postgresql comment configuration setting.

MySQL Service for Bucket Notifications

The following section documents environment variables for configuring an MYSQL service as a target for MinIO Bucket Notifications. See Publish Events to MySQL for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_MYSQL_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_MYSQL_DSN_STRING_PRIMARY="username:password@tcp(mysql.example.com:3306)/miniodb"
set MINIO_NOTIFY_MYSQL_TABLE_PRIMARY="minioevents"
set MINIO_NOTIFY_MYSQL_FORMAT_PRIMARY="namespace"

set MINIO_NOTIFY_MYSQL_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_MYSQL_DSN_STRING_SECONDARY="username:password@tcp(mysql.example.com:3306)/miniodb"
set MINIO_NOTIFY_MYSQL_TABLE_SECONDARY="minioevents"
set MINIO_NOTIFY_MYSQL_FORMAT_SECONDARY="namespace"

For example, MINIO_NOTIFY_MYSQL_ENABLE_PRIMARY indicates the environment variable is associated to an MySQL service endpoint with ID of PRIMARY.

MINIO_NOTIFY_MYSQL_ENABLE

Required

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

Defaults to off.

Requires specifying the following additional environment variables if set to on:

This environment variable corresponds with the notify_mysql configuration setting.

MINIO_NOTIFY_MYSQL_DSN_STRING

Required

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"

This environment variable corresponds with the notify_mysql dsn_string configuration setting.

MINIO_NOTIFY_MYSQL_TABLE

Required

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

This environment variable corresponds with the notify_mysql table configuration setting.

MINIO_NOTIFY_MYSQL_FORMAT

Required

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.

This environment variable corresponds with the notify_mysql format configuration setting.

MINIO_NOTIFY_MYSQL_MAX_OPEN_CONNECTIONS

Optional

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

Defaults to 2.

This environment variable corresponds with the notify_mysql max_open_connections configuration setting.

MINIO_NOTIFY_MYSQL_QUEUE_DIR

Optional

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.

This environment variable corresponds with the notify_mysql queue_dir configuration setting.

MINIO_NOTIFY_MYSQL_QUEUE_LIMIT

Optional

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

This environment variable corresponds with the notify_mysql queue_limit configuration setting.

MINIO_NOTIFY_MYSQL_COMMENT

Optional

Specify a comment to associate with the MySQL configuration.

This environment variable corresponds with the notify_mysql comment configuration setting.

Kafka Service for Bucket Notifications

The following section documents environment variables for configuring an Kafka service as a target for MinIO Bucket Notifications. See Publish Events to Kafka for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_KAFKA_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_KAFKA_BROKERS_PRIMARY="https://kafka1.example.net:9200, https://kafka2.example.net:9200"

set MINIO_NOTIFY_KAFKA_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_KAFKA_BROKERS_SECONDARY="https://kafka1.example.net:9200, https://kafka2.example.net:9200"
MINIO_NOTIFY_KAFKA_ENABLE

Required

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

Defaults to off.

MINIO_NOTIFY_KAFKA_BROKERS

Required

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

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

This environment variable corresponds to the notify_kafka brokers configuration setting.

MINIO_NOTIFY_KAFKA_TOPIC

Optional

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

This environment variable corresponds to the notify_kafka topic configuration setting.

MINIO_NOTIFY_KAFKA_SASL_USERNAME

Optional

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

This environment variable corresponds to the notify_kafka sasl_username configuration setting.

MINIO_NOTIFY_KAFKA_SASL_PASSWORD

Optional

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

This environment variable corresponds to the notify_kafka sasl_password configuration setting.

MINIO_NOTIFY_KAFKA_SASL_MECHANISM

Optional

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

  • PLAIN (Default)

  • SCRAM

This environment variable corresponds to the notify_kafka sasl_mechanism configuration setting.

MINIO_NOTIFY_KAFKA_TLS_CLIENT_AUTH

Optional

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

This environment variable corresponds to the notify_kafka tls_client_auth configuration setting.

MINIO_NOTIFY_KAFKA_SASL

Optional

-username

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

This environment variable corresponds to the notify_kafka sasl configuration setting.

MINIO_NOTIFY_KAFKA_TLS

Optional

-client-auth

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

This environment variable corresponds to the notify_kafka tls configuration setting.

MINIO_NOTIFY_KAFKA_TLS_SKIP_VERIFY

Optional

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.

This environment variable corresponds to the notify_kafka tls_skip_verify configuration setting.

MINIO_NOTIFY_KAFKA_CLIENT_TLS_CERT

Optional

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

This environment variable corresponds to the notify_kafka client_tls_cert configuration setting.

MINIO_NOTIFY_KAFKA_CLIENT_TLS_KEY

Optional

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

This environment variable corresponds to the notify_kafka client_tls_key configuration setting.

MINIO_NOTIFY_KAFKA_VERSION

Optional

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.

This environment variable corresponds to the notify_kafka version configuration setting.

MINIO_NOTIFY_KAFKA_QUEUE_DIR

Optional

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.

This environment variable corresponds to the notify_kafka queue_dir configuration setting.

MINIO_NOTIFY_KAFKA_QUEUE_LIMIT

Optional

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

This environment variable corresponds to the notify_kafka queue_limit configuration setting.

MINIO_NOTIFY_KAFKA_COMMENT

Optional

Specify a comment to associate with the Kafka configuration.

This environment variable corresponds to the notify_kafka comment configuration setting.

Webhook Service for Bucket Notifications

The following section documents environment variables for configuring an Webhook service as a target for MinIO Bucket Notifications. See Publish Events to Webhook for a tutorial on using these environment variables.

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

set MINIO_NOTIFY_WEBHOOK_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_WEBHOOK_ENDPOINT_PRIMARY="https://webhook1.example.net"

set MINIO_NOTIFY_WEBHOOK_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_WEBHOOK_ENDPOINT_SECONDARY="https://webhook1.example.net"
MINIO_NOTIFY_WEBHOOK_ENABLE

Required

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

Defaults to off.

MINIO_NOTIFY_WEBHOOK_ENDPOINT

Required

Specify the URL for the webhook service.

This environment variable corresponds with the notify_webhook endpoint configuration setting.

MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN

Required

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

This environment variable corresponds with the notify_webhook auth_token configuration setting.

MINIO_NOTIFY_WEBHOOK_QUEUE_DIR

Optional

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.

This environment variable corresponds with the notify_webhook queue_dir configuration setting.

MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT

Optional

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

This environment variable corresponds with the notify_webhook queue_limit configuration setting.

MINIO_NOTIFY_WEBHOOK_CLIENT_CERT

Optional

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

This environment variable corresponds with the notify_webhook client_cert configuration setting.

MINIO_NOTIFY_WEBHOOK_CLIENT_KEY

Optional

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

This environment variable corresponds with the notify_webhook client_key configuration setting.

MINIO_NOTIFY_WEBHOOK_COMMENT

Optional

Specify a comment to associate with the Webhook configuration.

This environment variable corresponds with the notify_webhook comment configuration setting.