You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Harshavardhana b512241300
Add metrics healthcheck test with JWT (#8287)
10 hours ago
.github Simplify PR template to ease new contributors' workflow (#7844) 2 months ago
browser Fix broken link to go install docs (#8090) 1 month ago
buildscripts Migrate to go1.13 to avail all new features (#8203) 2 weeks ago
cmd starts-with policy condition support issue (#7937) 19 hours ago
dockerscripts Remove healthcheck script for Docker image (#8095) 1 month ago
docs Authorize prometheus endpoint with bearer token (#7640) 1 day ago
mint Add metrics healthcheck test with JWT (#8287) 10 hours ago
pkg log server startup messages to admin console api (#8264) 1 day ago
.dockerignore Add a basic .dockerignore file to reduce docker context in `make docker` (#8282) 2 days ago
.gitignore Remove healthcheck script for Docker image (#8095) 1 month ago
.jshintrc browser: Listing should append instead of replacing previous listing (#4188) 2 years ago
.mailmap Replace Minio refs in docs with MinIO and links (#7494) 5 months ago
.mention-bot Add mention-bot config 3 years ago
.travis.yml In HDFS gateway fix non-empty folder behavior (#8254) 5 days ago
CONTRIBUTING.md doc: use make instead of go command to test changes (#7951) 2 months ago
Dockerfile Use the B2 'list' endpoint to determine file ID (#8169) 1 week ago
Dockerfile.dev Remove healthcheck script for Docker image (#8095) 1 month ago
Dockerfile.mint Fix mint hub.docker.com builds (#7908) 2 months ago
Dockerfile.release Migrate to go1.13 to avail all new features (#8203) 2 weeks ago
Dockerfile.simpleci Migrate to go1.13 to avail all new features (#8203) 2 weeks ago
LICENSE Initial commit 4 years ago
Makefile Add a basic .dockerignore file to reduce docker context in `make docker` (#8282) 2 days ago
NOTICE Replace Minio refs in docs with MinIO and links (#7494) 5 months ago
README.md Provide a friendlier error when an update fails (#8228) 1 week ago
README_zh_CN.md Fix broken link to go install docs (#8090) 1 month ago
SECURITY.md Create SECURITY.md (#7692) 3 months ago
go.mod Concurrent CSV parsing and reduce S3 select allocations (#8200) 1 week ago
go.sum Add ability to test drive speeds on a MinIO setup (#7664) 1 week ago
hound.yml browser: Listing should append instead of replacing previous listing (#4188) 2 years ago
main.go Migrate to go1.13 to avail all new features (#8203) 2 weeks ago
minio.spec Replace Minio refs in docs with MinIO and links (#7494) 5 months ago
staticcheck.conf Migrate to go1.13 to avail all new features (#8203) 2 weeks ago

README.md

MinIO Quickstart Guide

Slack Go Report Card Docker Pulls

MinIO is an object storage server released under Apache License v2.0. It is compatible[1] with Amazon S3 cloud storage service. It is best suited for storing unstructured data such as photos, videos, log files, backups and container / VM images. Size of an object can range from a few KBs to a maximum of 5TB.

MinIO server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL.

[1] MinIO in its default mode is faster and does not calculate MD5Sum unless passed by client. This may lead to incompatibility with some S3 clients like s3ql that heavily depend on MD5Sum. For such applications start MinIO with --compat option.

minio --compat server /data

Docker Container

Stable

docker pull minio/minio
docker run -p 9000:9000 minio/minio server /data

Edge

docker pull minio/minio:edge
docker run -p 9000:9000 minio/minio:edge server /data

Note: Docker will not display the autogenerated keys unless you start the container with the -it(interactive TTY) argument. Generally, it is not recommended to use autogenerated keys with containers. Please visit MinIO Docker quickstart guide for more information here

macOS

Homebrew

Install minio packages using Homebrew

brew 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.

brew uninstall minio
brew install minio/stable/minio

Binary Download

Platform Architecture URL
Apple macOS 64-bit Intel https://dl.min.io/server/minio/release/darwin-amd64/minio
chmod 755 minio
./minio server /data

GNU/Linux

Binary Download

Platform Architecture URL
GNU/Linux 64-bit Intel https://dl.min.io/server/minio/release/linux-amd64/minio
wget https://dl.min.io/server/minio/release/linux-amd64/minio
chmod +x minio
./minio server /data
Platform Architecture URL
GNU/Linux ppc64le https://dl.min.io/server/minio/release/linux-ppc64le/minio
wget https://dl.min.io/server/minio/release/linux-ppc64le/minio
chmod +x minio
./minio server /data

Microsoft Windows

Binary Download

Platform Architecture URL
Microsoft Windows 64-bit https://dl.min.io/server/minio/release/windows-amd64/minio.exe
minio.exe server D:\Photos

FreeBSD

Port

Install minio packages using pkg

pkg install minio
sysrc minio_enable=yes
sysrc minio_disks=/home/user/Photos
service minio start

Install 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.12

GO111MODULE=on go get github.com/minio/minio

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.

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

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

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

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

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

ufw allow 9000

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

ufw 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

firewall-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

firewall-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.

firewall-cmd --reload

Test using MinIO Browser

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

Screenshot

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.

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.

Upgrading MinIO

MinIO server supports rolling upgrades, i.e. you can update one MinIO instance at a time in a distributed cluster. This allows upgrades with no downtime. Upgrades can be done manually by replacing the binary with the latest release and restarting all servers in a rolling fashion. However, we recommend all our users to use mc admin update from the client. This will update all the nodes in the cluster and restart them, as shown in the following command from the MinIO client (mc):

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

Important things to remember during upgrades:

  • mc admin update will only work if the user running MinIO has write access to the parent directory where the binary is located, for example if the current binary is at /usr/local/bin/minio, you would need write access to /usr/local/bin.
  • In the case of federated setups mc admin update should be run against each cluster individually. Avoid updating mc until all clusters have been updated.
  • If you are updating the server it is always recommended (unless explicitly mentioned in MinIO server release notes), to update mc once all the servers have been upgraded using mc update.
  • mc admin update is disabled in docker/container environments, container environments provide their own mechanisms for updating running containers.
  • If you are using Vault as KMS with MinIO, ensure you have followed the Vault upgrade procedure outlined here: https://www.vaultproject.io/docs/upgrading/index.html
  • If you are using etcd with MinIO for the federation, ensure you have followed the etcd upgrade procedure outlined here: https://github.com/etcd-io/etcd/blob/master/Documentation/upgrades/upgrading-etcd.md

Explore Further

Contribute to MinIO Project

Please follow MinIO Contributor’s Guide

License

FOSSA Status