diff --git a/source/includes/common-minio-ad-ldap-params.rst b/source/includes/common-minio-ad-ldap-params.rst index efda86f7..28ddf6e0 100644 --- a/source/includes/common-minio-ad-ldap-params.rst +++ b/source/includes/common-minio-ad-ldap-params.rst @@ -127,3 +127,19 @@ This parameter corresponds with the :envvar:`MINIO_IDENTITY_LDAP_TLS_SKIP_VERIFY` environment variable. .. end-minio-ad-ldap-params + +.. Descriptions for adding LDAP access keys + Used in the following files: + - /source/reference/minio-mc/mc-idp-ldap-accesskey.rst + - /source/reference/minio-mc/mc-idp-ldap-accesskey-info.rst + - /source/reference/minio-mc/mc-idp-ldap-accesskey-rm.rst + - /source/reference/minio-mc/mc-idp-ldap-accesskey-ls.rst + +.. start-minio-ad-ldap-accesskey-creation + +This command works against :ref:`access keys ` created by an AD/LDAP user after authenticating to MinIO. + +Authenticated users can manage their own long-term Access Keys using the :ref:`MinIO Console `. +MinIO supports using :ref:`AssumeRoleWithLDAPIdentity ` to generate temporary access keys using the :ref:`Security Token Service `. + +.. end-minio-ad-ldap-accesskey-creation \ No newline at end of file diff --git a/source/reference/deprecated/mc-ilm-add.rst b/source/reference/deprecated/mc-ilm-add.rst index d0add69b..331b9bad 100644 --- a/source/reference/deprecated/mc-ilm-add.rst +++ b/source/reference/deprecated/mc-ilm-add.rst @@ -69,7 +69,6 @@ The command supports adding both :ref:`Transition (Tiering) ` of the MinIO deployment. + .. mc-cmd:: --bucket-bandwidth + + Set default bandwidth limit for bucket in bits per second. + + Valid units include: + + - ``B`` for bytes + - ``K`` for kilobytes + - ``M`` for megabytes + - ``G`` for gigabytes + - ``T`` for terabytes + - ``Ki`` for kibibytes + - ``Mi`` for mibibytes + - ``Gi`` for gibibytes + - ``Ti`` for tebibytes + + For example, the following command limits the replication on the ``myminio`` deployment to no more than 2 Gigabytes per second. + + .. code-block:: shell + :class: copyable + + mc admin replicate update myminio --deployment-id c1758167-4426-454f-9aae-5c3dfdf6df64 --bucket-bandwidth "2G" + .. mc-cmd:: --deployment-id :required: diff --git a/source/reference/minio-mc.rst b/source/reference/minio-mc.rst index 93648526..50cffc2c 100644 --- a/source/reference/minio-mc.rst +++ b/source/reference/minio-mc.rst @@ -232,7 +232,8 @@ The following table lists :mc-cmd:`mc` commands: :start-after: start-mc-head-desc :end-before: end-mc-head-desc - * - | :mc:`mc idp ldap add` + * - | :mc:`mc idp ldap accesskey` + | :mc:`mc idp ldap add` | :mc:`mc idp ldap disable` | :mc:`mc idp ldap enable` | :mc:`mc idp ldap info` @@ -488,7 +489,8 @@ Global Options .. program:: mc -All :ref:`commands ` support the following global options: +All :ref:`commands ` support the following global options. +You can also define some of these options using :ref:`Environment Variables `. .. option:: --debug @@ -502,12 +504,16 @@ All :ref:`commands ` support the following global options: mc --debug ls play + Alternatively, set the environment variable :envvar:`MC_DEBUG`. + .. option:: --config-dir The path to a ``JSON`` formatted configuration file that :program:`mc` uses for storing data. See :ref:`mc-configuration` for more information on how :program:`mc` uses the configuration file. + Alternatively, set the environment variable :envvar:`MC_CONFIG_DIR`. + .. option:: --JSON Enables `JSON lines `_ formatted output to the @@ -521,21 +527,29 @@ All :ref:`commands ` support the following global options: mc --JSON ls play + Alternatively, set the environment variable :envvar:`MC_JSON`. + .. option:: --no-color Disables the built-in color theme for console output. Useful for dumb terminals. + Alternatively, set the environment variable :envvar:`MC_NO_COLOR`. + .. option:: --quiet Suppresses console output. + Alternatively, set the environment variable :envvar:`MC_QUIET`. + .. option:: --insecure Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts. + Alternatively, set the environment variable :envvar:`MC_INSECURE`. + .. option:: --version Displays the current version of :mc-cmd:`mc`. @@ -562,6 +576,7 @@ All :ref:`commands ` support the following global options: /reference/minio-mc/mc-find /reference/minio-mc/mc-head /reference/minio-mc/mc-idp-ldap + /reference/minio-mc/mc-idp-ldap-accesskey /reference/minio-mc/mc-idp-ldap-policy /reference/minio-mc/mc-idp-openid /reference/minio-mc/mc-ilm diff --git a/source/reference/minio-mc/mc-idp-ldap-accesskey-info.rst b/source/reference/minio-mc/mc-idp-ldap-accesskey-info.rst new file mode 100644 index 00000000..1b055207 --- /dev/null +++ b/source/reference/minio-mc/mc-idp-ldap-accesskey-info.rst @@ -0,0 +1,111 @@ +.. _minio-mc-idp-ldap-accesskey-info: + +============================== +``mc idp ldap accesskey info`` +============================== + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + + +.. mc:: mc idp ldap accesskey info + + +Description +----------- + +.. start-mc-idp-ldap-accesskey-info-desc + +The :mc:`mc idp ldap accesskey info` outputs information about the specified access key(s). + +.. end-mc-idp-ldap-accesskey-info-desc + +.. include:: /includes/common-minio-ad-ldap-params.rst + :start-after: start-minio-ad-ldap-accesskey-creation + :end-before: end-minio-ad-ldap-accesskey-creation + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following example outputs details for the access key ``mykey`` from the ``minio`` deployment: + + .. code-block:: shell + :class: copyable + + mc idp ldap accesskey info minio/ mykey + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] idp ldap accesskey info \ + ALIAS \ + KEY \ + [KEY2] ... + + + - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment configured for AD/LDAP integration. + - Replace ``KEY`` with the access key to delete. + You can list more than one access key by separating each key with a space. + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: ALIAS + :required: + + The :ref:`alias ` of the MinIO deployment configured for AD/LDAP. + + For example: + + .. code-block:: none + + mc idp ldap accesskey ls minio + +.. mc-cmd:: KEY + :required: + + The configured access key to output information about. + + You can list more than one access key by separating each key with a space. + + +Example +~~~~~~~ + +Output information about the access keys ``mykey`` and ``mykey2`` from the ``minio`` deployment. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey info minio/ mykey mykey2 + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals + + +Behavior +-------- + +S3 Compatibility +~~~~~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-s3-compatibility + :end-before: end-minio-mc-s3-compatibility diff --git a/source/reference/minio-mc/mc-idp-ldap-accesskey-ls.rst b/source/reference/minio-mc/mc-idp-ldap-accesskey-ls.rst new file mode 100644 index 00000000..0aee8493 --- /dev/null +++ b/source/reference/minio-mc/mc-idp-ldap-accesskey-ls.rst @@ -0,0 +1,193 @@ +.. _minio-mc-idp-ldap-accesskey-ls: + +============================ +``mc idp ldap accesskey ls`` +============================ + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + + +.. mc:: mc idp ldap accesskey list +.. mc:: mc idp ldap accesskey ls + + +Description +----------- + +.. start-mc-idp-ldap-accesskey-ls-desc + +The :mc:`mc idp ldap accesskey ls` displays a list of LDAP access key pairs. + +.. end-mc-idp-ldap-accesskey-ls-desc + +:mc:`mc idp ldap accesskey ls` is also known as :mc:`mc idp ldap accesskey list`. + +.. include:: /includes/common-minio-ad-ldap-params.rst + :start-after: start-minio-ad-ldap-accesskey-creation + :end-before: end-minio-ad-ldap-accesskey-creation + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following example returns a list of access keys associated with the authenticated user on the ``minio`` :ref:`alias `: + + .. code-block:: shell + :class: copyable + + mc idp ldap accesskey ls minio/ + + If the authenticated user has the ``admin:ListUsers`` permission, the example command returns a list of all users and their associated access keys. + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] idp ldap accesskey ls \ + ALIAS \ + [--permanent-only] \ + [--temp-only] \ + [--users-only] \ + [DN] ... + + + - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment configured for AD/LDAP integration. + - Replace ``DN`` with the string of a user's `distinguished name `__. + You may list multiple distinguished names by separating each with a space. + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: ALIAS + :required: + + The :ref:`alias ` of the MinIO deployment configured for AD/LDAP. + + For example: + + .. code-block:: none + + mc idp ldap accesskey ls minio + +.. mc-cmd:: --permanent-only + :optional: + + Output only permanent access keys. + + Mutually exclusive with :mc-cmd:`~mc idp ldap accesskey ls --temp-only`. + +.. mc-cmd:: --temp-only + :optional: + + Output only temporary access keys. + + Mutually exclusive with :mc-cmd:`~mc idp ldap accesskey ls --permanent-only`. + +.. mc-cmd:: --users-only + :optional: + + Output only the user distinguished names. + +Examples +~~~~~~~~ + +List All Access Keys +++++++++++++++++++++ + +To return a list of all access keys, you must first authenticate as the ``admin`` user. +Once authenticated, the following command returns all AD/LDAP access keys on the ``minio`` deployment. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey ls minio + +.. note:: + + If the user does not have the ``admin:ListUsers`` permission, the command returns a list of access keys for the authenticated user only. + +List User Distinguished Names ++++++++++++++++++++++++++++++ + +To return a list of DNs for a deployment, you must first authenticate as a user with the ``admin:ListUsers`` permission. +Once authenticated, the following command outputs the AD/LDAP distinguished names on the ``minio`` deployment. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey ls minio --users-only + +List Temporary Access Keys +++++++++++++++++++++++++++ + +To return a list of all temporary access keys for a deployment, you must first authenticate as a user with the ``admin:ListUsers`` permission. +Once authenticated, the following command outputs a list of distinguished names with their associated temporary access keys. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey ls minio --temp-only + +List a User's Access Keys ++++++++++++++++++++++++++ + +The following command returns the AD/LDAP access keys for the user ``bobfisher`` on the ``minio`` deployment. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey list minio/ uid=bobfisher,dc=min,dc=io + +List Access Keys for Multiple Users ++++++++++++++++++++++++++++++++++++ + +The following command returns the AD/LDAP access keys for the users ``bobfisher`` and ``cody3`` on the ``minio`` deployment. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey list minio/ uid=bobfisher,dc=min,dc=io uid=cody3,dc=min,dc=io + +List Access Keys for Authenticated User ++++++++++++++++++++++++++++++++++++++++ + +The following command returns the AD/LDAP access keys for the currently authenticated user on the ``minio`` deployment. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey list minio/ + +.. note:: + + If the authenticated user has the ``admin:ListUsers`` permission, the command returns a list of all users and access keys on the deployment. + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals + + +Behavior +-------- + +S3 Compatibility +~~~~~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-s3-compatibility + :end-before: end-minio-mc-s3-compatibility diff --git a/source/reference/minio-mc/mc-idp-ldap-accesskey-rm.rst b/source/reference/minio-mc/mc-idp-ldap-accesskey-rm.rst new file mode 100644 index 00000000..6094aa1c --- /dev/null +++ b/source/reference/minio-mc/mc-idp-ldap-accesskey-rm.rst @@ -0,0 +1,109 @@ +.. _minio-mc-idp-ldap-accesskey-rm: + +============================ +``mc idp ldap accesskey rm`` +============================ + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + + +.. mc:: mc idp ldap accesskey rm +.. mc:: mc idp ldap accesskey remove + + +Description +----------- + +.. start-mc-idp-ldap-accesskey-rm-desc + +The :mc:`mc idp ldap accesskey rm` deletes the specified access key from the local server. + +.. end-mc-idp-ldap-accesskey-rm-desc + +:mc:`mc idp ldap accesskey rm` is also known as :mc:`mc idp ldap accesskey remove`. + +.. include:: /includes/common-minio-ad-ldap-params.rst + :start-after: start-minio-ad-ldap-accesskey-creation + :end-before: end-minio-ad-ldap-accesskey-creation + +.. tab-set:: + + .. tab-item:: EXAMPLE + + The following example deletes the access key ``mykey`` from the ``minio`` deployment: + + .. code-block:: shell + :class: copyable + + mc idp ldap accesskey rm minio/ mykey + + .. tab-item:: SYNTAX + + The command has the following syntax: + + .. code-block:: shell + :class: copyable + + mc [GLOBALFLAGS] idp ldap accesskey rm \ + ALIAS \ + KEY + + + - Replace ``ALIAS`` with the :ref:`alias ` of a MinIO deployment configured for AD/LDAP integration. + - Replace ``KEY`` with the access key to delete. + + .. include:: /includes/common-minio-mc.rst + :start-after: start-minio-syntax + :end-before: end-minio-syntax + + +Parameters +~~~~~~~~~~ + +.. mc-cmd:: ALIAS + :required: + + The :ref:`alias ` of the MinIO deployment configured for AD/LDAP. + + For example: + + .. code-block:: none + + mc idp ldap accesskey ls minio + +.. mc-cmd:: KEY + :required: + + The configured access key to delete. + +Example +~~~~~~~ + +Delete the access key ``mykey`` from the ``minio`` deployment. + +.. code-block:: shell + :class: copyable + + mc idp ldap accesskey rm minio/ mykey + +Global Flags +~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-globals + :end-before: end-minio-mc-globals + + +Behavior +-------- + +S3 Compatibility +~~~~~~~~~~~~~~~~ + +.. include:: /includes/common-minio-mc.rst + :start-after: start-minio-mc-s3-compatibility + :end-before: end-minio-mc-s3-compatibility diff --git a/source/reference/minio-mc/mc-idp-ldap-accesskey.rst b/source/reference/minio-mc/mc-idp-ldap-accesskey.rst new file mode 100644 index 00000000..ab45644b --- /dev/null +++ b/source/reference/minio-mc/mc-idp-ldap-accesskey.rst @@ -0,0 +1,62 @@ +.. _minio-mc-idp-ldap-accesskey: + +========================= +``mc idp ldap accesskey`` +========================= + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + +.. mc:: mc idp ldap accesskey + +.. versionadded:: RELEASE.2023-10-30T18-43-32Z + +Description +----------- + +.. start-mc-idp-ldap-accesskey-desc + +The :mc-cmd:`mc idp ldap accesskey` commands allow you to list, delete, or display information about LDAP access key pairs. + +.. end-mc-idp-ldap-accesskey-desc + +The :mc-cmd:`mc idp ldap accesskey` commands are only supported against MinIO deployments. + +.. include:: /includes/common-minio-ad-ldap-params.rst + :start-after: start-minio-ad-ldap-accesskey-creation + :end-before: end-minio-ad-ldap-accesskey-creation + +The :mc-cmd:`mc idp ldap accesskey` command has the following subcommands: + +.. list-table:: + :header-rows: 1 + :widths: 40 60 + + * - Subcommand + - Description + + * - :mc-cmd:`mc idp ldap accesskey ls` + - .. include:: /reference/minio-mc/mc-idp-ldap-accesskey-ls.rst + :start-after: start-mc-idp-ldap-accesskey-ls-desc + :end-before: end-mc-idp-ldap-accesskey-ls-desc + + * - :mc-cmd:`mc idp ldap accesskey rm` + - .. include:: /reference/minio-mc/mc-idp-ldap-accesskey-remove.rst + :start-after: start-mc-idp-ldap-accesskey-remove-desc + :end-before: end-mc-idp-ldap-accesskey-remove-desc + + * - :mc-cmd:`mc idp ldap accesskey info` + - .. include:: /reference/minio-mc/mc-idp-ldap-accesskey-info.rst + :start-after: start-mc-idp-ldap-accesskey-info-desc + :end-before: end-mc-idp-ldap-accesskey-info-desc + +.. toctree:: + :titlesonly: + :hidden: + + /reference/minio-mc/mc-idp-ldap-accesskey-ls + /reference/minio-mc/mc-idp-ldap-accesskey-rm + /reference/minio-mc/mc-idp-ldap-accesskey-info diff --git a/source/reference/minio-mc/mc-ilm-rule-add.rst b/source/reference/minio-mc/mc-ilm-rule-add.rst index 62af3e48..ec8835af 100644 --- a/source/reference/minio-mc/mc-ilm-rule-add.rst +++ b/source/reference/minio-mc/mc-ilm-rule-add.rst @@ -70,7 +70,6 @@ The command supports adding both :ref:`Transition (Tiering) ` on a MinIO deployment. .. end-mc-support-top-locks-desc +The command outputs the age of the lock, type of lock, owner, and resource. +The output resembles the following: + +.. code-block:: shell + + Since Type Owner Resource + 13 hours ago WRITE 10.68.100.18:9000 .minio.sys/leader.lock + 13 hours ago WRITE 10.68.100.18:9000 .minio.sys/callhome/runCallhome.lock + 13 hours ago WRITE 10.68.100.23:9000 .minio.sys/new-drive-healing/0/0 + .. tab-set:: .. tab-item:: EXAMPLE diff --git a/source/reference/minio-mc/minio-client-settings.rst b/source/reference/minio-mc/minio-client-settings.rst index b89b2481..23f38b8a 100644 --- a/source/reference/minio-mc/minio-client-settings.rst +++ b/source/reference/minio-mc/minio-client-settings.rst @@ -80,4 +80,240 @@ Examples .. code-block:: shell :class: copyable - export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG:eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiJOVUlCT1JaWVRWMkhHMkJNUlNYUiIsImF1ZCI6IlBvRWdYUDZ1Vk80NUlzRU5SbmdEWGo1QXU1WWEiLCJhenAiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiZXhwIjoxNTM0ODk2NjI5LCJpYXQiOjE1MzQ4OTMwMjksImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0Ojk0NDMvb2F1dGgyL3Rva2VuIiwianRpIjoiNjY2OTZjZTctN2U1Ny00ZjU5LWI0MWQtM2E1YTMzZGZiNjA4In0.eJONnVaSVHypiXKEARSMnSKgr-2mlC2Sr4fEGJitLcJF_at3LeNdTHv0_oHsv6ZZA3zueVGgFlVXMlREgr9LXA@play.min.io \ No newline at end of file + export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG:eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiJOVUlCT1JaWVRWMkhHMkJNUlNYUiIsImF1ZCI6IlBvRWdYUDZ1Vk80NUlzRU5SbmdEWGo1QXU1WWEiLCJhenAiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiZXhwIjoxNTM0ODk2NjI5LCJpYXQiOjE1MzQ4OTMwMjksImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0Ojk0NDMvb2F1dGgyL3Rva2VuIiwianRpIjoiNjY2OTZjZTctN2U1Ny00ZjU5LWI0MWQtM2E1YTMzZGZiNjA4In0.eJONnVaSVHypiXKEARSMnSKgr-2mlC2Sr4fEGJitLcJF_at3LeNdTHv0_oHsv6ZZA3zueVGgFlVXMlREgr9LXA@play.min.io + +Configuration Directory +~~~~~~~~~~~~~~~~~~~~~~~ + +Specify the path to the configuration folder the MinIO Client should use. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_CONFIG_DIR + + Replace ```` at the end of the environment variable with the ``alias`` to set the host for. + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +Progress Bar +~~~~~~~~~~~~ + +Disable the MinIO Client progress bar. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_QUIET + + Replace ```` at the end of the environment variable with the ``alias`` to set the host for. + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +Color Theme +~~~~~~~~~~~ + +Disable the color theme used for MinIO Client output. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_NO_COLOR + + Replace ```` at the end of the environment variable with the ``alias`` to set the host for. + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + + +JSON +~~~~ + +Enable formatting the output as JSON lines. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_JSON + + Replace ```` at the end of the environment variable with the ``alias`` to set the host for. + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +Debug +~~~~~ + +Enable the debug output. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_DEBUG + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +Disable SSL +~~~~~~~~~~~ + +Disable SSL certificate verification. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_INSECURE + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +Limit Download Bandwidth +~~~~~~~~~~~~~~~~~~~~~~~~ + +Limit the download bandwidth the MinIO Client uses for certain commands. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_LIMIT_DOWNLOAD + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +If not specified, the MinIO Client uses all available bandwidth. + +Limit client-side download rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s. This affects only the download from the local device running the MinIO Client. Valid units include: + +- B for bytes +- K for kilobytes +- M for megabytes +- G for gigabytes +- Ki for kibibytes +- Mi for mibibytes +- Gi for gibibytes + +For example, to limit download rates to no more than 1 GiB/s, use the following on a Linux system: + +.. code-block:: shell + :class: copyable + + export MC_LIMIT_DOWNLOAD=1G + +Refer to your operating system instructions for equivalent commands on non-Linux systems. + +Limit Upload Bandwidth +~~~~~~~~~~~~~~~~~~~~~~ + +Limit the upload bandwidth the MinIO Client uses for certain commands. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_LIMIT_UPLOAD + + Replace ```` at the end of the environment variable with the ``alias`` to set the host for. + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +If not specified, the MinIO Client uses all available bandwidth. + +Limit client-side upload rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s. This affects only the upload from the local device running the MinIO Client. Valid units include: + +- B for bytes +- K for kilobytes +- M for megabytes +- G for gigabytes +- Ki for kibibytes +- Mi for mibibytes +- Gi for gibibytes + +For example, to limit upload rates to no more than 1 GiB/s, use the following on a Linux system: + +.. code-block:: shell + :class: copyable + + export MC_LIMIT_UPLOAD=1G + +Refer to your operating system instructions for equivalent commands on non-Linux systems. + +Encrypt +~~~~~~~ + +Encrypt and decrypt options using :ref:`server-side encryption ` with server managed keys. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_ENCRYPT + + Specify the key with the :envvar:`MC_ENCRYPT_KEY` environment variable. + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option + +Encrypt Key +~~~~~~~~~~~ + +Specify the key to use for encrypting and decrypting objects. +Must also enable the :envvar:`MC_ENCRYPT` environment variable. + +.. tab-set:: + + .. tab-item:: Environment Variable + :selected: + + .. envvar:: MC_ENCRYPT_KEY + + .. tab-item:: Configuration Setting + + .. include:: /includes/common-mc-admin-config.rst + :start-after: start-minio-settings-no-config-option + :end-before: end-minio-settings-no-config-option \ No newline at end of file