2024.11.0
Home ▸ Integrations ▸

Minio

This integration adds interaction with Minio. It also enables listening for bucket notifications: see documentation

To download or upload files, folders must be added to allowlist_external_dirs.

Configuration

To enable the Minio integration in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:

minio:
  host: localhost
  port: 9000
  access_key: ACCESS_KEY
  secret_key: SECRET_KEY
  secure: false

Configuration Variables

Looking for your configuration file?
host string Required

Minio server host

port integer Required

Minio server port

access_key string Required

Minio server access key

secret_key string Required

Minio server secret key

secure boolean Required, default: false

Whether to use HTTP or HTTPS connection

listen list (Optional, default: [])

List of configurations to listen for events to

bucket string Required

Bucket to use

prefix string (Optional)

What prefix to use to filter file events

suffix string (Optional, default: .*)

What file suffix to use to filter file events

events string (Optional, default: s3:ObjectCreated:*)

What file

Automations

Automations can be triggered on new files created on the Minio server using the data_template.

#Automatically upload new local files
automation:
- alias: "Upload camera snapshot"
  triggers:
    - trigger: event
      event_type: folder_watcher
      event_data:
        event_type: created
  actions:
    - delay: "00:00:01"
    - action: minio.put
      data:
        file_path: "{{ trigger.event.data.path }}"
        bucket: "camera-image-object-detection"
        key: "input/{{ now().year }}/{{ (now().month | string).zfill(2) }}/{{ (now().day | string).zfill(2) }}/{{ trigger.event.data.file }}"
    - delay: "00:00:01"
    - action: shell_command.remove_file
      data:
        file: "{{ trigger.event.data.path }}"

- alias: "Download new Minio file"
  triggers:
    - trigger: event
      event_type: minio

  conditions: []
  actions:
    - action: minio.get
      data:
        bucket: "{{trigger.event.data.bucket}}"
        key: "{{trigger.event.data.key}}"
        file_path: "/tmp/{{ trigger.event.data.file_name }}"

Actions

These actions are provided:

  • get
  • put
  • remove

Action minio.get

Download file.

Data attribute Required Description
bucket yes Bucket to use
key yes Object key of the file
file_path yes File path on the local file system

Action minio.put

Upload file.

Data attribute Required Description
bucket yes Bucket to use
key yes Object key of the file
file_path yes File path on the local file system

Action minio.remove

Delete file.

Data attribute Required Description
bucket yes Bucket to use
key yes Object key of the file