mirror of
https://github.com/minio/minio.git
synced 2024-12-27 15:45:55 -05:00
185 lines
8.5 KiB
Markdown
185 lines
8.5 KiB
Markdown
# Minio Server Config Guide [](https://slack.minio.io) [](https://goreportcard.com/report/minio/minio) [](https://hub.docker.com/r/minio/minio/) [](https://codecov.io/gh/minio/minio)
|
|
|
|
## Configuration Directory
|
|
|
|
Till Minio release `RELEASE.2018-08-02T23-11-36Z`, Minio server configuration file (`config.json`) was stored in the configuration directory specified by `--config-dir` or defaulted to `${HOME}/.minio`. However from releases after `RELEASE.2018-08-18T03-49-57Z`, the configuration file (only), has been migrated to the storage backend (storage backend is the directory passed to Minio server while starting the server).
|
|
|
|
You can specify the location of your existing config using `--config-dir`, Minio will migrate the `config.json` to your backend storage. Your current `config.json` will be renamed upon successful migration as `config.json.deprecated` in your current `--config-dir`. All your existing configurations are honored after this migration.
|
|
|
|
Additionally `--config-dir` is now a legacy option which will is scheduled for removal in future, so please update your local startup, ansible scripts accordingly.
|
|
|
|
```sh
|
|
minio server /data
|
|
```
|
|
|
|
### Certificate Directory
|
|
|
|
TLS certificates by default are stored under ``${HOME}/.minio/certs`` directory. You need to place certificates here to enable `HTTPS` based access. Read more about [How to secure access to Minio server with TLS](https://docs.minio.io/docs/how-to-secure-access-to-minio-server-with-tls).
|
|
|
|
Following is the directory structure for Minio server with TLS certificates.
|
|
|
|
```sh
|
|
$ tree ~/.minio
|
|
/home/user1/.minio
|
|
├── certs
|
|
│ ├── CAs
|
|
│ ├── private.key
|
|
│ └── public.crt
|
|
```
|
|
|
|
You can provide a custom certs directory using `--certs-dir` command line option.
|
|
|
|
### Accessing configuration file
|
|
|
|
All configuration changes can be made using [`mc admin config` get/set commands](https://github.com/minio/mc/blob/master/docs/minio-admin-complete-guide.md). Following sections provide brief explanation of fields and how to customize them. A complete example of `config.json` is available [here](https://raw.githubusercontent.com/minio/minio/master/docs/config/config.sample.json)
|
|
|
|
#### Editing configuration file fields
|
|
|
|
##### Get current configuration for Minio deployment
|
|
|
|
```sh
|
|
$ mc admin config get myminio/ > /tmp/myconfig
|
|
```
|
|
|
|
##### Set current configuration for Minio deployment
|
|
|
|
```sh
|
|
$ mc admin config set myminio < /tmp/myconfig
|
|
```
|
|
|
|
The `mc admin` config API will evolve soon to be able to configure specific fields using get/set commands.
|
|
|
|
#### Version
|
|
|
|
|Field|Type|Description|
|
|
|:---|:---|:---|
|
|
|``version``|_string_| `version` determines the configuration file format. Any older version will automatically be migrated to the latest version upon startup. [DO NOT EDIT THIS FIELD MANUALLY]|
|
|
|
|
#### Credential
|
|
|
|
|Field|Type|Description|
|
|
|:---|:---|:---|
|
|
|``credential``| | Auth credential for object storage and web access.|
|
|
|``credential.accessKey`` | _string_ | Access key of minimum 3 characters in length. You may override this field with `MINIO_ACCESS_KEY` environment variable.|
|
|
|``credential.secretKey`` | _string_ | Secret key of minimum 8 characters in length. You may override this field with `MINIO_SECRET_KEY` environment variable.|
|
|
|
|
> NOTE: In distributed setup it is mandatory to use environment variables `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` for credentials.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
export MINIO_ACCESS_KEY=admin
|
|
export MINIO_SECRET_KEY=password
|
|
minio server /data
|
|
```
|
|
|
|
#### Region
|
|
|
|
|Field|Type|Description|
|
|
|:---|:---|:---|
|
|
|``region``| _string_ | `region` describes the physical location of the server. By default it is blank. You may override this field with `MINIO_REGION` environment variable. If you are unsure leave it unset.|
|
|
|
|
Example:
|
|
|
|
```sh
|
|
export MINIO_REGION="my_region"
|
|
minio server /data
|
|
```
|
|
|
|
#### Worm
|
|
|
|
|Field|Type|Description|
|
|
|:---|:---|:---|
|
|
|``worm``| _string_ | Enable this to turn on Write-Once-Read-Many. By default it is set to `off`. You may override this field with ``MINIO_WORM`` environment variable.|
|
|
|
|
Example:
|
|
|
|
```sh
|
|
export MINIO_WORM=on
|
|
minio server /data
|
|
```
|
|
|
|
### Storage Class
|
|
|
|
|Field|Type|Description|
|
|
|:---|:---|:---|
|
|
|``storageclass``| | Set storage class for configurable data and parity, as per object basis.|
|
|
|``storageclass.standard`` | _string_ | Value for standard storage class. It should be in the format `EC:Parity`, for example to set 4 disk parity for standard storage class objects, set this field to `EC:4`.|
|
|
|``storageclass.rrs`` | _string_ | Value for reduced redundancy storage class. It should be in the format `EC:Parity`, for example to set 3 disk parity for reduced redundancy storage class objects, set this field to `EC:3`.|
|
|
|
|
By default, parity for objects with standard storage class is set to `N/2`, and parity for objects with reduced redundancy storage class objects is set to `2`. Read more about storage class support in Minio server [here](https://github.com/minio/minio/blob/master/docs/erasure/storage-class/README.md).
|
|
|
|
### Cache
|
|
|
|
|Field|Type|Description|
|
|
|:---|:---|:---|
|
|
|``drives``| _[]string_ | List of mounted file system drives with [`atime`](http://kerolasa.github.io/filetimes.html) support enabled|
|
|
|``exclude`` | _[]string_ | List of wildcard patterns for prefixes to exclude from cache |
|
|
|``expiry`` | _int_ | Days to cache expiry |
|
|
|``maxuse`` | _int_ | Percentage of disk available to cache |
|
|
|
|
#### Notify
|
|
|
|
|Field|Type|Description|
|
|
|:---|:---|:---|
|
|
|``notify``| |Notify enables bucket notification events for lambda computing via the following targets.|
|
|
|``notify.amqp``| |[Configure to publish Minio events via AMQP target.](https://docs.minio.io/docs/minio-bucket-notification-guide#AMQP)|
|
|
|``notify.nats``| |[Configure to publish Minio events via NATS target.](https://docs.minio.io/docs/minio-bucket-notification-guide#NATS)|
|
|
|``notify.elasticsearch``| |[Configure to publish Minio events via Elasticsearch target.](https://docs.minio.io/docs/minio-bucket-notification-guide#Elasticsearch)|
|
|
|``notify.redis``| |[Configure to publish Minio events via Redis target.](https://docs.minio.io/docs/minio-bucket-notification-guide#Redis)|
|
|
|``notify.postgresql``| |[Configure to publish Minio events via PostgreSQL target.](https://docs.minio.io/docs/minio-bucket-notification-guide#PostgreSQL)|
|
|
|``notify.kafka``| |[Configure to publish Minio events via Apache Kafka target.](https://docs.minio.io/docs/minio-bucket-notification-guide#apache-kafka)|
|
|
|``notify.webhook``| |[Configure to publish Minio events via Webhooks target.](https://docs.minio.io/docs/minio-bucket-notification-guide#webhooks)|
|
|
|``notify.mysql``| |[Configure to publish Minio events via MySql target.](https://docs.minio.io/docs/minio-bucket-notification-guide#MySQL)|
|
|
|``notify.mqtt``| |[Configure to publish Minio events via MQTT target.](https://docs.minio.io/docs/minio-bucket-notification-guide#MQTT)|
|
|
|
|
## Environment only settings
|
|
|
|
### Browser
|
|
|
|
Enable or disable access to web UI. By default it is set to `on`. You may override this field with `MINIO_BROWSER` environment variable.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
export MINIO_BROWSER=off
|
|
minio server /data
|
|
```
|
|
|
|
### Domain
|
|
|
|
By default, Minio supports path-style requests that are of the format http://mydomain.com/bucket/object. `MINIO_DOMAIN` environment variable is used to enable virtual-host-style requests. If the request `Host` header matches with `(.+).mydomain.com` then the matched pattern `$1` is used as bucket and the path is used as object. More information on path-style and virtual-host-style [here](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAPI.html)
|
|
Example:
|
|
|
|
```sh
|
|
export MINIO_DOMAIN=mydomain.com
|
|
minio server /data
|
|
```
|
|
|
|
### Drive Sync
|
|
|
|
By default, Minio writes to disk in synchronous mode for all metadata operations. Set `MINIO_DRIVE_SYNC` environment variable to enable synchronous mode for all data operations as well.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
export MINIO_DRIVE_SYNC=on
|
|
minio server /data
|
|
```
|
|
|
|
### HTTP Trace
|
|
|
|
By default, Minio disables the feature to log HTTP trace. You may enable this feature by setting `MINIO_HTTP_TRACE` environment variable.
|
|
|
|
Example:
|
|
|
|
```sh
|
|
export MINIO_HTTP_TRACE=/var/log/minio.log
|
|
minio server /data
|
|
```
|
|
|
|
## Explore Further
|
|
|
|
* [Minio Quickstart Guide](https://docs.minio.io/docs/minio-quickstart-guide)
|
|
* [Configure Minio Server with TLS](https://docs.minio.io/docs/how-to-secure-access-to-minio-server-with-tls)
|