============ MinIO Server ============ .. default-domain:: minio .. contents:: Table of Contents :local: :depth: 2 .. mc:: minio MinIO Server ------------ The :mc:`minio server` command starts the MinIO server process: .. code-block:: shell :class: copyable minio server /mnt/disk{1...4} For examples of deploying :mc:`minio server` on a bare metal environment, see :ref:`minio-installation`. For examples of deploying :mc:`minio server` on a Kubernetes environment, see :ref:`Deploying a MinIO Tenant `. .. admonition:: AGPLv3 :class: note :program:`minio server` is :minio-git:`AGPLv3 ` licensed Free and Open Source (FOSS) software. Applications integrating :program:`mc` may trigger AGPLv3 compliance requirements. `MinIO Commercial Licensing `__ is the best option for applications which trigger AGPLv3 obligations where open-sourcing the application is not an option. Configuration Settings ~~~~~~~~~~~~~~~~~~~~~~ The :mc:`minio server` process stores its configuration in the storage backend :mc-cmd:`directory `. You can modify configuration options using the :mc:`mc admin config` command. Syntax ~~~~~~~ .. mc:: minio server Starts the ``minio`` server process. The command has the following syntax: .. code-block:: shell :class: copyable minio server [FLAGS] HOSTNAME/DIRECTORIES [HOSTNAME/DIRECTORIES..] The command accepts the following arguments: .. mc-cmd:: HOSTNAME The hostname of a :mc:`minio server` process. For standalone deployments, this field is *optional*. You can start a standalone :mc:`~minio server` process with only the :mc-cmd:`~minio server DIRECTORIES` argument. For distributed deployments, specify the hostname of each :mc:`minio server` in the deployment. The group of :mc:`minio server` processes represent a single :ref:`Server Pool `. :mc-cmd:`~minio server HOSTNAME` supports MinIO expansion notation ``{x...y}`` to denote a sequential series of hostnames. MinIO *requires* sequential hostnames to identify each :mc:`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 :mc:`minio server` command with the *same* combination of :mc-cmd:`~minio server HOSTNAME` and :mc-cmd:`~minio server 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 :ref:`Server Pool `. .. mc-cmd:: DIRECTORIES :required: The directories or drives the :mc:`minio server` process uses as the storage backend. :mc-cmd:`~minio server 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 :mc-cmd:`~minio server DIRECTORIES` path(s) *must* be empty when first starting the :mc:`minio ` process. The :mc:`minio server` process requires *at least* 4 drives or directories to enable :ref:`erasure coding `. .. important:: MinIO recommends locally-attached drives, where the :mc-cmd:`~minio server DIRECTORIES` path points to each drive 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. .. mc-cmd:: --address :optional: Binds the :mc:`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. .. versionchanged:: RELEASE.2023-01-02T09-40-09Z You can configure your hosts file to have MinIO only listen on specific IPs. For example, if the machine's `/etc/hosts` file contains the following: .. code-block:: shell 127.0.1.1 minioip 127.0.1.2 minioip A command like the following would listen for API calls on port ``9000`` on both configured IP addresses. .. code-block:: shell minio server --address "minioip:9000" ~/miniodirectory If omitted, :mc:`minio ` binds to port ``9000`` on all configured IP addresses or hostnames on the host machine. .. mc-cmd:: --console-address :optional: Specifies a static port for the embedded MinIO Console. Omit to direct MinIO to generate a dynamic port at server startup. The MinIO server outputs the port to the system log. .. mc-cmd:: --ftp :optional: Enable and configure a File Transfer Protocol (``FTP``) or File Transfer Protocol over SSL/TLS (``FTPS``) server. Use this flag multiple times to specify an address port, a passive port range of addresses, or a TLS certificate and key as key-value pairs. Valid keys: - ``address``, which takes a single port to use for the server, typically ``8021`` - _(Optional)_ ``passive-port-range``, which restricts the range of potential ports the server can use to transfer data, such as when tight firewall rules limit the port the FTP server can request for the connection - _(Optional)_ ``tls-private-key``, which takes the path to the user's private key for accessing the MinIO deployment by TLS Use with ``tls-public-cert``. - _(Optional)_ ``tls-public-cert``, which takes the path to the certificate for accessing the MinIO deployment by TLS Use with ``tls-private-key``. For MinIO deployments with TLS enabled, omit ``tls-private-key`` and ``tls-public-key`` to direct MinIO to use the default TLS keys for the MinIO deployment. See :ref:`minio-tls` for more information. You only need to specify a certificate and private key to a different set of TLS certificate and key than the MinIO default (for example, to use a different domain). For example: .. code-block:: shell :class: copyable minio server http://server{1...4}/disk{1...4} \ --ftp="address=:8021" \ --ftp="passive-port-range=30000-40000" \ --ftp="tls-private-key=path/to/private.key" \ --ftp="tls-public-cert=path/to/public.crt" \ ... .. mc-cmd:: --sftp :optional: Enable and configure a SSH File Transfer Protocol (``SFTP``) server. Use multiple times to specify an address port and the path to the ssh private key to use as key-value pairs. Valid keys: - ``address``, which takes a single port to use for the server, typically ``8022`` - ``ssh-private-key``, which takes the path to the user's private key file For example: .. code-block:: shell :class: copyable minio server http://server{1...4}/disk{1...4} \ --sftp="address=:8022" --sftp="ssh-private-key=/home/miniouser/.ssh/id_rsa" \ ... .. mc-cmd:: --certs-dir, -S :optional: Specifies the path to the folder containing certificates the :mc:`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 :ref:`minio-TLS` for more information on TLS/SSL connectivity. .. mc-cmd:: --quiet :optional: Disables startup information. .. mc-cmd:: --anonymous :optional: Hides sensitive information from logging. .. mc-cmd:: --json :optional: Outputs server logs and startup information in ``JSON`` format. .. _minio-server-environment-variables: Environment Variables --------------------- The :mc:`minio server` processes uses the following environment variables during startup to set configuration settings. Core Configuration ~~~~~~~~~~~~~~~~~~ .. envvar:: MINIO_VOLUMES The directories or drives the :mc:`minio server` process uses as the storage backend. Functionally equivalent to setting :mc-cmd:`minio server DIRECTORIES`. Use this value when configuring MinIO to run using an environment file. .. envvar:: MINIO_CONFIG_ENV_FILE Specifies the full path to the file the MinIO server process uses for loading environment variables. .. envvar:: MINIO_ILM_EXPIRY_WORKERS Specifies the number of workers to make available to expire objects configured with ILM rules for expiration. When not set, MinIO defaults to using up to half of the available processing cores available. Root Credentials ~~~~~~~~~~~~~~~~ .. envvar:: MINIO_ROOT_USER The access key for the :ref:`root ` user. .. warning:: If :envvar:`MINIO_ROOT_USER` is unset, :mc:`minio` defaults to ``minioadmin``. **NEVER** use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random :envvar:`MINIO_ROOT_USER` value for all environments. .. envvar:: MINIO_ROOT_PASSWORD The secret key for the :ref:`root ` user. .. warning:: If :envvar:`MINIO_ROOT_PASSWORD` is unset, :mc:`minio` defaults to ``minioadmin``. **NEVER** use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random :envvar:`MINIO_ROOT_PASSWORD` value for all environments. .. envvar:: MINIO_API_ROOT_ACCESS .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-root-api-access :end-before: end-minio-root-api-access This variable corresponds to the :mc-conf:`api root_access ` configuration setting. You can use this variable to temporarily override the configuration setting and re-enable root access to the deployment. .. envvar:: MINIO_ACCESS_KEY .. deprecated:: RELEASE.2021-04-22T15-44-28Z The access key for the :ref:`root ` user. This environment variable is *deprecated* in favor of the :envvar:`MINIO_ROOT_USER` environment variable. .. warning:: If :envvar:`MINIO_ACCESS_KEY` is unset, :mc:`minio` defaults to ``minioadmin``. **NEVER** use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random :envvar:`MINIO_ACCESS_KEY` value for all environments. .. envvar:: MINIO_SECRET_KEY .. deprecated:: RELEASE.2021-04-22T15-44-28Z The secret key for the :ref:`root ` user. This environment variable is *deprecated* in favor of the :envvar:`MINIO_ROOT_PASSWORD` environment variable. .. warning:: If :envvar:`MINIO_SECRET_KEY` is unset, :mc:`minio` defaults to ``minioadmin``. **NEVER** use the default credentials in production environments. MinIO strongly recommends specifying a unique, long, and random :envvar:`MINIO_ACCESS_KEY` value for all environments. .. envvar:: MINIO_ACCESS_KEY_OLD .. deprecated:: RELEASE.2021-04-22T15-44-28Z To perform root credential rotation, modify the :envvar:`MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` environment variables. .. envvar:: MINIO_SECRET_KEY_OLD .. deprecated:: RELEASE.2021-04-22T15-44-28Z To perform root credential rotation, modify the :envvar:`MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` environment variables. MinIO Console ~~~~~~~~~~~~~ The following environment variables control behavior for the embedded MinIO Console: .. envvar:: MINIO_PROMETHEUS_URL *Optional* Specify the URL for a Prometheus service configured to :ref:`scrape MinIO metrics `. The MinIO Console populates the :guilabel:`Dashboard` with cluster metrics using the ``minio-job`` Prometheus scraping job. If you are using a standalone MinIO Console process, this variable corresponds to ``CONSOLE_PROMETHEUS_URL``. .. envvar:: MINIO_PROMETHEUS_JOB_ID *Optional* Specify the custom Prometheus job ID used for :ref:`scraping MinIO metrics `. MinIO defaults to ``minio-job``. If you are using a standalone MinIO Console process, this variable corresponds to ``CONSOLE_PROMETHEUS_JOB_ID``. .. envvar:: MINIO_LOG_QUERY_URL *Optional* Specify the URL of a PostgreSQL service to which MinIO writes :ref:`Audit logs `. The embedded MinIO Console provides a Log Search tool that allows querying the PostgreSQL service for collected logs. .. envvar:: MINIO_BROWSER *Optional* Specify ``off`` to disable the embedded MinIO Console. .. envvar:: MINIO_BROWSER_LOGIN_ANIMATION *Optional* .. versionadded:: MinIO Server RELEASE.2023-05-04T21-44-30Z Specify ``off`` to disable the animated login screen for the MinIO Console. Defaults to ``on``. .. envvar:: MINIO_BROWSER_REDIRECT_URL *Optional* Specify the URL the MinIO Console provides as the redirect URL to the configured :ref:`external identity manager `. This variable may be necessary for MinIO deployments behind a reverse proxy, load balancer, or similar technology where the internal hostname or IP structure is not reachable from the external network. For example, consider a MinIO deployment behind a proxy where ``https://minio.example.net`` redirects to the MinIO deployment on port ``:9000`` and ``https://console.minio.example.net`` redirects to the MinIO Console on port ``:9001``. By default, the MinIO Console use its *internal* hostname as part of the request. Set this variable to ``https://console.minio.example.net`` to ensure the external identity provider has a reachable URL to which to send the authentication response. .. envvar:: MINIO_SERVER_URL *Optional* Specify the Fully Qualified Domain Name (FQDN) the MinIO Console should use for connecting to the MinIO Server. This variable is typically only necessary when the MinIO Server TLS certificates do not contain an IP Subject Alternative Name (SAN) for the MinIO Server. Since the Console uses the MinIO Server IP by default, the Console may fail to connect due to the TLS certificate not having the necessary IP listed as a SAN. Key Management Service and Encryption ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. envvar:: MINIO_KMS_KES_ENDPOINT The endpoint for the MinIO Key Encryption Service (KES) process to use for supporting SSE-S3 and MinIO backend encryption operations. .. envvar:: MINIO_KMS_KES_KEY_FILE The private key associated to the the :envvar:`MINIO_KMS_KES_CERT_FILE` x.509 certificate to use when authenticating to the KES server. The KES server requires clients to present their certificate for performing mutual TLS (mTLS). See the :minio-git:`KES wiki ` for more complete documentation on KES access control. .. envvar:: MINIO_KMS_KES_CERT_FILE The x.509 certificate to present to the KES server. The KES server requires clients to present their certificate for performing mutual TLS (mTLS). The KES server computes an :minio-git:`identity ` from the certificate and compares it to its configured policies. The KES server grants the :mc:`minio` server access to only those operations explicitly granted by the policy. See the :minio-git:`KES wiki ` for more complete documentation on KES access control. .. envvar:: MINIO_KMS_KES_KEY_NAME The name of an external key on the Key Management system (KMS) configured on the KES server and used for performing en/decryption operations. MinIO uses this key for the following: - Encrypting backend data ( :ref:`IAM `, server configuration). - The default encryption key for Server-Side Encryption with :ref:`SSE-KMS `. - The encryption key for Server-Side Encryption with :ref:`SSE-S3 `. .. envvar:: MINIO_KMS_KES_ENCLAVE Use this optional environment variable to define the name of a KES enclave. A KES enclave provides an isolated space for its associated keys separate from other enclaves on a stateful KES server. If not set, MinIO does not send enclave information. For a stateful KES server, this results in using the default enclave. .. _minio-server-envvar-storage-class: Storage Class ~~~~~~~~~~~~~ These environment variables configure the :ref:`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. .. envvar:: MINIO_STORAGE_CLASS_STANDARD The number of :ref:`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 :ref:`Erasure Coding ` enabled. The minimum value at startup is ``0``. 0 parity setups have no erasure coding protections and rely entirely on the storage controller or resource for availability / resiliency. The maximum value is 1/2 the erasure set stripe size. For example, a deployment with erasure set stripe size of 16 has a maximum standard parity of 8. You can change the Standard parity after startup to a value between ``1`` and :math:`\tfrac{1}{2}\ (ERASURE_SET_SIZE)`. MinIO only applies the changed parity to newly written objects. Existing objects retain the parity value in place at the time of their creation. Defaults to ``4``. .. envvar:: MINIO_STORAGE_CLASS_RRS The number of :ref:`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 :ref:`Erasure Coding ` enabled. Defaults to ``2``. .. envvar:: MINIO_STORAGE_CLASS_COMMENT Adds a comment to the storage class settings. .. _minio-server-envvar-metrics-logging: Metrics and Logging ~~~~~~~~~~~~~~~~~~~ These environment variables control behavior related to MinIO metrics and logging. See :ref:`minio-metrics-and-alerts` for more information. .. envvar:: MINIO_PROMETHEUS_AUTH_TYPE Specifies the authentication mode for the Prometheus :ref:`scraping endpoints `. - ``jwt`` - *Default* MinIO requires that the scraping client specify a JWT token for authenticating requests. Use :mc-cmd:`mc admin prometheus generate` to generate the necessary JWT bearer tokens. - ``public`` MinIO does not require that scraping clients authenticate their requests. Logging ~~~~~~~ These environment variables configure publishing regular :mc:`minio server` logs and audit logs to an HTTP webhook. See :ref:`minio-logging` for more complete documentation. - :ref:`minio-sever-envvar-logging-regular` - :ref:`minio-sever-envvar-logging-audit` .. _minio-sever-envvar-logging-regular: Server Logs +++++++++++ The following section documents environment variables for configuring MinIO to publish :mc:`minio server` logs to an HTTP webhook endpoint. See :ref:`minio-logging-publish-server-logs` for more complete documentation and tutorials on using these environment variables. You can specify multiple webhook endpoints as log targets by appending a unique identifier ``_ID`` for each set of related logging environment variables. For example, the following command set two distinct server logs webhook endpoints: .. code-block:: shell :class: copyable export MINIO_LOGGER_WEBHOOK_ENABLE_PRIMARY="on" export MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_PRIMARY="TOKEN" export MINIO_LOGGER_WEBHOOK_ENDPOINT_PRIMARY="http://webhook-1.example.net" export MINIO_LOGGER_WEBHOOK_ENABLE_SECONDARY="on" export MINIO_LOGGER_WEBHOOK_AUTH_TOKEN_SECONDARY="TOKEN" export MINIO_LOGGER_WEBHOOK_ENDPOINT_SECONDARY="http://webhook-2.example.net" .. envvar:: MINIO_LOGGER_WEBHOOK_ENABLE Specify ``"on"`` to enable publishing :mc:`minio server` logs to the HTTP webhook endpoint. Requires specifying :envvar:`MINIO_LOGGER_WEBHOOK_ENDPOINT`. This variable corresponds to setting the top-level :mc-conf:`logger_webhook` configuration setting. .. envvar:: MINIO_LOGGER_WEBHOOK_ENDPOINT The HTTP endpoint of the webhook. This variable corresponds to the :mc-conf:`logger_webhook endpoint ` configuration setting. .. envvar:: MINIO_LOGGER_WEBHOOK_AUTH_TOKEN *Optional* The JSON Web Token (JWT) to use for authenticating to the HTTP webhook. Omit for webhooks which do not enforce authentication. This variable corresponds to the :mc-conf:`logger_webhook auth_token ` configuration setting. .. envvar:: MINIO_LOGGER_WEBHOOK_CLIENT_CERT *Optional* The path to the mTLS certificate to use for authenticating to the webhook logger. Requires specifying :envvar:`MINIO_LOGGER_WEBHOOK_CLIENT_KEY`. This variable corresponds to the :mc-conf:`logger_webhook client_cert ` configuration setting. .. envvar:: MINIO_LOGGER_WEBHOOK_CLIENT_KEY *Optional* The path to the mTLS certificate key to use to authenticate with the webhook logger service. Requires specifying :envvar:`MINIO_LOGGER_WEBHOOK_CLIENT_CERT`. This variable corresponds to the :mc-conf:`logger_webhook client_key ` configuration setting. .. envvar:: MINIO_LOGGER_WEBHOOK_PROXY *Optional* Define a proxy to use for the webhook logger when communicating from MinIO to external webhooks. This variable corresponds to the :mc-conf:`logger_webhook proxy ` configuration setting. .. envvar:: MINIO_LOGGER_WEBHOOK_QUEUE_DIR .. versionadded:: RELEASE.2023-05-18T00-05-36Z *Optional* Specify the directory path, such as ``/opt/minio/events``, to enable MinIO's persistent event store for undelivered messages. The MinIO process must have read, write, and list access on the specified directory. MinIO stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes. This variable corresponds to the :mc-conf:`logger_webhook queue_dir ` configuration setting. .. envvar:: MINIO_LOGGER_WEBHOOK_QUEUE_SIZE *Optional* An integer value to use for the queue size for logger webhook targets. This variable corresponds to the :mc-conf:`logger_webhook queue_size ` configuration setting. .. _minio-sever-envvar-logging-audit: Audit Logs ++++++++++ The following section documents environment variables for configuring MinIO to publish audit logs to an HTTP webhook endpoint. See :ref:`minio-logging-publish-audit-logs` for more complete documentation and tutorials on using these environment variables. You can specify multiple webhook endpoints as audit log targets by appending a unique identifier ``_ID`` for each set of related logging environment variables. For example, the following command set two distinct audit log webhook endpoints: .. code-block:: shell :class: copyable export MINIO_AUDIT_WEBHOOK_ENABLE_PRIMARY="on" export MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_PRIMARY="TOKEN" export MINIO_AUDIT_WEBHOOK_ENDPOINT_PRIMARY="http://webhook-1.example.net" export MINIO_AUDIT_WEBHOOK_CLIENT_CERT_SECONDARY="/tmp/cert.pem" export MINIO_AUDIT_WEBHOOK_CLIENT_KEY_SECONDARY="/tmp/key.pem" export MINIO_AUDIT_WEBHOOK_ENABLE_SECONDARY="on" export MINIO_AUDIT_WEBHOOK_AUTH_TOKEN_SECONDARY="TOKEN" export MINIO_AUDIT_WEBHOOK_ENDPOINT_SECONDARY="http://webhook-1.example.net" export MINIO_AUDIT_WEBHOOK_CLIENT_CERT_SECONDARY="/tmp/cert.pem" export MINIO_AUDIT_WEBHOOK_CLIENT_KEY_SECONDARY="/tmp/key.pem" .. envvar:: MINIO_AUDIT_WEBHOOK_ENABLE Specify ``"on"`` to enable publishing audit logs to the HTTP webhook endpoint. Requires specifying :envvar:`MINIO_AUDIT_WEBHOOK_ENDPOINT`. This variable corresponds to setting the top-level :mc-conf:`audit_webhook` configuration setting. .. envvar:: MINIO_AUDIT_WEBHOOK_ENDPOINT The HTTP endpoint of the webhook. This variable corresponds to the :mc-conf:`audit_webhook endpoint ` configuration setting. .. envvar:: MINIO_AUDIT_WEBHOOK_AUTH_TOKEN *Optional* The JSON Web Token (JWT) to use for authenticating to the HTTP webhook. Omit for webhooks which do not enforce authentication. This variable corresponds to the :mc-conf:`audit_webhook auth_token ` configuration setting. .. envvar:: MINIO_AUDIT_WEBHOOK_CLIENT_CERT *Optional* The x.509 client certificate to present to the HTTP webhook. Omit for webhooks which do not require clients to present a known TLS certificate. Requires specifying :envvar:`MINIO_AUDIT_WEBHOOK_CLIENT_KEY`. This variable corresponds to the :mc-conf:`audit_webhook client_cert ` configuration setting. .. envvar:: MINIO_AUDIT_WEBHOOK_CLIENT_KEY *Optional* The x.509 private key to present to the HTTP webhook. Omit for webhooks which do not require clients to present a known TLS certificate. Requires specifying :envvar:`MINIO_AUDIT_WEBHOOK_CLIENT_CERT`. This variable corresponds to the :mc-conf:`audit_webhook client_key ` configuration setting. .. envvar:: MINIO_AUDIT_WEBHOOK_QUEUE_DIR .. versionadded:: RELEASE.2023-05-18T00-05-36Z *Optional* Specify the directory path, such as ``/opt/minio/events``, to enable MinIO's persistent event store for undelivered messages. The MinIO process must have read, write, and list access on the specified directory. MinIO stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes. This variable corresponds to the :mc-conf:`audit_webhook queue_dir ` configuration setting. .. envvar:: MINIO_AUDIT_WEBHOOK_QUEUE_SIZE *Optional* An integer value to use for the queue size for audit webhook targets. This variable corresponds to the :mc-conf:`audit_webhook queue_size ` configuration setting. Bucket Notifications ~~~~~~~~~~~~~~~~~~~~ These environment variables configure notification targets for use with :ref:`MinIO Bucket Notifications `: - :ref:`minio-server-envvar-bucket-notification-amqp` - :ref:`minio-server-envvar-bucket-notification-mqtt` - :ref:`minio-server-envvar-bucket-notification-elasticsearch` - :ref:`minio-server-envvar-bucket-notification-nsq` - :ref:`minio-server-envvar-bucket-notification-redis` - :ref:`minio-server-envvar-bucket-notification-postgresql` - :ref:`minio-server-envvar-bucket-notification-mysql` - :ref:`minio-server-envvar-bucket-notification-kafka` - :ref:`minio-server-envvar-bucket-notification-webhook` .. _minio-server-envvar-bucket-notification-amqp: AMQP Service for Bucket Notifications +++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an AMQP service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-amqp` 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: .. code-block:: shell :class: copyable 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, :envvar:`MINIO_NOTIFY_AMQP_ENABLE_PRIMARY ` indicates the environment variable is associated to an AMQP service endpoint with ID of ``PRIMARY``. .. envvar:: MINIO_NOTIFY_AMQP_ENABLE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-enable :end-before: end-minio-notify-amqp-enable Requires specifying :envvar:`MINIO_NOTIFY_AMQP_URL` if set to ``on``. .. envvar:: MINIO_NOTIFY_AMQP_URL .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-url :end-before: end-minio-notify-amqp-url This field is *required* if :envvar:`MINIO_NOTIFY_AMQP_ENABLE` is ``on``. All other AMQP-related variables are optional. This variable corresponds to the :mc-conf:`notify_amqp url ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_EXCHANGE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-exchange :end-before: end-minio-notify-amqp-exchange This variable corresponds to the :mc-conf:`notify_amqp exchange ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_EXCHANGE_TYPE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-exchange-type :end-before: end-minio-notify-amqp-exchange-type This variable corresponds to the :mc-conf:`notify_amqp exchange_type ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_ROUTING_KEY .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-routing-key :end-before: end-minio-notify-amqp-routing-key This variable corresponds to the :mc-conf:`notify_amqp routing_key ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_MANDATORY .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-mandatory :end-before: end-minio-notify-amqp-mandatory This variable corresponds to the :mc-conf:`notify_amqp mandatory ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_DURABLE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-durable :end-before: end-minio-notify-amqp-durable This variable corresponds to the :mc-conf:`notify_amqp durable ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_NO_WAIT .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-no-wait :end-before: end-minio-notify-amqp-no-wait This variable corresponds to the :mc-conf:`notify_amqp no_wait ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_INTERNAL .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-internal :end-before: end-minio-notify-amqp-internal This variable corresponds to the :mc-conf:`notify_amqp internal ` configuration setting. .. explanation is very unclear. Need to revisit this. .. envvar:: MINIO_NOTIFY_AMQP_AUTO_DELETED .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-auto-deleted :end-before: end-minio-notify-amqp-auto-deleted This variable corresponds to the :mc-conf:`notify_amqp auto_deleted ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_DELIVERY_MODE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-delivery-mode :end-before: end-minio-notify-amqp-delivery-mode This variable corresponds to the :mc-conf:`notify_amqp delivery_mode ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_QUEUE_DIR .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-queue-dir :end-before: end-minio-notify-amqp-queue-dir This variable corresponds to the :mc-conf:`notify_amqp queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_QUEUE_LIMIT .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-queue-limit :end-before: end-minio-notify-amqp-queue-limit This variable corresponds to the :mc-conf:`notify_amqp queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_AMQP_COMMENT .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-amqp-comment :end-before: end-minio-notify-amqp-comment This variable corresponds to the :mc-conf:`notify_amqp comment ` configuration setting. .. _minio-server-envvar-bucket-notification-mqtt: MQTT Service for Bucket Notifications +++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an MQTT service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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, :envvar:`MINIO_NOTIFY_MQTT_ENABLE_PRIMARY ` indicates the environment variable is associated to an MQTT service endpoint with ID of ``PRIMARY``. .. envvar:: MINIO_NOTIFY_MQTT_ENABLE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-enable :end-before: end-minio-notify-mqtt-enable This variable corresponds to the :mc-conf:`notify_mqtt ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_BROKER *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-broker :end-before: end-minio-notify-mqtt-broker This variable corresponds to the :mc-conf:`notify_mqtt broker ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_TOPIC *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-topic :end-before: end-minio-notify-mqtt-topic This variable corresponds to the :mc-conf:`notify_mqtt topic ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_USERNAME *Required if the MQTT server/broker enforces authentication/authorization* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-username :end-before: end-minio-notify-mqtt-username This variable corresponds to the :mc-conf:`notify_mqtt username ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_PASSWORD *Required if the MQTT server/broker enforces authentication/authorization* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-password :end-before: end-minio-notify-mqtt-password This variable corresponds to the :mc-conf:`notify_mqtt password ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_QOS .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-qos :end-before: end-minio-notify-mqtt-qos This variable corresponds to the :mc-conf:`notify_mqtt qos ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_KEEP_ALIVE_INTERVAL .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-keep-alive-interval :end-before: end-minio-notify-mqtt-keep-alive-interval This variable corresponds to the :mc-conf:`notify_mqtt keep_alive_interval ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_RECONNECT_INTERVAL .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-reconnect-interval :end-before: end-minio-notify-mqtt-reconnect-interval This variable corresponds to the :mc-conf:`notify_mqtt reconnect_interval ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_QUEUE_DIR .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-queue-dir :end-before: end-minio-notify-mqtt-queue-dir This variable corresponds to the :mc-conf:`notify_mqtt queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_QUEUE_LIMIT .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-queue-limit :end-before: end-minio-notify-mqtt-queue-limit This variable corresponds to the :mc-conf:`notify_mqtt queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_MQTT_COMMENT .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mqtt-comment :end-before: end-minio-notify-mqtt-comment This variable corresponds to the :mc-conf:`notify_mqtt comment ` configuration setting. .. _minio-server-envvar-bucket-notification-elasticsearch: Elasticsearch Service for Bucket Notifications ++++++++++++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an Elasticsearch service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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" .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_ENABLE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-enable :end-before: end-minio-notify-elasticsearch-enable Requires specifying the following additional environment variables if set to ``on``: - :envvar:`MINIO_NOTIFY_ELASTICSEARCH_URL` - :envvar:`MINIO_NOTIFY_ELASTICSEARCH_INDEX` - :envvar:`MINIO_NOTIFY_ELASTICSEARCH_FORMAT` This variable corresponds to the :mc-conf:`notify_elasticsearch` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_URL *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-url :end-before: end-minio-notify-elasticsearch-url This variable corresponds to the :mc-conf:`notify_elasticsearch url ` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_INDEX *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-index :end-before: end-minio-notify-elasticsearch-index This variable corresponds to the :mc-conf:`notify_elasticsearch index ` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_FORMAT *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-format :end-before: end-minio-notify-elasticsearch-format This variable corresponds to the :mc-conf:`notify_elasticsearch format ` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_USERNAME *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-username :end-before: end-minio-notify-elasticsearch-username This variable corresponds to the :mc-conf:`notify_elasticsearch username ` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_PASSWORD *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-password :end-before: end-minio-notify-elasticsearch-password This variable corresponds to the :mc-conf:`notify_elasticsearch password ` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-queue-dir :end-before: end-minio-notify-elasticsearch-queue-dir This variable corresponds to the :mc-conf:`notify_elasticsearch queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-queue-limit :end-before: end-minio-notify-elasticsearch-queue-limit This variable corresponds to the :mc-conf:`notify_elasticsearch queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_ELASTICSEARCH_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-elasticsearch-comment :end-before: end-minio-notify-elasticsearch-comment This variable corresponds to the :mc-conf:`notify_elasticsearch comment ` configuration setting. .. _minio-server-envvar-bucket-notification-nsq: NSQ Service for Bucket Notifications ++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an NSQ service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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" .. envvar:: MINIO_NOTIFY_NSQ_ENABLE .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-enable :end-before: end-minio-notify-nsq-enable This variable corresponds to the :mc-conf:`notify_nsq ` configuration setting. .. envvar:: MINIO_NOTIFY_NSQ_NSQD_ADDRESS *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-nsqd-address :end-before: end-minio-notify-nsq-nsqd-address This variable corresponds to the :mc-conf:`notify_nsq nsqd_address ` configuration setting. .. envvar:: MINIO_NOTIFY_NSQ_TOPIC *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-topic :end-before: end-minio-notify-nsq-topic This variable corresponds to the :mc-conf:`notify_nsq topic ` configuration setting. .. envvar:: MINIO_NOTIFY_NSQ_TLS *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-tls :end-before: end-minio-notify-nsq-tls This variable corresponds to the :mc-conf:`notify_nsq tls ` configuration setting. .. envvar:: MINIO_NOTIFY_NSQ_TLS_SKIP_VERIFY *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-tls-skip-verify :end-before: end-minio-notify-nsq-tls-skip-verify This variable corresponds to the :mc-conf:`notify_nsq tls_skip_verify ` configuration setting. .. envvar:: MINIO_NOTIFY_NSQ_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-queue-dir :end-before: end-minio-notify-nsq-queue-dir This variable corresponds to the :mc-conf:`notify_nsq queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_NSQ_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-queue-limit :end-before: end-minio-notify-nsq-queue-limit This variable corresponds to the :mc-conf:`notify_nsq queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_NSQ_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nsq-comment :end-before: end-minio-notify-nsq-comment This variable corresponds to the :mc-conf:`notify_nsq comment ` configuration setting. .. _minio-server-envvar-bucket-notification-redis: Redis Service for Bucket Notifications ++++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an Redis service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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" .. envvar:: MINIO_NOTIFY_REDIS_ENABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-enable :end-before: end-minio-notify-redis-enable Requires specifying the following additional environment variables if set to ``on``: - :envvar:`MINIO_NOTIFY_REDIS_ADDRESS` - :envvar:`MINIO_NOTIFY_REDIS_KEY` - :envvar:`MINIO_NOTIFY_REDIS_FORMAT` This variable corresponds to the :mc-conf:`notify_redis ` configuration setting. .. envvar:: MINIO_NOTIFY_REDIS_ADDRESS *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-address :end-before: end-minio-notify-redis-address This variable corresponds to the :mc-conf:`notify_redis address ` configuration setting. .. envvar:: MINIO_NOTIFY_REDIS_KEY *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-key :end-before: end-minio-notify-redis-key This variable corresponds to the :mc-conf:`notify_redis key ` configuration setting. .. envvar:: MINIO_NOTIFY_REDIS_FORMAT *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-format :end-before: end-minio-notify-redis-format This variable corresponds to the :mc-conf:`notify_redis format ` configuration setting. .. envvar:: MINIO_NOTIFY_REDIS_PASSWORD *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-password :end-before: end-minio-notify-redis-password This variable corresponds to the :mc-conf:`notify_redis password ` configuration setting. .. envvar:: MINIO_NOTIFY_REDIS_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-queue-dir :end-before: end-minio-notify-redis-queue-dir This variable corresponds to the :mc-conf:`notify_redis queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_REDIS_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-queue-limit :end-before: end-minio-notify-redis-queue-limit This variable corresponds to the :mc-conf:`notify_redis queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_REDIS_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-redis-comment :end-before: end-minio-notify-redis-comment This variable corresponds to the :mc-conf:`notify_redis comment ` configuration setting. .. _minio-server-envvar-bucket-notification-nats: NATS Service for Bucket Notifications +++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an NATS service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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, :envvar:`MINIO_NOTIFY_NATS_ENABLE_PRIMARY ` indicates the environment variable is associated to an NATS service endpoint with ID of ``PRIMARY``. .. envvar:: MINIO_NOTIFY_NATS_ENABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-enable :end-before: end-minio-notify-nats-enable This environment variable corresponds with the :mc-conf:`notify_nats ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_ADDRESS *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-address :end-before: end-minio-notify-nats-address This environment variable corresponds with the :mc-conf:`notify_nats address ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_SUBJECT *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-subject :end-before: end-minio-notify-nats-subject This environment variable corresponds with the :mc-conf:`notify_nats subject ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_USERNAME *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-username :end-before: end-minio-notify-nats-username This environment variable corresponds with the :mc-conf:`notify_nats username ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_PASSWORD *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-password :end-before: end-minio-notify-nats-password This environment variable corresponds with the :mc-conf:`notify_nats password ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_TOKEN *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-token :end-before: end-minio-notify-nats-token This environment variable corresponds with the :mc-conf:`notify_nats token ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_TLS *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-tls :end-before: end-minio-notify-nats-tls This environment variable corresponds with the :mc-conf:`notify_nats tls ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-tls-skip-verify :end-before: end-minio-notify-nats-tls-skip-verify This environment variable corresponds with the :mc-conf:`notify_nats tls_skip_verify ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_PING_INTERVAL *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-ping-interval :end-before: end-minio-notify-nats-ping-interval This environment variable corresponds with the :mc-conf:`notify_nats ping_interval ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_STREAMING *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-streaming :end-before: end-minio-notify-nats-streaming This environment variable corresponds with the :mc-conf:`notify_nats streaming ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_STREAMING_ASYNC *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-streaming-async :end-before: end-minio-notify-nats-streaming-async This environment variable corresponds with the :mc-conf:`notify_nats streaming_async ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_STREAMING_MAX_PUB_ACKS_IN_FLIGHT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-streaming-max-pub-acks-in-flight :end-before: end-minio-notify-nats-streaming-max-pub-acks-in-flight This environment variable corresponds with the :mc-conf:`notify_nats streaming_max_pub_acks_in_flight ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_STREAMING_CLUSTER_ID *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-streaming-cluster-id :end-before: end-minio-notify-nats-streaming-cluster-id This environment variable corresponds with the :mc-conf:`notify_nats streaming_cluster_id ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_CERT_AUTHORITY *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-cert-authority :end-before: end-minio-notify-nats-cert-authority This environment variable corresponds with the :mc-conf:`notify_nats cert_authority ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_CLIENT_CERT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-client-cert :end-before: end-minio-notify-nats-client-cert This environment variable corresponds with the :mc-conf:`notify_nats client_cert ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_CLIENT_KEY *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-client-key :end-before: end-minio-notify-nats-client-key This environment variable corresponds with the :mc-conf:`notify_nats client_key ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-queue-dir :end-before: end-minio-notify-nats-queue-dir This environment variable corresponds with the :mc-conf:`notify_nats queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-queue-limit :end-before: end-minio-notify-nats-queue-limit This environment variable corresponds with the :mc-conf:`notify_nats queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_NATS_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-nats-comment :end-before: end-minio-notify-nats-comment This environment variable corresponds with the :mc-conf:`notify_nats comment ` configuration setting. .. _minio-server-envvar-bucket-notification-postgresql: PostgreSQL Service for Bucket Notifications +++++++++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an POSTGRES service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable set MINIO_NOTIFY_POSTGRES_ENABLE_PRIMARY="on" set MINIO_NOTIFY_POSTGRES_CONNECTION_STRING_PRIMARY="host=postgresql-endpoint.example.net port=4222..." set MINIO_NOTIFY_POSTGRES_TABLE_PRIMARY="minioevents" set MINIO_NOTIFY_POSTGRES_FORMAT_PRIMARY="namespace" set MINIO_NOTIFY_POSTGRES_ENABLE_SECONDARY="on" set MINIO_NOTIFY_POSTGRES_CONNECTION_STRING_SECONDARY="host=postgresql-endpoint.example.net port=4222..." set MINIO_NOTIFY_POSTGRES_TABLE_SECONDARY="minioevents" set MINIO_NOTIFY_POSTGRES_FORMAT_SECONDARY="namespace" For example, :envvar:`MINIO_NOTIFY_POSTGRES_ENABLE_PRIMARY ` indicates the environment variable is associated to an PostgreSQL service endpoint with ID of ``PRIMARY``. .. envvar:: MINIO_NOTIFY_POSTGRES_ENABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-enable :end-before: end-minio-notify-postgresql-enable Requires specifying the following additional environment variables if set to ``on``: - :envvar:`MINIO_NOTIFY_POSTGRES_CONNECTION_STRING` - :envvar:`MINIO_NOTIFY_POSTGRES_TABLE` - :envvar:`MINIO_NOTIFY_POSTGRES_FORMAT` This environment variable corresponds with the :mc-conf:`notify_postgres ` configuration setting. .. envvar:: MINIO_NOTIFY_POSTGRES_CONNECTION_STRING *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-connection-string :end-before: end-minio-notify-postgresql-connection-string This environment variable corresponds with the :mc-conf:`notify_postgres connection_string ` configuration setting. .. envvar:: MINIO_NOTIFY_POSTGRES_TABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-table :end-before: end-minio-notify-postgresql-table This environment variable corresponds with the :mc-conf:`notify_postgres table ` configuration setting. .. envvar:: MINIO_NOTIFY_POSTGRES_FORMAT *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-format :end-before: end-minio-notify-postgresql-format This environment variable corresponds with the :mc-conf:`notify_postgres format ` configuration setting. .. envvar:: MINIO_NOTIFY_POSTGRES_MAX_OPEN_CONNECTIONS *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-max-open-connections :end-before: end-minio-notify-postgresql-max-open-connections This environment variable corresponds with the :mc-conf:`notify_postgres max_open_connections ` configuration setting. .. envvar:: MINIO_NOTIFY_POSTGRES_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-queue-dir :end-before: end-minio-notify-postgresql-queue-dir This environment variable corresponds with the :mc-conf:`notify_postgres queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_POSTGRES_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-queue-limit :end-before: end-minio-notify-postgresql-queue-limit This environment variable corresponds with the :mc-conf:`notify_postgres queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_POSTGRES_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-postgresql-comment :end-before: end-minio-notify-postgresql-comment This environment variable corresponds with the :mc-conf:`notify_postgres comment ` configuration setting. .. _minio-server-envvar-bucket-notification-mysql: MySQL Service for Bucket Notifications ++++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an MYSQL service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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, :envvar:`MINIO_NOTIFY_MYSQL_ENABLE_PRIMARY ` indicates the environment variable is associated to an MySQL service endpoint with ID of ``PRIMARY``. .. envvar:: MINIO_NOTIFY_MYSQL_ENABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-enable :end-before: end-minio-notify-mysql-enable Requires specifying the following additional environment variables if set to ``on``: - :envvar:`MINIO_NOTIFY_MYSQL_DSN_STRING` - :envvar:`MINIO_NOTIFY_MYSQL_TABLE` - :envvar:`MINIO_NOTIFY_MYSQL_FORMAT` This environment variable corresponds with the :mc-conf:`notify_mysql ` configuration setting. .. envvar:: MINIO_NOTIFY_MYSQL_DSN_STRING *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-connection-string :end-before: end-minio-notify-mysql-connection-string This environment variable corresponds with the :mc-conf:`notify_mysql dsn_string ` configuration setting. .. envvar:: MINIO_NOTIFY_MYSQL_TABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-table :end-before: end-minio-notify-mysql-table This environment variable corresponds with the :mc-conf:`notify_mysql table ` configuration setting. .. envvar:: MINIO_NOTIFY_MYSQL_FORMAT *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-format :end-before: end-minio-notify-mysql-format This environment variable corresponds with the :mc-conf:`notify_mysql format ` configuration setting. .. envvar:: MINIO_NOTIFY_MYSQL_MAX_OPEN_CONNECTIONS *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-max-open-connections :end-before: end-minio-notify-mysql-max-open-connections This environment variable corresponds with the :mc-conf:`notify_mysql max_open_connections ` configuration setting. .. envvar:: MINIO_NOTIFY_MYSQL_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-queue-dir :end-before: end-minio-notify-mysql-queue-dir This environment variable corresponds with the :mc-conf:`notify_mysql queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_MYSQL_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-queue-limit :end-before: end-minio-notify-mysql-queue-limit This environment variable corresponds with the :mc-conf:`notify_mysql queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_MYSQL_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-mysql-comment :end-before: end-minio-notify-mysql-comment This environment variable corresponds with the :mc-conf:`notify_mysql comment ` configuration setting. .. _minio-server-envvar-bucket-notification-kafka: Kafka Service for Bucket Notifications ++++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an Kafka service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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" .. envvar:: MINIO_NOTIFY_KAFKA_ENABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-enable :end-before: end-minio-notify-kafka-enable .. envvar:: MINIO_NOTIFY_KAFKA_BROKERS *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-brokers :end-before: end-minio-notify-kafka-brokers This environment variable corresponds to the :mc-conf:`notify_kafka brokers ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_TOPIC *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-topic :end-before: end-minio-notify-kafka-topic This environment variable corresponds to the :mc-conf:`notify_kafka topic ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_SASL *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-sasl-root :end-before: end-minio-notify-kafka-sasl-root This environment variable corresponds to the :mc-conf:`notify_kafka sasl ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_SASL_USERNAME *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-sasl-username :end-before: end-minio-notify-kafka-sasl-username This environment variable corresponds to the :mc-conf:`notify_kafka sasl_username ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_SASL_PASSWORD *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-sasl-password :end-before: end-minio-notify-kafka-sasl-password This environment variable corresponds to the :mc-conf:`notify_kafka sasl_password ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_SASL_MECHANISM *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-sasl-mechanism :end-before: end-minio-notify-kafka-sasl-mechanism This environment variable corresponds to the :mc-conf:`notify_kafka sasl_mechanism ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_TLS_CLIENT_AUTH *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-tls-client-auth :end-before: end-minio-notify-kafka-tls-client-auth This environment variable corresponds to the :mc-conf:`notify_kafka tls_client_auth ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_TLS *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-tls-root :end-before: end-minio-notify-kafka-tls-root This environment variable corresponds to the :mc-conf:`notify_kafka tls ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_TLS_SKIP_VERIFY *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-tls-skip-verify :end-before: end-minio-notify-kafka-tls-skip-verify This environment variable corresponds to the :mc-conf:`notify_kafka tls_skip_verify ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_CLIENT_TLS_CERT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-client-tls-cert :end-before: end-minio-notify-kafka-client-tls-cert This environment variable corresponds to the :mc-conf:`notify_kafka client_tls_cert ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_CLIENT_TLS_KEY *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-client-tls-key :end-before: end-minio-notify-kafka-client-tls-key This environment variable corresponds to the :mc-conf:`notify_kafka client_tls_key ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_VERSION *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-version :end-before: end-minio-notify-kafka-version This environment variable corresponds to the :mc-conf:`notify_kafka version ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-queue-dir :end-before: end-minio-notify-kafka-queue-dir This environment variable corresponds to the :mc-conf:`notify_kafka queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-queue-limit :end-before: end-minio-notify-kafka-queue-limit This environment variable corresponds to the :mc-conf:`notify_kafka queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_KAFKA_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: start-minio-notify-kafka-comment :end-before: end-minio-notify-kafka-comment This environment variable corresponds to the :mc-conf:`notify_kafka comment ` configuration setting. .. _minio-server-envvar-bucket-notification-webhook: Webhook Service for Bucket Notifications ++++++++++++++++++++++++++++++++++++++++ The following section documents environment variables for configuring an Webhook service as a target for :ref:`Bucket Nofitications `. See :ref:`minio-bucket-notifications-publish-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: .. code-block:: shell :class: copyable 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" .. envvar:: MINIO_NOTIFY_WEBHOOK_ENABLE *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-enable :end-before: minio-notify-webhook-enable .. envvar:: MINIO_NOTIFY_WEBHOOK_ENDPOINT *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-endpoint :end-before: minio-notify-webhook-endpoint This environment variable corresponds with the :mc-conf:`notify_webhook endpoint ` configuration setting. .. envvar:: MINIO_NOTIFY_WEBHOOK_AUTH_TOKEN *Required* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-auth-token :end-before: minio-notify-webhook-auth-token This environment variable corresponds with the :mc-conf:`notify_webhook auth_token ` configuration setting. .. envvar:: MINIO_NOTIFY_WEBHOOK_QUEUE_DIR *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-queue-dir :end-before: minio-notify-webhook-queue-dir This environment variable corresponds with the :mc-conf:`notify_webhook queue_dir ` configuration setting. .. envvar:: MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-queue-limit :end-before: minio-notify-webhook-queue-limit This environment variable corresponds with the :mc-conf:`notify_webhook queue_limit ` configuration setting. .. envvar:: MINIO_NOTIFY_WEBHOOK_CLIENT_CERT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-client-cert :end-before: minio-notify-webhook-client-cert This environment variable corresponds with the :mc-conf:`notify_webhook client_cert ` configuration setting. .. envvar:: MINIO_NOTIFY_WEBHOOK_CLIENT_KEY *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-client-key :end-before: minio-notify-webhook-client-key This environment variable corresponds with the :mc-conf:`notify_webhook client_key ` configuration setting. .. envvar:: MINIO_NOTIFY_WEBHOOK_COMMENT *Optional* .. include:: /includes/common-mc-admin-config.rst :start-after: minio-notify-webhook-comment :end-before: minio-notify-webhook-comment This environment variable corresponds with the :mc-conf:`notify_webhook comment ` configuration setting. .. _minio-server-envvar-object-lambda-webhook: Object Lambda ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following section documents environment variables for configuring MinIO to publish data to an HTTP webhook endpoint and trigger an Object Lambda function. See :ref:`developers-object-lambda` for more complete documentation and tutorials on using these environment variables. You can specify multiple webhook endpoints as Lambda targets by appending a unique identifier ``_FUNCTIONNAME`` for each Object Lambda function. For example, the following command sets two distinct Object Lambda webhook endpoints: .. code-block:: shell :class: copyable export MINIO_LAMBDA_WEBHOOK_ENABLE_myfunction="on" export MINIO_LAMBDA_WEBHOOK_ENDPOINT_myfunction="http://webhook-1.example.net" export MINIO_LAMBDA_WEBHOOK_ENABLE_yourfunction="on" export MINIO_LAMBDA_WEBHOOK_ENDPOINT_yourfunction="http://webhook-2.example.net" .. envvar:: MINIO_LAMBDA_WEBHOOK_ENABLE Specify ``"on"`` to enable the Object Lambda webhook endpoint for a handler function. Requires specifying :envvar:`MINIO_LAMBDA_WEBHOOK_ENDPOINT`. .. envvar:: MINIO_LAMBDA_WEBHOOK_ENDPOINT The HTTP endpoint of the webhook for the handler function. .. _minio-server-envvar-external-identity-management-ad-ldap: Active Directory / LDAP Identity Management ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following section documents environment variables for enabling external identity management using an Active Directory or LDAP service. See :ref:`minio-external-identity-management-ad-ldap` for a tutorial on using these variables. .. envvar:: MINIO_IDENTITY_LDAP_SERVER_ADDR *Required* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-server-addr :end-before: end-minio-ad-ldap-server-addr This environment variable corresponds with the :mc-conf:`identity_ldap server_addr ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_STS_EXPIRY *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-sts-expiry :end-before: end-minio-ad-ldap-sts-expiry This environment variable corresponds with the :mc-conf:`identity_ldap sts_expiry ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_LOOKUP_BIND_DN *Required* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-lookup-bind-dn :end-before: end-minio-ad-ldap-lookup-bind-dn This environment variable corresponds with the :mc-conf:`identity_ldap lookup_bind_dn ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_LOOKUP_BIND_PASSWORD *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-lookup-bind-password :end-before: end-minio-ad-ldap-lookup-bind-password This environment variable corresponds with the :mc-conf:`identity_ldap lookup_bind_password ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_USER_DN_SEARCH_BASE_DN *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-user-dn-search-base-dn :end-before: end-minio-ad-ldap-user-dn-search-base-dn This environment variable corresponds with the :mc-conf:`identity_ldap user_dn_search_base_dn ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_USER_DN_SEARCH_FILTER *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-user-dn-search-filter :end-before: end-minio-ad-ldap-user-dn-search-filter This environment variable corresponds with the :mc-conf:`identity_ldap user_dn_search_filter ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_USERNAME_FORMAT *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-username-format :end-before: end-minio-ad-ldap-username-format This environment variable corresponds with the :mc-conf:`identity_ldap username_format ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_GROUP_SEARCH_FILTER *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-group-search-filter :end-before: end-minio-ad-ldap-group-search-filter This environment variable corresponds with the :mc-conf:`identity_ldap group_search_filter ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_GROUP_SEARCH_BASE_DN *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-group-search-base-dn :end-before: end-minio-ad-ldap-group-search-base-dn This environment variable corresponds with the :mc-conf:`identity_ldap group_search_base_dn ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_TLS_SKIP_VERIFY *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-tls-skip-verify :end-before: end-minio-ad-ldap-tls-skip-verify This environment variable corresponds with the :mc-conf:`identity_ldap tls_skip_verify ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_SERVER_INSECURE *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-server-insecure :end-before: end-minio-ad-ldap-server-insecure This environment variable corresponds with the :mc-conf:`identity_ldap server_insecure ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_SERVER_STARTTLS *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-server-starttls :end-before: end-minio-ad-ldap-server-starttls This environment variable corresponds with the :mc-conf:`identity_ldap server_starttls ` configuration setting. .. envvar:: MINIO_IDENTITY_LDAP_COMMENT *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-ad-ldap-comment :end-before: end-minio-ad-ldap-comment This environment variable corresponds with the :mc-conf:`identity_ldap comment ` configuration setting. .. _minio-server-envvar-external-identity-management-openid: OpenID Identity Management ~~~~~~~~~~~~~~~~~~~~~~~~~~ The following section documents environment variables for enabling external identity management using an OpenID Connect (OIDC)-compatible provider. See :ref:`minio-external-identity-management-openid` for a tutorial on using these variables. .. envvar:: MINIO_IDENTITY_OPENID_CONFIG_URL *Required* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-config-url :end-before: end-minio-openid-config-url This environment variable corresponds with the :mc-conf:`identity_openid config_url ` setting. .. envvar:: MINIO_IDENTITY_OPENID_CLIENT_ID *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-client-id :end-before: end-minio-openid-client-id This environment variable corresponds with the :mc-conf:`identity_openid client_id ` setting. .. envvar:: MINIO_IDENTITY_OPENID_CLIENT_SECRET *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-client-secret :end-before: end-minio-openid-client-secret This environment variable corresponds with the :mc-conf:`identity_openid client_secret ` setting. .. envvar:: MINIO_IDENTITY_OPENID_CLAIM_NAME *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-claim-name :end-before: end-minio-openid-claim-name This environment variable corresponds with the :mc-conf:`identity_openid claim_name ` setting. .. envvar:: MINIO_IDENTITY_OPENID_CLAIM_PREFIX *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-claim-prefix :end-before: end-minio-openid-claim-prefix This environment variable corresponds with the :mc-conf:`identity_openid claim_prefix ` setting. .. envvar:: MINIO_IDENTITY_OPENID_DISPLAY_NAME *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-display-name :end-before: end-minio-openid-display-name .. envvar:: MINIO_IDENTITY_OPENID_SCOPES *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-scopes :end-before: end-minio-openid-scopes This environment variable corresponds with the :mc-conf:`identity_openid scopes ` setting. .. envvar:: MINIO_IDENTITY_OPENID_REDIRECT_URI *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-redirect-uri :end-before: end-minio-openid-redirect-uri This environment variable corresponds with the :mc-conf:`identity_openid scopes ` setting. .. envvar:: MINIO_IDENTITY_OPENID_REDIRECT_URI_DYNAMIC *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-redirect-uri-dynamic :end-before: end-minio-openid-redirect-uri-dynamic This environment variable corresponds with the :mc-conf:`identity_openid redirect_uri_dynamic ` setting. .. envvar:: MINIO_IDENTITY_OPENID_CLAIM_USERINFO *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-claim-userinfo :end-before: end-minio-openid-claim-userinfo This environment variable corresponds with the :mc-conf:`identity_openid claim_userinfo ` setting. .. envvar:: MINIO_IDENTITY_OPENID_VENDOR *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-vendor :end-before: end-minio-openid-vendor This environment variable corresponds with the :mc-conf:`identity_openid vendor ` setting. .. envvar:: MINIO_IDENTITY_OPENID_KEYCLOAK_REALM *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-keycloak-realm :end-before: end-minio-openid-keycloak-realm This environment variable corresponds with the :mc-conf:`identity_openid keycloak_realm ` setting. Requires :envvar:`MINIO_IDENTITY_OPENID_VENDOR` set to ``keycloak``. .. envvar:: MINIO_IDENTITY_OPENID_KEYCLOAK_ADMIN_URL *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-keycloak-admin-url :end-before: end-minio-openid-keycloak-admin-url This environment variable corresponds with the :mc-conf:`identity_openid keycloak_admin_url ` setting. Requires :envvar:`MINIO_IDENTITY_OPENID_VENDOR` set to ``keycloak``. .. envvar:: MINIO_IDENTITY_OPENID_COMMENT *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-openid-comment :end-before: end-minio-openid-comment This environment variable corresponds with the :mc-conf:`identity_openid comment ` setting. .. _minio-server-envvar-external-identity-management-plugin: MinIO Identity Management Plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. envvar:: MINIO_IDENTITY_PLUGIN_URL *Required* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-identity-management-plugin-url :end-before: end-minio-identity-management-plugin-url .. envvar:: MINIO_IDENTITY_PLUGIN_ROLE_POLICY *Required* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-identity-management-role-policy :end-before: end-minio-identity-management-role-policy .. envvar:: MINIO_IDENTITY_PLUGIN_TOKEN *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-identity-management-auth-token :end-before: end-minio-identity-management-auth-token .. envvar:: MINIO_IDENTITY_PLUGIN_ROLE_ID *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-identity-management-role-id :end-before: end-minio-identity-management-role-id .. envvar:: MINIO_IDENTITY_PLUGIN_COMMENT *Optional* .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-identity-management-comment :end-before: end-minio-identity-management-comment Batch Replication ~~~~~~~~~~~~~~~~~ .. envvar:: MINIO_BATCH_REPLICATION_WORKERS *Optional* Enable parallel workers by specifying the maximum number of processes to use when performing the batch application job.