addons/mariadb

Hass.io Core Add-on: MariaDB

MariaDB database for Home Assistant.

About

You can use this add-on to install MariaDB, which is an open-source (GPLv2 licensed) database. MariaDB can be used as the database backend for Home Assistant. For more information, please see MariaDB

Installation

Follow these steps to get the add-on installed on your system:

1. Navigate in your Home Assistant frontend to Hass.io -> Add-on Store.
2. Find the "MariaDB" add-on and click it.
3. Click on the "INSTALL" button.

How to use

1. Set the logins -> password field to something strong and unique.
2. Start the add-on.
3. Check the add-on log output to see the result.
4. Add recorder component to your Home Assistant configuration.

Add-on Configuration

The MariaDB server add-on can be tweaked to your likings. This section describes each of the add-on configuration options.

Example add-on configuration:

{
  "databases": [
    "homeassistant"
  ],
  "logins": [
    {
      "username": "hass",
      "host": "%",
      "password": null
    }
  ],
  "rights": [
    {
      "username": "hass",
      "host": "%",
      "database": "homeassistant",
      "grant": "ALL PRIVILEGES ON"
    }
  ]
}

Option: databases (required)

Database name, e.g., homeassistant. Multiple are allowed.

Option: logins (required)

This section defines a create user definition in MariaDB. Create User documentation.

Option: logins.username (required)

Database user login, e.g., hass. User Name documentation.

Option: logins.host (required)

Hostname allowed to connect to database. Host Name documentation.

Option: logins.password (required)

Password for user login. This should be strong and unique.

Option: rights (required)

This section grant privileges to users in MariaDB. Grant documentation.

Option: rights.username (required)

This should be the same user name defined in logins -> username.

Option: rights.host (required)

This should be the same hostname defined in logins -> host.

Option: rights.database (required)

This should be the same database defined in databases.

Option: rights.grant (required)

This is the grant statement giving your user access to the database.

Home Assistant Configuration

MariaDB will be used by the recorder and history components within Home Assistant. For more information about setting this up, see the MariaDB documentation for Home Assistant.

Example Home Assistant configuration:

recorder:
  db_url: mysql://hass:password@core-mariadb/homeassistant?charset=utf8

Support

Got questions?

You have several options to get them answered:

• The Home Assistant Discord Chat Server.
• The Home Assistant Community Forum.
• Join the Reddit subreddit in /r/homeassistant

In case you've found a bug, please open an issue on our GitHub.