jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Minimizing of the configuration sample (#1019)

Browse source
This commit is contained in:
Fabian Affolter 2016-10-01 12:09:50 +02:00 • committed by GitHub
parent 227d5a3f4f
commit 0bc1fc4e3c
7 changed files with 44 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

40
source/_components/influxdb.markdown
View file

@ -19,7 +19,31 @@ To use the `influxdb` component in your installation, add the following to your
```yaml
# Example configuration.yaml entry
influxdb:
host: DB_HOST_IP_ADDRESS
```
Configuration variables:
- **host** (*Optional*): IP address of your database host, eg. http://192.168.1.10. Defaults to `localhost`.
- **port** (*Optional*): Port to use. Defaults to 8086.
- **username** (*Optional*): The username of the database user.
- **password** (*Optional*): The password for the database user account.
- **database** (*Optional*): Name of the database to use. Defaults to `home_assistant`. The database must already exist.
- **ssl** (*Optional*): Use https instead of http to connect. Defaults to false.
- **verify_ssl** (*Optional*): Verify SSL certificate for https request. Defaults to false.
- **blacklist** (*Optional*): List of entities not logged to InfluxDB.
- **whitelist** (*Optional*): List of the entities (only) that will be logged to InfluxDB. If not set, all entities will be logged. Values set by the **blacklist** option will prevail.
- **tags** (*Optional*): Tags to mark the data.
## {% linkable_title Examples %}
In this section you find some real life examples of how to use this component.
### {% linkable_title Full configuration %}
```yaml
influxdb:
host: 192.168.1.190
port: 20000
database: DB_TO_STORE_EVENTS
username: MY_USERNAME
@ -36,17 +60,3 @@ influxdb:
instance: prod
source: hass
```
Configuration variables:
- **host** (*Optional*): IP address of your database host, eg. http://192.168.1.10. Defaults to localhost.
- **username** (*Required*): The username of the database user.
- **password** (*Required*): The password for the database user account.
- **port** (*Optional*): Port to use. Defaults to 8086.
- **database** (*Optional*): Name of the database to use. Defaults to `home_assistant`. The database must already exist.
- **ssl** (*Optional*): Use https instead of http to connect. Defaults to false.
- **verify_ssl** (*Optional*): Verify SSL certificate for https request. Defaults to false.
- **blacklist** (*Optional*): List of entities not logged to InfluxDB.
- **whitelist** (*Optional*): List of the entities (only) that will be logged to InfluxDB. If not set, all entities will be logged. Values set by the **blacklist** option will prevail.
- **tags** (*Optional*): Tags to mark the data.