Product
Overview
What is AIStor?
Features
Replication Replication Console Console Cache Cache Encryption Encryption Versioning Versioning Observability Observability Object Immutability Object Immutability Key Management Server Key Management Server S3 Compatibility S3 Compatibility Identity + Access Mgt Identity + Access Mgt Catalog Catalog Object Prompt Object Prompt Lifecycle Lifecycle Firewall Firewall AIHub AIHub
Tools
Erasure Code Calculator Erasure Code Calculator Determine your raw and usable capacity across a range of erasure coding settings. Reference Hardware Reference Hardware MinIO’s recommended Configuration and reference hardware for building large scale data infrastructure.
Solutions
AI Storage Learn how MinIO is leading the AI storage market from its exclusive features to performance at scale. HDFS Migration Modernize and simplify your big data storage infrastructure with cloud native storage with AIStor. Snowflake Learn how to leverage Snowflake external tables to query data without having to move it.
Integrations Integrations with MinIO Browse our expansive list of
integrations with links to the relevant
documentation.
Veeam Learn how MinIO and Veeam have partnered deliver superior RTO and RPO. Modern Datalakes Learn how modern, multi-engine data lakeshouses depend on MinIO's AIStor. Equinix Repatriate your data onto the cloud you control with MinIO and Equinix. SQL Server Learn how to leverage SQL Server 2022 with MinIO to run queries on your data without having to move it. Commvault Learn how Commvault and MinIO are partnered to deliver performance at scale for mission critical backup and restore workloads. Hybrid Cloud Learn how enterprises use MinIO to build AI data infrastructure that runs on any cloud - public, private or colo. Splunk Find out how MinIO is delivering performance at scale for Splunk SmartStores. VMware Discover how MinIO integrates with VMware across the portfolio from the Persistent Data platform to TKG and how we support their Kubernetes ambitions.
Open Source
Github Community Explore, experiment, ask questions and contribute. Docs Development guides. Slack Channel Open Forum for discussing topics related to MinIO.
Download MinIO Object Store Get MinIO's open source server, client, and SDK.
Resources
Resources Home Browse our library of white papers, solution briefs, benchmarks and videos. Blog Product updates, company news, and educational content. Training Learn the MinIO Way and Become a Data Infrastructure Expert.
Events Join us to take advantage to meet with MinIO partners, employees, and subject-matter experts.
Partner Pricing Login Download

Documentation

MinIO Object Storage

MinIO Client Settings

This page covers settings for the MinIO Client.

You can establish or modify settings by defining:

  • an environment variable on the host system prior to starting or restarting the MinIO Server. Refer to your operating system’s documentation for how to define an environment variable.

  • a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, MinIO uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

Settings

Host Credentials

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

The temporary alias uses the AWS s3v4 signature.

MC_HOST_<ALIAS>

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

This setting does not have a configuration setting option.

Use mc alias set to configure an alias.

Examples

Static Credentials

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

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

Security Token Service (STS) Credentials

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

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

STS Service

New in version mc: RELEASE.2023-11-06T04-19-23Z

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

Changed in version mc: RELEASE.2023-12-02T02-03-28Z

Supports adding multiple environment variables by alias.

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

This setting does not have a configuration setting option.

Web Token Identity

New in version mc: RELEASE.2023-11-06T04-19-23Z

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

Changed in version mc: RELEASE.2023-12-02T02-03-28Z

Supports adding multiple environment variables by alias.

MC_WEB_IDENTITY_TOKEN_<alias>
export MC_WEB_IDENTITY_TOKEN_FILE_myalias=/var/run/secrets/kubernetes.io/serviceaccount/token

This setting does not have a configuration setting option.

Configuration Directory

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

MC_CONFIG_DIR

This setting does not have a configuration setting option.

Progress Bar

Disable the MinIO Client progress bar.

MC_QUIET

This setting does not have a configuration setting option.

Pager

New in version 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.

MC_DISABLE_PAGER

This setting does not have a configuration setting option.

Color Theme

Disable the color theme used for MinIO Client output.

MC_NO_COLOR

This setting does not have a configuration setting option.

JSON

Enable formatting the output as JSON lines.

MC_JSON

This setting does not have a configuration setting option.

Debug

Enable the debug output.

MC_DEBUG

This setting does not have a configuration setting option.

Disable SSL

Disable SSL certificate verification.

MC_INSECURE

This setting does not have a configuration setting option.

Limit Download Bandwidth

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

MC_LIMIT_DOWNLOAD

This setting does not have a configuration setting 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:

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.

MC_LIMIT_UPLOAD

This setting does not have a configuration setting 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:

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 with server managed keys.

MC_ENC_KMS

Specify the key with the MC_ENC_KMS environment variable.

This setting does not have a configuration setting option.

SSE-S3 Encryption

Encrypt and decrypt options using SSE-KMS with server managed keys.

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.

This setting does not have a configuration setting option.

This work is licensed under a Creative Commons Attribution 4.0 International License. 2020-Present, MinIO, Inc. Creative Commons License