diff --git a/source/_components/influxdb.markdown b/source/_components/influxdb.markdown index 48c0df06362..31e2fb514b1 100644 --- a/source/_components/influxdb.markdown +++ b/source/_components/influxdb.markdown @@ -2,7 +2,7 @@ layout: component title: "InfluxDB" description: "Record events in InfluxDB." -date: 2015-12-6 13:08 +date: 2015-12-06 13:08 sidebar: true comments: false sharing: true @@ -11,7 +11,9 @@ logo: influxdb.png ha_category: "History" --- -This component will allow you to record events to an InfluxDB database. +The `influx` component makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. + +To use the `influx` component in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -22,6 +24,15 @@ influxdb: # Optional, default: home_assistant database: DB_TO_STORE_EVENTS # Optional - username: MY_USER - password: MY_PASS + username: MY_USERNAME + password: MY_PASSWORD ``` + +Configuration variables: + +- **host** (*Required*): IP address of your database host, eg. http://192.168.1.10. +- **port** (*Optional*): Port to use. Defaults to 8086. +- **database** (*Optional*): Name of the database to use. Defaults to `home_assistant` +- **username** (*Optional*): The username of the database user. +- **password** (*Optional*): The password for the database user account. +