2020-05-19 11:13:53 +02:00
---
title: minio
type: docs
---
2022-06-20 22:34:04 +02:00
[![Source Code ](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white )](https://gitea.rknet.org/ansible/xoxys.minio) [![Build Status ](https://img.shields.io/drone/build/ansible/xoxys.minio?logo=drone&server=https%3A%2F%2Fdrone.rknet.org )](https://drone.rknet.org/ansible/xoxys.minio) [![License: MIT ](https://img.shields.io/badge/License-MIT-blue.svg?label=license )](https://gitea.rknet.org/ansible/xoxys.minio/src/branch/main/LICENSE)
2020-05-19 11:13:53 +02:00
Setup Minio S3 server
2022-06-20 22:34:04 +02:00
<!-- more -->
2022-03-03 21:28:13 +01:00
- [Default Variables ](#default-variables )
- [minio_access_key ](#minio_access_key )
- [minio_base_dir ](#minio_base_dir )
- [minio_bind_ip ](#minio_bind_ip )
- [minio_bind_port ](#minio_bind_port )
- [minio_client_version ](#minio_client_version )
- [minio_console_bind_ip ](#minio_console_bind_ip )
- [minio_console_bind_port ](#minio_console_bind_port )
- [minio_cronjobs ](#minio_cronjobs )
- [minio_data_dirs ](#minio_data_dirs )
- [minio_extra_groups ](#minio_extra_groups )
- [minio_group ](#minio_group )
- [minio_kms_secret_key ](#minio_kms_secret_key )
- [minio_packages ](#minio_packages )
- [minio_secret_key ](#minio_secret_key )
- [minio_server_env_extra ](#minio_server_env_extra )
- [minio_server_opts ](#minio_server_opts )
- [minio_server_version ](#minio_server_version )
- [minio_user ](#minio_user )
- [minio_user_home ](#minio_user_home )
- [Dependencies ](#dependencies )
2020-05-19 11:13:53 +02:00
---
## Default Variables
### minio_access_key
2020-05-20 22:49:02 +02:00
Minio access key (should be changed for prod environments)
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 22:49:02 +02:00
minio_access_key: demo
2020-05-19 11:13:53 +02:00
```
### minio_base_dir
#### Default value
```YAML
minio_base_dir: /opt/minio
```
2020-05-20 09:48:15 +02:00
### minio_bind_ip
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 09:48:15 +02:00
minio_bind_ip: 127.0.0.1
2020-05-19 11:13:53 +02:00
```
2020-05-20 09:48:15 +02:00
### minio_bind_port
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 09:48:15 +02:00
minio_bind_port: 61000
2020-05-19 11:13:53 +02:00
```
2020-05-20 09:48:15 +02:00
### minio_client_version
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 09:48:15 +02:00
minio_client_version: latest
2020-05-19 11:13:53 +02:00
```
2021-07-10 14:20:39 +02:00
### minio_console_bind_ip
#### Default value
```YAML
minio_console_bind_ip: 127.0.0.1
```
### minio_console_bind_port
#### Default value
```YAML
minio_console_bind_port: 61001
```
2020-08-01 21:48:07 +02:00
### minio_cronjobs
#### Default value
```YAML
minio_cronjobs: []
```
#### Example usage
```YAML
minio_cronjobs:
- name: maintenance
minute: "0"
hour: "0"
day: "*"
month: "*"
weekday: "*"
job: "mc rm --older-than 30d --recursive --force my_bucket/logs"
user: "{{ minio_user }}"
cron_file: "minio"
2020-08-01 22:04:13 +02:00
state: "present"
2020-08-01 21:48:07 +02:00
```
2020-05-19 11:13:53 +02:00
### minio_data_dirs
#### Default value
```YAML
minio_data_dirs:
2020-05-20 09:48:15 +02:00
- '{{ minio_base_dir }}/data'
2020-05-19 11:13:53 +02:00
```
### minio_extra_groups
#### Default value
```YAML
minio_extra_groups: []
```
### minio_group
#### Default value
```YAML
minio_group: '{{ minio_user }}'
```
2021-07-10 14:20:39 +02:00
### minio_kms_secret_key
2022-03-03 21:28:13 +01:00
The key to use for encrypting the MinIO backend (users, groups, policies, and server configuration). Use the following format when specifying the encryption key: `<key-name>:<encryption-key>` Replace the `<key-name>` with any string. You must use this key name if you later migrate to using a dedicated KMS for managing encryption keys. Replace `<encryption-key>` with a 32-bit base64 encoded value.
2021-07-10 14:20:39 +02:00
2020-05-19 11:13:53 +02:00
### minio_packages
2020-05-20 22:49:02 +02:00
Packages to install as requirements for the Minio server.
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
minio_packages: []
```
### minio_secret_key
2020-05-20 22:49:02 +02:00
Minio secret key (should be changed for prod environments)
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 22:49:02 +02:00
minio_secret_key: passphrase
2020-05-19 11:13:53 +02:00
```
### minio_server_env_extra
2020-05-20 22:49:02 +02:00
Additional environment variables to be set in minio server environment.
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
minio_server_env_extra: []
```
### minio_server_opts
2020-05-20 22:49:02 +02:00
Additional Minio server CLI options.
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
minio_server_opts: []
```
2020-05-20 09:48:15 +02:00
### minio_server_version
2020-05-19 11:13:53 +02:00
2020-05-20 22:49:02 +02:00
Minio release to install.
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 09:48:15 +02:00
minio_server_version: latest
2020-05-19 11:13:53 +02:00
```
2020-05-20 22:49:02 +02:00
#### Example usage
```YAML
minio_server_version: 2020-05-16T01-33-21Z
```
2020-05-20 09:48:15 +02:00
### minio_user
2020-05-19 11:13:53 +02:00
2020-05-20 22:49:02 +02:00
Runtime user and group for the Minio server service.
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 09:48:15 +02:00
minio_user: minio
2020-05-19 11:13:53 +02:00
```
2020-05-20 09:48:15 +02:00
### minio_user_home
2020-05-19 11:13:53 +02:00
#### Default value
```YAML
2020-05-20 09:48:15 +02:00
minio_user_home: /home/{{ minio_user }}
2020-05-19 11:13:53 +02:00
```
2022-03-03 21:28:13 +01:00
2020-05-19 11:13:53 +02:00
## Dependencies
None.