mc alias set

The mc alias set command sets or updates an alias in the AIStor client configuration.

mc alias set play https://play.min.io Q3AM3UQ867SPQQA43P2F zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG

mc [GLOBALFLAGS] alias set ALIAS URL ACCESSKEY SECRETKEY

Required

The name to associate to the S3-compatible service. Aliases are case-sensitive and must meet the following requirements:

• Contain only ASCII lower case letters (a-z), upper case letters (A-Z), numbers ([0-9]), hyphen (-), or underscore (_).
• 1 or more characters in length.
• The first character must be a letter.

Examples of some valid alias values include:

• myminio
• Test-1
• A
• a

Required

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

https://minio.example.net

Required

The access key for authenticating to the S3 service.

Required

The secret key for authenticating to the S3 service.

Optional

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

• S3v4 (Default)
• S3v2

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

Optional

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

• "auto" (Default)
• "on"
• "off"

This command supports any of the global flags.

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

The following command creates a new alias myminio pointing at an AIStor 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 AIStor service.
• Replace HOSTNAME with the URL for any node in the AIStor deployment. You can alternatively specify the URL for a load balancer or reverse proxy managing connections to the AIStor deployment.
• Replace ACCESSKEY and SECRETKEY with credentials for a user on the AIStor deployment.

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

AIStor 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.

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 AIStor 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.

The AIStor client fetches the peer certificate, computes the public key fingerprint, and asks the user whether to accept the deployment’s certificate.

If trusted, the client automatically adds the certificate authority to:

• ~/.mc/certs/CAs/ on Linux and other Unix-like systems.
• C:\Users\[username]\mc\certs\CAs\ on Windows systems.