MyFavMirrors/minio
1
0
Fork 0
mirror of https://github.com/minio/minio.git synced 2025-04-30 14:47:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update config documentation (#6634)

Browse Source
This commit is contained in:
Nitish Tiwari 2018-10-17 05:15:04 +05:30 committed by Harshavardhana
parent 362ebdcbab
commit ef585037a0
2 changed files with 216 additions and 164 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/config/README.md
View File

@ -1,9 +1,8 @@
# Minio Server `config.json` (v27) Guide [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io) [![Go Report Card](https://goreportcard.com/badge/minio/minio)](https://goreportcard.com/report/minio/minio) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/) [![codecov](https://codecov.io/gh/minio/minio/branch/master/graph/badge.svg)](https://codecov.io/gh/minio/minio) # Minio Server Config Guide [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io) [![Go Report Card](https://goreportcard.com/badge/minio/minio)](https://goreportcard.com/report/minio/minio) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/) [![codecov](https://codecov.io/gh/minio/minio/branch/master/graph/badge.svg)](https://codecov.io/gh/minio/minio)
Minio server stored all its configuration data in `${HOME}/.minio/config.json` file by default.For all releases beyond minio.RELEASE.2017-08-05T00-00-53Z, the configuration data will be migrated to the Minio's backend directory. 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 detailed explanation of each 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)
## Configuration Directory ## Configuration Directory
The default configuration directory is `${HOME}/.minio`. Till the release `RELEASE.2018-08-02T23-11-36Z` , Minio server configuration file (`config.json`) was stored in the configuration directory. However for releases beyond `RELEASE.2018-08-18T03-49-57Z`, the configuration file (only), has been migrated to the backend storage directory.
The default configuration directory is `${HOME}/.minio`. Till the release `RELEASE.2018-08-02T23-11-36Z`, Minio server configuration file (`config.json`) was stored in the configuration directory. However for releases beyond `RELEASE.2018-08-18T03-49-57Z`, the configuration file (only), has been migrated to the storage back-end (storage back-end is the directory passed to Minio server while starting the server).
You can override the default configuration directory using `--config-dir` command-line option. Please note that this won't have an effect on the `config.json` file as it is always stored on the backend storage, along with data. Minio server generates a new `config.json` with auto-generated access credentials when its started for the first time. You can override the default configuration directory using `--config-dir` command-line option. Please note that this won't have an effect on the `config.json` file as it is always stored on the backend storage, along with data. Minio server generates a new `config.json` with auto-generated access credentials when its started for the first time.
@ -12,6 +11,7 @@ minio server --config-dir /etc/minio /data
``` ```
### Certificate Directory ### Certificate Directory
TLS certificates 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). TLS certificates 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. Following is the directory structure for Minio server with TLS certificates.
@ -25,14 +25,22 @@ $ tree ~/.minio
│   └── public.crt │   └── public.crt
``` ```
### Configuration Fields ### Accessing configuration file
#### Editing Configuration Fields
For releases after minio.RELEASE.2017-08-05T00-00-53Z, configuration changes can be done using [mc]((https://docs.minio.io/docs/minio-client-quickstart-guide)) 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
Configuration changes should be done using [mc]((https://docs.minio.io/docs/minio-client-quickstart-guide))
##### Get current configuration for Minio deployment ##### Get current configuration for Minio deployment
```sh ```sh
$ mc admin config get myminio/ > /tmp/myconfig $ mc admin config get myminio/ > /tmp/myconfig
``` ```
##### Set current configuration for Minio deployment ##### Set current configuration for Minio deployment
```sh ```sh
$ mc admin config set myminio < /tmp/myconfig $ mc admin config set myminio < /tmp/myconfig
``` ```
@ -40,11 +48,13 @@ $ 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. The `mc admin` config API will evolve soon to be able to configure specific fields using get/set commands.
#### Version #### Version
|Field|Type|Description| |Field|Type|Description|
|:---|:---|:---| |:---|:---|:---|
|``version``|_string_| `version` determines the configuration file format. Any older version will be automatically be migrated to the latest version upon startup. [DO NOT EDIT THIS FIELD MANUALLY]| |``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 #### Credential
|Field|Type|Description| |Field|Type|Description|
|:---|:---|:---| |:---|:---|:---|
|``credential``| | Auth credential for object storage and web access.| |``credential``| | Auth credential for object storage and web access.|
@ -60,6 +70,7 @@ minio server /data
``` ```
#### Region #### Region
|Field|Type|Description| |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.| |``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.|
@ -72,6 +83,7 @@ minio server /data
``` ```
#### Worm #### Worm
|Field|Type|Description| |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.| |``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.|
@ -84,6 +96,7 @@ minio server /data
``` ```
### Storage Class ### Storage Class
|Field|Type|Description| |Field|Type|Description|
|:---|:---|:---| |:---|:---|:---|
|``storageclass``| | Set storage class for configurable data and parity, as per object basis.| |``storageclass``| | Set storage class for configurable data and parity, as per object basis.|
@ -93,6 +106,7 @@ minio server /data
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). 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 ### Cache
|Field|Type|Description| |Field|Type|Description|
|:---|:---|:---| |:---|:---|:---|
|``drives``| _[]string_ | List of mounted file system drives with [`atime`](http://kerolasa.github.io/filetimes.html) support enabled| |``drives``| _[]string_ | List of mounted file system drives with [`atime`](http://kerolasa.github.io/filetimes.html) support enabled|
@ -101,6 +115,7 @@ By default, parity for objects with standard storage class is set to `N/2`, and
|``maxuse`` | _int_ | Percentage of disk available to cache | |``maxuse`` | _int_ | Percentage of disk available to cache |
#### Notify #### Notify
|Field|Type|Description| |Field|Type|Description|
|:---|:---|:---| |:---|:---|:---|
|``notify``| |Notify enables bucket notification events for lambda computing via the following targets.| |``notify``| |Notify enables bucket notification events for lambda computing via the following targets.|
@ -117,22 +132,28 @@ By default, parity for objects with standard storage class is set to `N/2`, and
## Environment only settings ## Environment only settings
#### Browser #### 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. 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: Example:
```sh ```sh
export MINIO_BROWSER=off export MINIO_BROWSER=off
minio server /data minio server /data
``` ```
### Domain ### Domain
By default, Minio supports path-style requests which look like http://mydomain.com/bucket/object. MINIO_DOMAIN environmental variable is used to enable virtual-host-style requests. If the request `Host` header matches with `(.+).mydomain.com` then the mattched 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) By default, Minio supports path-style requests which look like http://mydomain.com/bucket/object. MINIO_DOMAIN environmental variable is used to enable virtual-host-style requests. If the request `Host` header matches with `(.+).mydomain.com` then the mattched 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: Example:
```sh ```sh
export MINIO_DOMAIN=mydomain.com export MINIO_DOMAIN=mydomain.com
minio server /data minio server /data
``` ```
## Explore Further ## Explore Further
* [Minio Quickstart Guide](https://docs.minio.io/docs/minio-quickstart-guide) * [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)

205
docs/config/config.sample.json
View File

@ -1,10 +1,12 @@
{ {
"version": "30", "version": "31",
"credential": { "credential": {
"accessKey": "USWUXHGYZQYFYFFIT3RE", "accessKey": "36J9X8EZI4KEV1G7EHXA",
"secretKey": "MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03" "secretKey": "ECk2uqOoNqvtJIMQ3WYugvmNPL_-zm3WcRqP5vUM",
"expiration": "1970-01-01T00:00:00Z",
"status": "enabled"
}, },
"region": "us-east-1", "region": "",
"worm": "off", "worm": "off",
"storageclass": { "storageclass": {
"standard": "", "standard": "",
@ -13,20 +15,33 @@
"cache": { "cache": {
"drives": [], "drives": [],
"expiry": 90, "expiry": 90,
"exclude": [], "maxuse": 80,
"maxuse": 80 "exclude": []
}, },
"usage": { "kms": {
"interval": "3h" "vault": {
"endpoint": "",
"auth": {
"type": "",
"approle": {
"id": "",
"secret": ""
}
},
"key-id": {
"name": "",
"version": 0
}
}
}, },
"notify": { "notify": {
"amqp": { "amqp": {
"1": { "1": {
"enable": true, "enable": false,
"url": "amqp://myuser:mypassword@localhost:5672", "url": "",
"exchange": "bucketevents", "exchange": "",
"routingKey": "bucketlogs", "routingKey": "",
"exchangeType": "fanout", "exchangeType": "",
"deliveryMode": 0, "deliveryMode": 0,
"mandatory": false, "mandatory": false,
"immediate": false, "immediate": false,
@ -36,13 +51,64 @@
"autoDeleted": false "autoDeleted": false
} }
}, },
"elasticsearch": {
"1": {
"enable": false,
"format": "",
"url": "",
"index": ""
}
},
"kafka": {
"1": {
"enable": false,
"brokers": null,
"topic": "",
"tls": {
"enable": false,
"skipVerify": false,
"clientAuth": 0
},
"sasl": {
"enable": false,
"username": "",
"password": ""
}
}
},
"mqtt": {
"1": {
"enable": false,
"broker": "",
"topic": "",
"qos": 0,
"clientId": "",
"username": "",
"password": "",
"reconnectInterval": 0,
"keepAliveInterval": 0
}
},
"mysql": {
"1": {
"enable": false,
"format": "",
"dsnString": "",
"table": "",
"host": "",
"port": "",
"user": "",
"password": "",
"database": ""
}
},
"nats": { "nats": {
"1": { "1": {
"enable": true, "enable": false,
"address": "0.0.0.0:4222", "address": "",
"subject": "bucketevents", "subject": "",
"username": "yourusername", "username": "",
"password": "yoursecret", "password": "",
"token": "", "token": "",
"secure": false, "secure": false,
"pingInterval": 0, "pingInterval": 0,
@ -55,81 +121,32 @@
} }
} }
}, },
"elasticsearch": { "postgresql": {
"1": { "1": {
"enable": true, "enable": false,
"format": "namespace", "format": "",
"url": "http://127.0.0.1:9200", "connectionString": "",
"index": "bucketevents" "table": "",
"host": "",
"port": "",
"user": "",
"password": "",
"database": ""
} }
}, },
"redis": { "redis": {
"1": { "1": {
"enable": true, "enable": false,
"format": "namespace", "format": "",
"address": "127.0.0.1:6379", "address": "",
"password": "yoursecret", "password": "",
"key": "bucketevents" "key": ""
}
},
"postgresql": {
"1": {
"enable": true,
"format": "namespace",
"connectionString": "",
"table": "bucketevents",
"host": "127.0.0.1",
"port": "5432",
"user": "postgres",
"password": "mypassword",
"database": "bucketevents_db"
}
},
"kafka": {
"1": {
"enable": true,
"brokers": ["localhost:9092"],
"topic": "bucketevents",
"tls" : {
"enable" : true,
"skipVerify" : false,
"clientAuth" : 0
},
"sasl" : {
"enable" : true,
"username" : "kafka",
"password" : "kafkapasswd"
}
} }
}, },
"webhook": { "webhook": {
"1": {
"enable": true,
"endpoint": "http://requestb.in/1525x9n1"
}
},
"mysql": {
"1": {
"enable": true,
"format": "namespace",
"dsnString": "",
"table": "minio_images",
"host": "172.17.0.1",
"port": "3306",
"user": "root",
"password": "password",
"database": "miniodb"
}
},
"mqtt": {
"1": { "1": {
"enable": false, "enable": false,
"broker": "tcp://localhost:1883", "endpoint": ""
"topic": "minio",
"qos": 1,
"clientId": "minio",
"username": "",
"password": ""
} }
} }
}, },
@ -138,20 +155,34 @@
"enabled": true "enabled": true
}, },
"http": { "http": {
"1": { "target1": {
"enabled": false, "enabled": false,
"endpoint": "" "endpoint": "https://username:password@example.com/api"
} }
} }
}, },
"compress": {
"enabled": false,
"extensions": [
".txt",
".log",
".csv",
".json"
],
"mime-types": [
"text/csv",
"text/plain",
"application/json"
]
},
"openid": { "openid": {
"jwks": { "jwks": {
"url": "" "url": null
} }
}, },
"policy": { "policy": {
"opa": { "opa": {
"url": "", "url": null,
"authToken": "" "authToken": ""
} }
} }