|
|
|
@ -5,12 +5,11 @@
|
|
|
|
|
|
|
|
|
|
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 baremetal hardware, including Docker-based installations. For Kubernetes environments,
|
|
|
|
|
use the [MinIO Kubernetes Operator](https://github.com/minio/operator/blob/master/README.md).
|
|
|
|
|
This README provides quickstart instructions on running MinIO on baremetal hardware, including container-based installations. For Kubernetes environments, use the [MinIO Kubernetes Operator](https://github.com/minio/operator/blob/master/README.md).
|
|
|
|
|
|
|
|
|
|
# Docker Installation
|
|
|
|
|
# Container Installation
|
|
|
|
|
|
|
|
|
|
Use the following commands to run a standalone MinIO server on a Docker container.
|
|
|
|
|
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,
|
|
|
|
@ -19,10 +18,10 @@ for more complete documentation.
|
|
|
|
|
|
|
|
|
|
## Stable
|
|
|
|
|
|
|
|
|
|
Run the following command to run the latest stable image of MinIO on a Docker container using an ephemeral data volume:
|
|
|
|
|
Run the following command to run the latest stable image of MinIO as a container using an ephemeral data volume:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
docker run -p 9000:9000 minio/minio server /data
|
|
|
|
|
podman run -p 9000:9000 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
|
|
|
|
@ -33,38 +32,13 @@ You can also connect using any S3-compatible tool, such as the MinIO Client `mc`
|
|
|
|
|
[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/docs/ and click **MinIO SDKs** in the navigation to view MinIO SDKs for supported languages.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
> NOTE: To deploy MinIO on Docker with persistent storage, you must map local persistent directories from the host OS to the container using the
|
|
|
|
|
`docker -v` option. For example, `-v /mnt/data:/data` maps the host OS drive at `/mnt/data` to `/data` on the Docker container.
|
|
|
|
|
|
|
|
|
|
## Edge
|
|
|
|
|
|
|
|
|
|
Run the following command to run the bleeding-edge image of MinIO on a Docker container using an ephemeral data volume:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
docker run -p 9000:9000 minio/minio:edge 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`](#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 Docker with persistent storage, you must map local persistent directories from the host OS to the container using the
|
|
|
|
|
`docker -v` option. For example, `-v /mnt/data:/data` maps the host OS drive at `/mnt/data` to `/data` on the Docker container.
|
|
|
|
|
> 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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html)
|
|
|
|
|
for more complete documentation.
|
|
|
|
|
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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html) for more complete documentation.
|
|
|
|
|
|
|
|
|
|
## Homebrew (recommended)
|
|
|
|
|
|
|
|
|
@ -82,13 +56,9 @@ brew 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.
|
|
|
|
|
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`](#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.
|
|
|
|
|
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://docs.min.io/docs/ and click **MinIO SDKs** in the navigation to view MinIO SDKs for supported languages.
|
|
|
|
|
|
|
|
|
|
## Binary Download
|
|
|
|
|
|
|
|
|
@ -100,14 +70,9 @@ 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`](#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.
|
|
|
|
|
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`](#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
|
|
|
|
|
|
|
|
|
@ -130,19 +95,11 @@ The following table lists supported architectures. Replace the `wget` URL with t
|
|
|
|
|
| 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.
|
|
|
|
|
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`](#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.
|
|
|
|
|
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://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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html)
|
|
|
|
|
for more complete documentation.
|
|
|
|
|
> 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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html) for more complete documentation.
|
|
|
|
|
|
|
|
|
|
# Microsoft Windows
|
|
|
|
|
|
|
|
|
@ -158,29 +115,11 @@ Use the following command to run a standalone MinIO server on the Windows host.
|
|
|
|
|
minio.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.
|
|
|
|
|
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`](#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.
|
|
|
|
|
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://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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html)
|
|
|
|
|
for more complete documentation.
|
|
|
|
|
|
|
|
|
|
# FreeBSD
|
|
|
|
|
|
|
|
|
|
MinIO does not provide an official FreeBSD binary. However, FreeBSD maintains an [upstream release](https://www.freshports.org/www/minio) using [pkg](https://github.com/freebsd/pkg):
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
pkg install minio
|
|
|
|
|
sysrc minio_enable=yes
|
|
|
|
|
sysrc minio_disks=/home/user/Photos
|
|
|
|
|
service minio start
|
|
|
|
|
```
|
|
|
|
|
> 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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html) for more complete documentation.
|
|
|
|
|
|
|
|
|
|
# Install from Source
|
|
|
|
|
|
|
|
|
@ -190,19 +129,11 @@ Use the following commands to compile and run a standalone MinIO server from sou
|
|
|
|
|
GO111MODULE=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.
|
|
|
|
|
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`](#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.
|
|
|
|
|
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://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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html)
|
|
|
|
|
for more complete documentation.
|
|
|
|
|
> 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](https://docs.min.io/docs/minio-erasure-code-quickstart-guide.html) for more complete documentation.
|
|
|
|
|
|
|
|
|
|
MinIO strongly recommends *against* using compiled-from-source MinIO servers for production environments.
|
|
|
|
|
|
|
|
|
@ -273,6 +204,8 @@ The above statement is also valid for all gateway backends.
|
|
|
|
|
## 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.
|
|
|
|
|
|
|
|
|
|
| Dashboard | Creating a bucket |
|
|
|
|
|
| ------------- | ------------- |
|
|
|
|
|
| ![Dashboard](https://github.com/minio/minio/blob/master/docs/screenshots/pic1.png?raw=true) | ![Dashboard](https://github.com/minio/minio/blob/master/docs/screenshots/pic2.png?raw=true) |
|
|
|
|
|