github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/README.md (about) 1 # MinIO Quickstart Guide 2 3 [](https://slack.min.io) [](https://hub.docker.com/r/minio/minio/) [](https://github.com/minio/minio/blob/master/LICENSE) 4 5 [](https://min.io) 6 7 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. 8 9 This README provides quickstart instructions on running MinIO on bare metal hardware, including container-based installations. For Kubernetes environments, use the [MinIO Kubernetes Operator](https://github.com/minio/operator/blob/master/README.md). 10 11 ## Container Installation 12 13 Use the following commands to run a standalone MinIO server as a container. 14 15 Standalone MinIO servers are best suited for early development and evaluation. Certain features such as versioning, object locking, and bucket replication 16 require distributed deploying MinIO with Erasure Coding. For extended development and production, deploy MinIO with Erasure Coding enabled - specifically, 17 with a *minimum* of 4 drives per MinIO server. See [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html) 18 for more complete documentation. 19 20 ### Stable 21 22 Run the following command to run the latest stable image of MinIO as a container using an ephemeral data volume: 23 24 ```sh 25 podman run -p 9000:9000 -p 9001:9001 \ 26 quay.io/minio/minio server /data --console-address ":9001" 27 ``` 28 29 The MinIO deployment starts using default root credentials `minioadmin:minioadmin`. You can test the deployment using the MinIO Console, an embedded 30 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 31 root credentials. You can use the Browser to create buckets, upload objects, and browse the contents of the MinIO server. 32 33 You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See 34 [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, 35 see <https://min.io/docs/minio/linux/developers/minio-drivers.html> to view MinIO SDKs for supported languages. 36 37 > 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. 38 39 ## macOS 40 41 Use the following commands to run a standalone MinIO server on macOS. 42 43 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 Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html) for more complete documentation. 44 45 ### Homebrew (recommended) 46 47 Run the following command to install the latest stable MinIO package using [Homebrew](https://brew.sh/). Replace ``/data`` with the path to the drive or directory in which you want MinIO to store data. 48 49 ```sh 50 brew install minio/stable/minio 51 minio server /data 52 ``` 53 54 > 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. 55 56 ```sh 57 brew uninstall minio 58 brew install minio/stable/minio 59 ``` 60 61 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. 62 63 You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see <https://min.io/docs/minio/linux/developers/minio-drivers.html/> to view MinIO SDKs for supported languages. 64 65 ### Binary Download 66 67 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. 68 69 ```sh 70 wget https://dl.min.io/server/minio/release/darwin-amd64/minio 71 chmod +x minio 72 ./minio server /data 73 ``` 74 75 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. 76 77 You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see <https://min.io/docs/minio/linux/developers/minio-drivers.html> to view MinIO SDKs for supported languages. 78 79 ## GNU/Linux 80 81 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. 82 83 ```sh 84 wget https://dl.min.io/server/minio/release/linux-amd64/minio 85 chmod +x minio 86 ./minio server /data 87 ``` 88 89 The following table lists supported architectures. Replace the `wget` URL with the architecture for your Linux host. 90 91 | Architecture | URL | 92 | -------- | ------ | 93 | 64-bit Intel/AMD | <https://dl.min.io/server/minio/release/linux-amd64/minio> | 94 | 64-bit ARM | <https://dl.min.io/server/minio/release/linux-arm64/minio> | 95 | 64-bit PowerPC LE (ppc64le) | <https://dl.min.io/server/minio/release/linux-ppc64le/minio> | 96 | IBM Z-Series (S390X) | <https://dl.min.io/server/minio/release/linux-s390x/minio> | 97 98 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. 99 100 You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see <https://min.io/docs/minio/linux/developers/minio-drivers.html> to view MinIO SDKs for supported languages. 101 102 > 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 Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html#) for more complete documentation. 103 104 ## Microsoft Windows 105 106 To run MinIO on 64-bit Windows hosts, download the MinIO executable from the following URL: 107 108 ```sh 109 https://dl.min.io/server/minio/release/windows-amd64/minio.exe 110 ``` 111 112 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``: 113 114 ```sh 115 minio.exe server D:\ 116 ``` 117 118 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. 119 120 You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see <https://min.io/docs/minio/linux/developers/minio-drivers.html> to view MinIO SDKs for supported languages. 121 122 > 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 Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html#) for more complete documentation. 123 124 ## Install from Source 125 126 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](https://golang.org/doc/install). Minimum version required is [go1.21](https://golang.org/dl/#stable) 127 128 ```sh 129 go install github.com/minio/minio@latest 130 ``` 131 132 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. 133 134 You can also connect using any S3-compatible tool, such as the MinIO Client `mc` commandline tool. See [Test using MinIO Client `mc`](#test-using-minio-client-mc) for more information on using the `mc` commandline tool. For application developers, see <https://min.io/docs/minio/linux/developers/minio-drivers.html> to view MinIO SDKs for supported languages. 135 136 > 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 Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html) for more complete documentation. 137 138 MinIO strongly recommends *against* using compiled-from-source MinIO servers for production environments. 139 140 ## Deployment Recommendations 141 142 ### Allow port access for Firewalls 143 144 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. 145 146 ### ufw 147 148 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 149 150 ```sh 151 ufw allow 9000 152 ``` 153 154 Below command enables all incoming traffic to ports ranging from 9000 to 9010. 155 156 ```sh 157 ufw allow 9000:9010/tcp 158 ``` 159 160 ### firewall-cmd 161 162 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 163 164 ```sh 165 firewall-cmd --get-active-zones 166 ``` 167 168 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 169 170 ```sh 171 firewall-cmd --zone=public --add-port=9000/tcp --permanent 172 ``` 173 174 Note that `permanent` makes sure the rules are persistent across firewall start, restart or reload. Finally reload the firewall for changes to take effect. 175 176 ```sh 177 firewall-cmd --reload 178 ``` 179 180 ### iptables 181 182 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 183 access to port 9000 184 185 ```sh 186 iptables -A INPUT -p tcp --dport 9000 -j ACCEPT 187 service iptables restart 188 ``` 189 190 Below command enables all incoming traffic to ports ranging from 9000 to 9010. 191 192 ```sh 193 iptables -A INPUT -p tcp --dport 9000:9010 -j ACCEPT 194 service iptables restart 195 ``` 196 197 ## Test MinIO Connectivity 198 199 ### Test using MinIO Console 200 201 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. 202 203 > NOTE: MinIO runs console on random port by default, if you wish to choose a specific port use `--console-address` to pick a specific interface and port. 204 205 ### Things to consider 206 207 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. 208 209 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. 210 211 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. 212 213 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. 214 215 For example: `export MINIO_SERVER_URL="https://minio.example.net"` 216 217 | Dashboard | Creating a bucket | 218 | ------------- | ------------- | 219 |  |  | 220 221 ## Test using MinIO Client `mc` 222 223 `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](https://min.io/docs/minio/linux/reference/minio-mc.html#quickstart) for further instructions. 224 225 ## Upgrading MinIO 226 227 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. 228 229 > 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/> 230 231 - For deployments that installed the MinIO server binary by hand, use [`mc admin update`](https://min.io/docs/minio/linux/reference/minio-mc-admin/mc-admin-update.html) 232 233 ```sh 234 mc admin update <minio alias, e.g., myminio> 235 ``` 236 237 - 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 proceed to perform `mc admin service restart alias/`. 238 239 - For installations using Systemd MinIO service, upgrade via RPM/DEB packages **parallelly** on all servers or replace the binary lets say `/opt/bin/minio` on all nodes, apply executable permissions `chmod +x /opt/bin/minio` and process to perform `mc admin service restart alias/`. 240 241 ### Upgrade Checklist 242 243 - Test all upgrades in a lower environment (DEV, QA, UAT) before applying to production. Performing blind upgrades in production environments carries significant risk. 244 - Read the release notes for MinIO *before* performing any upgrade, there is no forced requirement to upgrade to latest release upon every release. Some release may not be relevant to your setup, avoid upgrading production environments unnecessarily. 245 - If you plan to use `mc admin update`, MinIO process must have write access to the parent directory where the binary is present on the host system. 246 - `mc admin update` is not supported and should be avoided in kubernetes/container environments, please upgrade containers by upgrading relevant container images. 247 - **We do not recommend upgrading one MinIO server at a time, the product is designed to support parallel upgrades please follow our recommended guidelines.** 248 249 ## Explore Further 250 251 - [MinIO Erasure Code Overview](https://min.io/docs/minio/linux/operations/concepts/erasure-coding.html) 252 - [Use `mc` with MinIO Server](https://min.io/docs/minio/linux/reference/minio-mc.html) 253 - [Use `minio-go` SDK with MinIO Server](https://min.io/docs/minio/linux/developers/go/minio-go.html) 254 - [The MinIO documentation website](https://min.io/docs/minio/linux/index.html) 255 256 ## Contribute to MinIO Project 257 258 Please follow MinIO [Contributor's Guide](https://github.com/minio/minio/blob/master/CONTRIBUTING.md) 259 260 ## License 261 262 - MinIO source is licensed under the [GNU AGPLv3](https://github.com/minio/minio/blob/master/LICENSE). 263 - MinIO [documentation](https://github.com/minio/minio/tree/master/docs) is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). 264 - [License Compliance](https://github.com/minio/minio/blob/master/COMPLIANCE.md)