Documentation

Documentation

mc alias set

Syntax

The mc alias set command adds or updates an alias to the local mc configuration.

The following command adds an alias for a MinIO deployment myminio running at the URL https://myminio.example.net. mc uses the specified username and password for authenticating to the MinIO deployment:

mc alias set myminio https://myminio.example.net minioadminuser minioadminpassword

If the myminio alias already exists, the command overwrites that alias with the new URL, access key, and secret key.

The mc alias set command has the following syntax:

mc [GLOBALFLAGS] alias set \
                 [--api "string"]                           \
                 [--path "string"]                          \
                 ALIAS                                      \
                 URL                                        \
                 ACCESSKEY                                  \
                 SECRETKEY
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters seperated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Required The name to associate to the S3-compatible service.

URL

Required The URL to the S3-compatible service endpoint. For example:

https://minio.example.net

ACCESSKEY

Required

The access key for authenticating to the S3 service.

SECRETKEY

Required

The secret key for authenticating to the S3 service.

--api

Optional

Specifies the signature calculation method to use when connecting to the S3-compatible service. Supports the following values:

  • S3v4 (Default)

  • S3v2

Note

AWS Signature V2 is considered deprecated by AWS. mc alias set includes this option only for S3 buckets or services still reliant on the Signature V2.

Use S3v4 unless explicitly required by the S3-compatible service. MinIO server does not rely on nor require S3v2, nor are all API operations available on S3v2.

--path

Optional

Specifies the bucket path lookup setting used by the server. Supports the following values:

  • "auto" (Default)

  • "on"

  • "off"

Global Flags

This command supports any of the global flags.

Examples

Add or Update an Alias for a MinIO Deployment

Use mc alias set to add an S3-compatible service for use with mc:

The following command creates a new alias myminio pointing at a MinIO deployment at https://minio.example.net. The alias uses the miniouser and miniopassword credentials for performing operations against the deployment.

mc alias set myminio https://minio.example.net miniouser miniopassword

If the myminio alias already exists, the mc alias set command overwrites that alias with the specified arguments.

mc alias set ALIAS HOSTNAME ACCESSKEY SECRETKEY
  • Replace ALIAS with the the name to associate to the MinIO service.

  • Replace HOSTNAME with the URL for any node in the MinIO deployment. You can alternatively specify the URL for a load balancer or reverse proxy managing connections to the MinIO deployment.

  • Replace ACCESSKEY and SECRETKEY with credentials for a user on the MinIO deployment.

Behavior

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested MinIO and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.

Required Credentials and Access Control

mc alias set requires specifying an access key and corresponding secret key for the S3-compatible host. mc functionality is limited based on the policies associated to the specified credentials. For example, if the specified credentials do not have read/write access to a specific bucket, mc cannot perform read or write operations on that bucket.

For more information on MinIO Access Control, see Access Management.

For more complete documentation on S3 Access Control, see Amazon S3 Security.

For all other S3-compatible services, defer to the documentation for that service.