AIStor Client Settings

This page covers settings for the AIStor Client mc.

You can establish or modify settings by defining:

  • an environment variable on the host system prior to starting or restarting the AIStor 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, AIStor uses the environment variable value.

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

Host Credentials

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

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

The temporary alias uses the AWS s3v4 signature.

Use mc alias set to configure an alias.

Static Credentials

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

Security Token Service (STS) Credentials

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

STS Service

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

Web Token Identity

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

Supports adding multiple environment variables by alias.

Configuration Directory

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

Progress Bar

Disable the AIStor Client progress bar.

Pager

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

Color Theme

Disable the color theme used for AIStor Client output.

JSON

Enable formatting the output as JSON lines.

Debug

Enable the debug output.

Disable SSL

Disable SSL certificate verification.

Limit Download Bandwidth

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

If not specified, the AIStor 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 AIStorClient. 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 AIStor Client uses for certain commands.

If not specified, the AIStor 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 AIStorClient. 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.

SSE-S3 Encryption

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

All rights reserved 2024-Present, MinIO, Inc.