docs/source/reference/minio-mc/minio-client-settings.rst

MinIO Client Settings

minio

Table of Contents

This page covers settings for the MinIO Client <minio-client>.

Settings

Host Credentials

Use this setting to add a temporary alias to use for mc commands. For example, for use with scripting.

Environment Variable

MC_HOST<ALIAS>

Replace <ALIAS> at the end of the environment variable with the alias to set the host for.

Configuration Setting

Use mc alias set to configure an alias <alias>.

Examples

Static Credentials

Syntax

export MC_HOST_<alias>=https://<Access Key>:<Secret Key>@<YOUR-S3-ENDPOINT>

Example

export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG@play.min.io

Security Token Service (STS) Credentials

Syntax

export MC_HOST_<alias>=https://<Access Key>:<Secret Key>:<Session Token>@<YOUR-S3-ENDPOINT>

Example

export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG:eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiJOVUlCT1JaWVRWMkhHMkJNUlNYUiIsImF1ZCI6IlBvRWdYUDZ1Vk80NUlzRU5SbmdEWGo1QXU1WWEiLCJhenAiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiZXhwIjoxNTM0ODk2NjI5LCJpYXQiOjE1MzQ4OTMwMjksImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0Ojk0NDMvb2F1dGgyL3Rva2VuIiwianRpIjoiNjY2OTZjZTctN2U1Ny00ZjU5LWI0MWQtM2E1YTMzZGZiNjA4In0.eJONnVaSVHypiXKEARSMnSKgr-2mlC2Sr4fEGJitLcJF_at3LeNdTHv0_oHsv6ZZA3zueVGgFlVXMlREgr9LXA@play.min.io

STS Service

mc RELEASE.2023-11-06T04-19-23Z

Use this setting to add an STS endpoint to use for mc commands.

mc RELEASE.2023-12-02T02-03-28Z

Supports adding multiple environment variables by alias.

Environment Variable

MC_STS_ENDPOINT<alias>

export MC_STS_ENDPOINT_myalias=https://sts.minio-operator.svc.cluster.local:4223/sts/ns-1 

Configuration Setting

Web Token Identity

mc RELEASE.2023-11-06T04-19-23Z

Use this setting to add a web token identity to use for mc commands.

mc RELEASE.2023-12-02T02-03-28Z

Supports adding multiple environment variables by alias.

Environment Variable

MC_WEB_IDENTITY_TOKEN<alias>

export MC_WEB_IDENTITY_TOKEN_FILE_myalias=/var/run/secrets/kubernetes.io/serviceaccount/token

Configuration Setting

Configuration Directory

Specify the path to the configuration folder the MinIO Client should use.

Environment Variable

MC_CONFIG_DIR

Configuration Setting

Progress Bar

Disable the MinIO Client progress bar.

Environment Variable

MC_QUIET

Configuration Setting

Pager

mc RELEASE.2024-04-29T09-56-05Z

Disable the pager functionality of the MinIO Client in the CLI. When used, output prints to raw STDOUT instead.

Environment Variable

MC_DISABLE_PAGER

Configuration Setting

Color Theme

Disable the color theme used for MinIO Client output.

Environment Variable

MC_NO_COLOR

Configuration Setting

JSON

Enable formatting the output as JSON lines.

Environment Variable

MC_JSON

Configuration Setting

Debug

Enable the debug output.

Environment Variable

MC_DEBUG

Configuration Setting

Disable SSL

Disable SSL certificate verification.

Environment Variable

MC_INSECURE

Configuration Setting

Limit Download Bandwidth

Limit the download bandwidth the MinIO Client uses for certain commands.

Environment Variable

MC_LIMIT_DOWNLOAD

Configuration Setting

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:

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.

Environment Variable

MC_LIMIT_UPLOAD

Configuration Setting

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:

export MC_LIMIT_UPLOAD=1G

Refer to your operating system instructions for equivalent commands on non-Linux systems.

SSE-KMS Encryption

Encrypt and decrypt options using SSE-KMS <minio-sse-data-encryption> with server managed keys.

Environment Variable

MC_ENC_KMS

Specify the key with the MC_ENC_KMS environment variable.

Configuration Setting

SSE-S3 Encryption

Encrypt and decrypt options using SSE-KMS <minio-sse-data-encryption> with server managed keys.

Environment Variable

MC_ENC_S3

Specify the key to use for performing SSE-S3 encryption. The specified value must match the encryption key set in MINIO_KMS_KES_KEY_NAME.

Configuration Setting