docs/source/includes/linux/quickstart.rst

This procedure deploys a Standalone <minio-installation-comparison> MinIO server onto Linux for early development and evaluation of MinIO Object Storage and its S3-compatible API layer.

For instructions on deploying to production environments, see deploy-minio-distributed.

Prerequisites

• Read, Write and Execute permissions on your local user folder (e.g. ~/minio).
• Permission to install binaries to the system PATH (e.g. access to /usr/local/bin).
• Familiarity with the Linux terminal or shell (Bash, ZSH, etc.).
• A 64-bit Linux OS (e.g. RHEL 8, Ubuntu LTS releases).

Procedure

1. Install the MinIO Server

2. Launch the MinIO Server

   Run the following command from the system terminal or shell to start a local MinIO instance using the ~/minio folder. You can replace this path with another folder path on the local machine:

   mkdir ~/minio
   minio server ~/minio --console-address :9001

   The mkdir command creates the folder explicitly at the specified path.

   The minio server command starts the MinIO server. The path argument ~/minio identifies the folder in which the server operates.

   The minio server process prints its output to the system console, similar to the following:

   API: http://192.0.2.10:9000  http://127.0.0.1:9000
   RootUser: minioadmin
   RootPass: minioadmin
   
   Console: http://192.0.2.10:9001 http://127.0.0.1:9001
   RootUser: minioadmin
   RootPass: minioadmin
   
   Command-line: https://docs.min.io/community/minio-object-store/reference/minio-mc.html
      $ mc alias set myminio http://192.0.2.10:9000 minioadmin minioadmin
   
   Documentation: https://docs.min.io/community/minio-object-store/index.html
   
   WARNING: Detected default credentials 'minioadmin:minioadmin', we recommend that you change these values with 'MINIO_ROOT_USER' and 'MINIO_ROOT_PASSWORD' environment variables.

3. Connect Your Browser to the MinIO Server

   Open http://127.0.0.1:9000 in a web browser to access the MinIO Console <minio-console>. You can alternatively enter any of the network addresses specified as part of the server command output. For example, Console: http://192.0.2.10:9001 http://127.0.0.1:9001 in the example output indicates two possible addresses to use for connecting to the Console.

   While the port 9000 is used for connecting to the API, MinIO automatically redirects browser access to the MinIO Console.

   Log in to the Console with the RootUser and RootPass user credentials displayed in the output. These default to minioadmin | minioadmin.

4. (Optional) Install the MinIO Client

   The MinIO Client <minio-client> allows you to work with your MinIO server from the commandline.

   Download the mc client and install it to a location on your system PATH such as /usr/local/bin. You can alternatively run the binary from the download location.

   wget https://dl.min.io/client/mc/release/linux-amd64/mc
   chmod +x mc
   sudo mv mc /usr/local/bin/mc

   Use mc alias set to create a new alias associated to your local deployment. You can run mc commands against this alias:

   mc alias set local http://127.0.0.1:9000 minioadmin minioadmin
   mc admin info local

   The mc alias set takes four arguments:

   • The name of the alias
   • The hostname or IP address and port of the MinIO server
   • The Access Key for a MinIO user <minio-users>
   • The Secret Key for a MinIO user <minio-users>

   The example above uses the root user <minio-users-root>.

section-next-steps

Next Steps

• Connect your applications to MinIO <minio-drivers>
• Configure Object Retention <minio-object-retention>
• Configure Security <minio-authentication-and-identity-management>
• Deploy MinIO for Production Environments <deploy-minio-distributed>