urlscan.io logo urlscan.io
SecurityTrails logo

docs.min.io Open in urlscan Pro
192.241.195.202  Public Scan

Back to summary
Submitted URL: https://chnzx04.na1.hubspotlinks.com/Ctc/I5+113/cHnzx04/VVLBvn3_kjPHW379hgT3p4Hr3W8mS6hr4GtR2hN4nN_cB3q8_QV1-WJV7CgVQqW3Cbjxq7xwtxqW2...
Effective URL: https://docs.min.io/?utm_campaign=Feb%202022%20Newsletter&utm_medium=email&_hsmi=206171177&_hsenc=p2ANqtz--2IlglNwoc...
Submission: On March 11 via api from CH — Scanned from DE

Form analysis 1 forms found in the DOM

<form action="" onsubmit="LO.submit_chat(); return false;">
  <div id="lo_chat_input" style="position:relative; width: 100%; ">
    <div class="lo-fx-hr" style="height:0px; margin-bottom:0px; margin-top:0px; width:100%; border-top:1px solid #000000;border-bottom:1px solid #4f4f4f"></div>
    <div style="padding:10px;"><label for="lo_chat_textarea" style="display:none">Chat Input Box</label><textarea id="lo_chat_textarea" disabled="disabled" rows="2"
        style="color: black; background-color: rgb(255, 255, 255); border-radius: 5px; padding: 7px; height: auto; width: 100%; font-family: sans-serif; text-transform: none; resize: none;" dir="null" data-last-scroll-height="0"></textarea></div>
    <div id="lo_chat_sound_holder" style="position:absolute; right:0px; top:-25px; width:100%;">
      <div style="cursor: pointer; float:right; opacity:0.6; padding-right:10px; height:16px;" id="lo_chat_sound"><img alt="Click to mute chat sounds" src="https://d10lpsik1i8c69.cloudfront.net/graphics/sound-on-white.png"></div>
      <div id="lo_chat_status" style="padding-left:10px; font-size:11px; color:#6d6d6d"></div>
      <div style="clear:both;"></div>
    </div>
  </div>
</form>

Text Content

Product
Hybrid Cloud Object Storage
Overview Architecture
Baremetal
Overview Architecture
Erasure Code Calculator Reference Hardware
Features
Active Active Replication Identity & Access Management Encryption Bucket &
Object Immutability Bucket & Object Versioning Data Life Cycle Management &
Tiering Automated Data Management Interfaces Monitoring Scalability
Native Versions
MinIO for VMware Tanzu MinIO for OpenShift MinIO for Amazon Elastic Kubernetes
Service MinIO for Azure Kubernetes Service MinIO for Google Kubernetes Engine
Docs
MinIO Baremetal MinIO Object Storage for Baremetal Infrastructure MinIO Hybrid
Cloud MinIO Object Storage for Kubernetes-Managed Private and Public Cloud
Infrastructure MinIO for VMware Cloud Foundation MinIO Object Storage for VMware
Cloud Foundation 4.2 MinIO Legacy Documentation Legacy Documentation for MinIO
Object Storage
Solutions
VMware Discover how MinIO integrates with VMware across the portfolio from the
Persistent Data platform to TKGI and how we support their Kubernetes ambitions.
Splunk Find out how MinIO is delivering performance at scale for Splunk
SmartStores Veeam Learn how MinIO and Veeam have partnered to drive performance
and scalability for a variety of backup use cases. Azure to AWS S3 Gateway Learn
how MinIO allows Azure Blob to speak Amazon’s S3 API HDFS Migration Modernize
and simplify your big data storage infrastructure with high-performance,
Kubernetes-native object storage from MinIO. Teradata Discover why MinIO is the
Native Object Store (NOS) of choice for at-scale Teradata deployments
Integrations Browse our vast portfolio of integrations
Resources Blog Pricing Download
 * MinIO Server
   * MinIO Quickstart Guide
   * MinIO Docker Quickstart Guide
   * MinIO Erasure Code Quickstart Guide
   * Distributed MinIO Quickstart Guide
   * How to secure access to MinIO server with TLS
   * MinIO Security Overview
   * MinIO Server Limits Per Tenant
   * MinIO Server Configuration Guide
   * Multi-tenant MinIO Deployment Guide
   * MinIO Monitoring Guide
   * How to monitor MinIO using Prometheus
   * MinIO KMS Quickstart Guide
   * MinIO Multi-User Quickstart Guide
   * MinIO STS Quickstart Guide
 * MinIO Features
   * MinIO Bucket Versioning Guide
   * MinIO Bucket Object Lock and Immutability Guide
   * MinIO Bucket Replication Guide
   * MinIO Bucket Notification Guide
   * MinIO Bucket Lifecycle Configuration Guide
   * MinIO Select API Quickstart Guide
 * MinIO Integrations
   * Using MinIO with Veeam
 * MinIO Gateway
   * MinIO Gateway for NAS
   * MinIO Gateway for S3
   * MinIO Disk Cache Guide
 * MinIO Deployment
   * MinIO Deployment Quickstart Guide
   * Deploy MinIO on Kubernetes
   * Deploy MinIO on Docker Compose
 * MinIO Client
   * MinIO Client Quickstart Guide
   * MinIO Client Complete Guide
   * MinIO Admin Complete Guide
 * MinIO SDKs
   * Java Client Quickstart Guide
   * Java Client API Reference
   * Golang Client Quickstart Guide
   * Golang Client API Reference
   * Python Client Quickstart Guide
   * Python Client API Reference
   * JavaScript Client Quickstart Guide
   * JavaScript Client API Reference
   * .NET Client Quickstart Guide
   * .NET Client API Reference
   * Haskell Client Quickstart Guide
   * Haskell Client API Reference
 * Cookbook
   * Disaggregated Spark and Hadoop Hive with MinIO
   * S3cmd with MinIO
   * AWS CLI with MinIO
   * restic with MinIO
   * Store MySQL Backups in MinIO
   * Store MongoDB Backups in MinIO
   * Store PostgreSQL Backups in MinIO
   * Setup Caddy proxy with MinIO
   * Setup Nginx proxy with MinIO
   * Store Apache Logs into MinIO
   * Rclone with MinIO Server
   * Setup Apache HTTP proxy with MinIO Server
   * Upload files from browser using pre-signed URLs
   * How to run MinIO in FreeNAS?
   * How to use AWS SDK for PHP with MinIO Server
   * How to use AWS SDK for Ruby with MinIO Server
   * How to use AWS SDK for Python with MinIO Server
   * How to use AWS SDK for JavaScript with MinIO Server
   * How to run multiple MinIO servers with Træfɪk
   * How to use AWS SDK for Go with MinIO Server
   * How to use AWS SDK for Java with MinIO Server
   * How to use Paperclip with MinIO Server
   * How to use AWS SDK for .NET with MinIO Server
   * How to use MinIO's server-side-encryption with aws-cli
   * Generate Let's Encrypt certificate using Certbot for MinIO

Copy


Suggest an Edit
 1. Log into Github.
 2. Edit files with your changes by clicking on 'Edit the file in your fork of
    this project' button in Github.
 3. Commit changes via 'Create a new branch for this commit and start a pull
    request'.

Edit in Github


MINIO QUICKSTART GUIDE





MinIO is a High Performance Object Storage released under GNU Affero General
Public License v3.0. It is API compatible with Amazon S3 cloud storage service.
Use MinIO to build high performance infrastructure for machine learning,
analytics and application data workloads.

This README provides quickstart instructions on running MinIO on bare metal
hardware, including container-based installations. For Kubernetes environments,
use the MinIO Kubernetes Operator.


CONTAINER INSTALLATION

Use the following commands to run a standalone MinIO server as a container.

Standalone MinIO servers are best suited for early development and evaluation.
Certain features such as versioning, object locking, and bucket replication
require distributed deploying MinIO with Erasure Coding. For extended
development and production, deploy MinIO with Erasure Coding enabled -
specifically,
with a minimum of 4 drives per MinIO server. See MinIO Erasure Code Quickstart
Guide
for more complete documentation.


STABLE

Run the following command to run the latest stable image of MinIO as a container
using an ephemeral data volume:

Copypodman run -p 9000:9000 -p 9001:9001 \
  quay.io/minio/minio server /data --console-address ":9001"


The MinIO deployment starts using default root credentials
minioadmin:minioadmin. You can test the deployment using the MinIO Console, an
embedded
object browser built into MinIO Server. Point a web browser running on the host
machine to http://127.0.0.1:9000 and log in with the
root credentials. You can use the Browser to create buckets, upload objects, and
browse the contents of the MinIO server.

You can also connect using any S3-compatible tool, such as the MinIO Client mc
commandline tool. See
Test using MinIO Client mc for more information on using the mc commandline
tool. For application developers,
see https://docs.min.io/docs/ and click MinIO SDKs in the navigation to view
MinIO SDKs for supported languages.

> NOTE: To deploy MinIO on with persistent storage, you must map local
> persistent directories from the host OS to the container using the podman -v
> option. For example, -v /mnt/data:/data maps the host OS drive at /mnt/data to
> /data on the container.


MACOS

Use the following commands to run a standalone MinIO server on macOS.

Standalone MinIO servers are best suited for early development and evaluation.
Certain features such as versioning, object locking, and bucket replication
require distributed deploying MinIO with Erasure Coding. For extended
development and production, deploy MinIO with Erasure Coding enabled -
specifically, with a minimum of 4 drives per MinIO server. See MinIO Erasure
Code Quickstart Guide for more complete documentation.


HOMEBREW (RECOMMENDED)

Run the following command to install the latest stable MinIO package using
Homebrew. Replace /data with the path to the drive or directory in which you
want MinIO to store data.

Copybrew install minio/stable/minio
minio server /data


> NOTE: If you previously installed minio using brew install minio then it is
> recommended that you reinstall minio from minio/stable/minio official repo
> instead.

Copybrew uninstall minio
brew install minio/stable/minio


The MinIO deployment starts using default root credentials
minioadmin:minioadmin. You can test the deployment using the MinIO Console, an
embedded web-based object browser built into MinIO Server. Point a web browser
running on the host machine to http://127.0.0.1:9000 and log in with the root
credentials. You can use the Browser to create buckets, upload objects, and
browse the contents of the MinIO server.

You can also connect using any S3-compatible tool, such as the MinIO Client mc
commandline tool. See Test using MinIO Client mc for more information on using
the mc commandline tool. For application developers, see
https://docs.min.io/docs/ and click MinIO SDKs in the navigation to view MinIO
SDKs for supported languages.


BINARY DOWNLOAD

Use the following command to download and run a standalone MinIO server on
macOS. Replace /data with the path to the drive or directory in which you want
MinIO to store data.

Copywget https://dl.min.io/server/minio/release/darwin-amd64/minio
chmod +x minio
./minio server /data


The MinIO deployment starts using default root credentials
minioadmin:minioadmin. You can test the deployment using the MinIO Console, an
embedded web-based object browser built into MinIO Server. Point a web browser
running on the host machine to http://127.0.0.1:9000 and log in with the root
credentials. You can use the Browser to create buckets, upload objects, and
browse the contents of the MinIO server.

You can also connect using any S3-compatible tool, such as the MinIO Client mc
commandline tool. See Test using MinIO Client mc for more information on using
the mc commandline tool. For application developers, see
https://docs.min.io/docs/ and click MinIO SDKs in the navigation to view MinIO
SDKs for supported languages.


GNU/LINUX

Use the following command to run a standalone MinIO server on Linux hosts
running 64-bit Intel/AMD architectures. Replace /data with the path to the drive
or directory in which you want MinIO to store data.

Copywget https://dl.min.io/server/minio/release/linux-amd64/minio
chmod +x minio
./minio server /data


Replace /data with the path to the drive or directory in which you want MinIO to
store data.

The following table lists supported architectures. Replace the wget URL with the
architecture for your Linux host.

Architecture URL 64-bit Intel/AMD
https://dl.min.io/server/minio/release/linux-amd64/minio 64-bit ARM
https://dl.min.io/server/minio/release/linux-arm64/minio 64-bit PowerPC LE
(ppc64le) https://dl.min.io/server/minio/release/linux-ppc64le/minio IBM
Z-Series (S390X) https://dl.min.io/server/minio/release/linux-s390x/minio

The MinIO deployment starts using default root credentials
minioadmin:minioadmin. You can test the deployment using the MinIO Console, an
embedded web-based object browser built into MinIO Server. Point a web browser
running on the host machine to http://127.0.0.1:9000 and log in with the root
credentials. You can use the Browser to create buckets, upload objects, and
browse the contents of the MinIO server.

You can also connect using any S3-compatible tool, such as the MinIO Client mc
commandline tool. See Test using MinIO Client mc for more information on using
the mc commandline tool. For application developers, see
https://docs.min.io/docs/ and click MinIO SDKs in the navigation to view MinIO
SDKs for supported languages.

> NOTE: Standalone MinIO servers are best suited for early development and
> evaluation. Certain features such as versioning, object locking, and bucket
> replication require distributed deploying MinIO with Erasure Coding. For
> extended development and production, deploy MinIO with Erasure Coding enabled
> - specifically, with a minimum of 4 drives per MinIO server. See MinIO Erasure
> Code Quickstart Guide for more complete documentation.


MICROSOFT WINDOWS

To run MinIO on 64-bit Windows hosts, download the MinIO executable from the
following URL:

Copyhttps://dl.min.io/server/minio/release/windows-amd64/minio.exe


Use the following command to run a standalone MinIO server on the Windows host.
Replace D:\ with the path to the drive or directory in which you want MinIO to
store data. You must change the terminal or powershell directory to the location
of the minio.exe executable, or add the path to that directory to the system
$PATH:

Copyminio.exe server D:\


The MinIO deployment starts using default root credentials
minioadmin:minioadmin. You can test the deployment using the MinIO Console, an
embedded web-based object browser built into MinIO Server. Point a web browser
running on the host machine to http://127.0.0.1:9000 and log in with the root
credentials. You can use the Browser to create buckets, upload objects, and
browse the contents of the MinIO server.

You can also connect using any S3-compatible tool, such as the MinIO Client mc
commandline tool. See Test using MinIO Client mc for more information on using
the mc commandline tool. For application developers, see
https://docs.min.io/docs/ and click MinIO SDKs in the navigation to view MinIO
SDKs for supported languages.

> NOTE: Standalone MinIO servers are best suited for early development and
> evaluation. Certain features such as versioning, object locking, and bucket
> replication require distributed deploying MinIO with Erasure Coding. For
> extended development and production, deploy MinIO with Erasure Coding enabled
> - specifically, with a minimum of 4 drives per MinIO server. See MinIO Erasure
> Code Quickstart Guide for more complete documentation.


INSTALL FROM SOURCE

Use the following commands to compile and run a standalone MinIO server from
source. Source installation is only intended for developers and advanced users.
If you do not have a working Golang environment, please follow How to install
Golang. Minimum version required is go1.17

CopyGO111MODULE=on go install github.com/minio/minio@latest


The MinIO deployment starts using default root credentials
minioadmin:minioadmin. You can test the deployment using the MinIO Console, an
embedded web-based object browser built into MinIO Server. Point a web browser
running on the host machine to http://127.0.0.1:9000 and log in with the root
credentials. You can use the Browser to create buckets, upload objects, and
browse the contents of the MinIO server.

You can also connect using any S3-compatible tool, such as the MinIO Client mc
commandline tool. See Test using MinIO Client mc for more information on using
the mc commandline tool. For application developers, see
https://docs.min.io/docs/ and click MinIO SDKs in the navigation to view MinIO
SDKs for supported languages.

> NOTE: Standalone MinIO servers are best suited for early development and
> evaluation. Certain features such as versioning, object locking, and bucket
> replication require distributed deploying MinIO with Erasure Coding. For
> extended development and production, deploy MinIO with Erasure Coding enabled
> - specifically, with a minimum of 4 drives per MinIO server. See MinIO Erasure
> Code Quickstart Guide for more complete documentation.

MinIO strongly recommends against using compiled-from-source MinIO servers for
production environments.


DEPLOYMENT RECOMMENDATIONS


ALLOW PORT ACCESS FOR FIREWALLS

By default MinIO uses the port 9000 to listen for incoming connections. If your
platform blocks the port by default, you may need to enable access to the port.


UFW

For hosts with ufw enabled (Debian based distros), you can use ufw command to
allow traffic to specific ports. Use below command to allow access to port 9000

Copyufw allow 9000


Below command enables all incoming traffic to ports ranging from 9000 to 9010.

Copyufw allow 9000:9010/tcp



FIREWALL-CMD

For hosts with firewall-cmd enabled (CentOS), you can use firewall-cmd command
to allow traffic to specific ports. Use below commands to allow access to port
9000

Copyfirewall-cmd --get-active-zones


This command gets the active zone(s). Now, apply port rules to the relevant
zones returned above. For example if the zone is public, use

Copyfirewall-cmd --zone=public --add-port=9000/tcp --permanent


Note that permanent makes sure the rules are persistent across firewall start,
restart or reload. Finally reload the firewall for changes to take effect.

Copyfirewall-cmd --reload



IPTABLES

For hosts with iptables enabled (RHEL, CentOS, etc), you can use iptables
command to enable all traffic coming to specific ports. Use below command to
allow
access to port 9000

Copyiptables -A INPUT -p tcp --dport 9000 -j ACCEPT
service iptables restart


Below command enables all incoming traffic to ports ranging from 9000 to 9010.

Copyiptables -A INPUT -p tcp --dport 9000:9010 -j ACCEPT
service iptables restart



PRE-EXISTING DATA

When deployed on a single drive, MinIO server lets clients access any
pre-existing data in the data directory. For example, if MinIO is started with
the command minio server /mnt/data, any pre-existing data in the /mnt/data
directory would be accessible to the clients.

The above statement is also valid for all gateway backends.


TEST MINIO CONNECTIVITY


TEST USING MINIO CONSOLE

MinIO Server comes with an embedded web based object browser. Point your web
browser to http://127.0.0.1:9000 to ensure your server has started successfully.

> NOTE: MinIO runs console on random port by default if you wish choose a
> specific port use --console-address to pick a specific interface and port.


THINGS TO CONSIDER

MinIO redirects browser access requests to the configured server port (i.e.
127.0.0.1:9000) to the configured Console port. MinIO uses the hostname or IP
address specified in the request when building the redirect URL. The URL and
port must be accessible by the client for the redirection to work.

For deployments behind a load balancer, proxy, or ingress rule where the MinIO
host IP address or port is not public, use the MINIO_BROWSER_REDIRECT_URL
environment variable to specify the external hostname for the redirect. The
LB/Proxy must have rules for directing traffic to the Console port specifically.

For example, consider a MinIO deployment behind a proxy
https://minio.example.net, https://console.minio.example.net with rules for
forwarding traffic on port :9000 and :9001 to MinIO and the MinIO Console
respectively on the internal network. Set MINIO_BROWSER_REDIRECT_URL to
https://console.minio.example.net to ensure the browser receives a valid
reachable URL.

Similarly, if your TLS certificates do not have the IP SAN for the MinIO server
host, the MinIO Console may fail to validate the connection to the server. Use
the MINIO_SERVER_URL environment variable and specify the proxy-accessible
hostname of the MinIO server to allow the Console to use the MinIO server API
using the TLS certificate.

For example: export MINIO_SERVER_URL="https://minio.example.net"

Dashboard Creating a bucket


TEST USING MINIO CLIENT MC

mc provides a modern alternative to UNIX commands like ls, cat, cp, mirror, diff
etc. It supports filesystems and Amazon S3 compatible cloud storage services.
Follow the MinIO Client Quickstart Guide for further instructions.


UPGRADING MINIO

Upgrades require zero downtime in MinIO, all upgrades are non-disruptive, all
transactions on MinIO are atomic. So upgrading all the servers simultaneously is
the recommended way to upgrade MinIO.

> NOTE: requires internet access to update directly from https://dl.min.io,
> optionally you can host any mirrors at
> https://my-artifactory.example.com/minio/

 * For deployments that installed the MinIO server binary by hand, use mc admin
   update

Copymc admin update <minio alias, e.g., myminio>


 * For deployments without external internet access (e.g. airgapped
   environments), download the binary from https://dl.min.io and replace the
   existing MinIO binary let's say for example /opt/bin/minio, apply executable
   permissions chmod +x /opt/bin/minio and do mc admin service restart alias/.

 * For RPM/DEB installations, upgrade packages parallelly on all servers. Once
   upgraded, perform systemctl restart minio across all nodes in parallel.
   RPM/DEB based installations are usually automated using ansible.


UPGRADE CHECKLIST

 * Test all upgrades in a lower environment (DEV, QA, UAT) before applying to
   production. Performing blind upgrades in production environments carries
   significant risk.
 * Read the release notes for the targeted MinIO release before performing any
   installation, there is no forced requirement to upgrade to latest releases
   every week. If it has a bug fix you are looking for then yes, else avoid
   actively upgrading a running production system.
 * Make sure MinIO process has write access to /opt/bin if you plan to use mc
   admin update. This is needed for MinIO to download the latest binary from
   https://dl.min.io and save it locally for upgrades.
 * mc admin update is not supported in kubernetes/container environments,
   container environments provide their own mechanisms for container updates.
 * We do not recommend upgrading one MinIO server at a time, the product is
   designed to support parallel upgrades please follow our recommended
   guidelines.


EXPLORE FURTHER

 * MinIO Erasure Code QuickStart Guide
 * Use mc with MinIO Server
 * Use aws-cli with MinIO Server
 * Use s3cmd with MinIO Server
 * Use minio-go SDK with MinIO Server
 * The MinIO documentation website


CONTRIBUTE TO MINIO PROJECT

Please follow MinIO Contributor's Guide


LICENSE

 * MinIO source is licensed under the GNU AGPLv3 license that can be found in
   the LICENSE file.
 * MinIO Documentation © 2021 by MinIO, Inc is licensed under CC BY 4.0.
 * License Compliance

Talk to the community

Live Chat is Online 
Chatting
0
×
–

undefined



Chat Input Box

Chat
Powered by