mirror of https://github.com/minio/minio.git
116 lines
6.2 KiB
Markdown
116 lines
6.2 KiB
Markdown
# MinIO Quickstart Guide
|
||
|
||
[](https://slack.min.io) [](https://hub.docker.com/r/minio/minio/) [](https://github.com/minio/minio/blob/master/LICENSE)
|
||
|
||
[](https://min.io)
|
||
|
||
MinIO is a high-performance, S3-compatible object storage solution released under the GNU AGPL v3.0 license.
|
||
Designed for speed and scalability, it powers AI/ML, analytics, and data-intensive workloads with industry-leading performance.
|
||
|
||
🔹 S3 API Compatible – Seamless integration with existing S3 tools
|
||
🔹 Built for AI & Analytics – Optimized for large-scale data pipelines
|
||
🔹 High Performance – Ideal for demanding storage workloads.
|
||
|
||
This README provides instructions for building MinIO from source and deploying onto baremetal hardware.
|
||
For more complete documentation, see [the MinIO documentation website](https://docs.min.io/community/minio-object-store/index.html)
|
||
|
||
## MinIO is Open Source Software
|
||
|
||
We designed MinIO as Open Source software for the Open Source software community.
|
||
We encourage the community to remix, redesign, and reshare MinIO under the terms of the AGPLv3 license.
|
||
|
||
All usage of MinIO in your application stack requires validation against AGPLv3 obligations, which include but are not limited to the release of modified code to the community from which you have benefited.
|
||
Any commercial/proprietary usage of the AGPLv3 software, including repackaging or reselling services/features, is done at your own risk.
|
||
|
||
The AGPLv3 provides no obligation by any party to support, maintain, or warranty the original or any modified work.
|
||
All support is provided on a best-effort basis through Github and our [Slack](https//slack.min.io) channel, and any member of the community is welcome to contribute and assist others in their usage of the software.
|
||
|
||
MinIO [AIStor](https://www.min.io/product/aistor) includes enterprise-grade support and licensing for workloads which require commercial or proprietary usage and production-level SLA/SLO-backed support.
|
||
For more information, [reach out for a quote](https://min.io/pricing).
|
||
|
||
## Legacy Releases
|
||
|
||
MinIO has no planned or scheduled releases for this repository.
|
||
While a new release may be cut at any time, there is no timeline for when a subsequent release may occur.
|
||
All existing releases remain accessible through Github or at https://dl.min.io/server/minio/release/ .
|
||
|
||
## Install from Source
|
||
|
||
Use the following commands to compile and run a standalone MinIO server from source.
|
||
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.24](https://golang.org/dl/#stable)
|
||
|
||
```sh
|
||
go install github.com/minio/minio@latest
|
||
```
|
||
|
||
You can alternatively run `go build` and use the `GOOS` and `GOARCH` environment variables to control the OS and architecture target.
|
||
For example:
|
||
|
||
```
|
||
env GOOS=linux GOARCh=arm64 go build
|
||
```
|
||
|
||
Start MinIO by running `minio server PATH` where `PATH` is any empty folder on your local filesystem.
|
||
|
||
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:
|
||
|
||
```sh
|
||
mc alias set local http://localhost:9000 minioadmin minioadmin
|
||
mc admin info local
|
||
```
|
||
|
||
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://docs.min.io/community/minio-object-store/developers/minio-drivers.html> to view MinIO SDKs for supported languages.
|
||
|
||
> [!NOTE]
|
||
> Production environments using compiled-from-source MinIO binaries do so at their own risk.
|
||
> The AGPLv3 license provides no warranties nor liabilites for any such usage.
|
||
|
||
## 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 to choose a specific port use `--console-address` to pick a specific interface and port.
|
||
|
||
### 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.
|
||
|
||
The following commands set a local alias, validate the server information, create a bucket, copy data to that bucket, and list the contents of the bucket.
|
||
|
||
```sh
|
||
mc alias set local http://localhost:9000 minioadmin minioadmin
|
||
mc admin info
|
||
mc mb data
|
||
mc cp ~/Downloads/mydata data/
|
||
mc ls data/
|
||
```
|
||
|
||
Follow the MinIO Client [Quickstart Guide](https://docs.min.io/community/minio-object-store/reference/minio-mc.html#quickstart) for further instructions.
|
||
|
||
## Explore Further
|
||
|
||
- [The MinIO documentation website](https://docs.min.io/community/minio-object-store/index.html)
|
||
- [MinIO Erasure Code Overview](https://docs.min.io/community/minio-object-store/operations/concepts/erasure-coding.html)
|
||
- [Use `mc` with MinIO Server](https://docs.min.io/community/minio-object-store/reference/minio-mc.html)
|
||
- [Use `minio-go` SDK with MinIO Server](https://docs.min.io/community/minio-object-store/developers/go/minio-go.html)
|
||
|
||
## Contribute to MinIO Project
|
||
|
||
Please follow MinIO [Contributor's Guide](https://github.com/minio/minio/blob/master/CONTRIBUTING.md) for guidance on making new contributions to the repository.
|
||
|
||
## License
|
||
|
||
- MinIO source is licensed under the [GNU AGPLv3](https://github.com/minio/minio/blob/master/LICENSE).
|
||
- MinIO [documentation](https://github.com/minio/minio/tree/master/docs) is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
|
||
- [License Compliance](https://github.com/minio/minio/blob/master/COMPLIANCE.md)
|