Minimizing of the configuration sample (#1019)

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

View File

@ -19,9 +19,6 @@ To enable this component, add the following lines to your `configuration.yaml`:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
graphite: graphite:
host: IP_ADDRESS
port: 2003
prefix: ha
``` ```
Configuration variables: Configuration variables:

View File

@ -19,7 +19,31 @@ To use the `influxdb` component in your installation, add the following to your
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
influxdb: 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 port: 20000
database: DB_TO_STORE_EVENTS database: DB_TO_STORE_EVENTS
username: MY_USERNAME username: MY_USERNAME
@ -36,17 +60,3 @@ influxdb:
instance: prod instance: prod
source: hass 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.

View File

@ -19,9 +19,16 @@ To enable the logbook in your installation, add the following to your `configura
# Example configuration.yaml entry # Example configuration.yaml entry
logbook: logbook:
``` ```
Configuration variables:
- **exclude** (*Optional*): Configure which components should **not** create logbook enties.
- **entities** (*Optional*): The list of entity ids to be excluded from creating logbook entries.
- **domains** (*Optional*): The list of domains to be excluded from creating logbook entries.
If you want to exclude messages of some entities or domains from the logbook just add the `exclude` parameter like: If you want to exclude messages of some entities or domains from the logbook just add the `exclude` parameter like:
```yaml ```yaml
# Example configuration.yaml entry
logbook: logbook:
exclude: exclude:
entities: entities:
@ -32,12 +39,6 @@ logbook:
- weblink - weblink
``` ```
Configuration variables:
- **exclude** (*Optional*): Configure which components should **not** create logbook enties.
- **entities** (*Optional*): The list of entity ids to be excluded from creating logbook entries.
- **domains** (*Optional*): The list of domains to be excluded from creating logbook entries.
### {% linkable_title Exclude Events %} ### {% linkable_title Exclude Events %}
Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. For instance you use the `sensor.date`to show the current date in the UI, but you do not want an logbook entry for that sensor every day. Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. For instance you use the `sensor.date`to show the current date in the UI, but you do not want an logbook entry for that sensor every day.

View File

@ -17,9 +17,9 @@ To use the `logentries` component in your installation, add the following to you
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
logentries: logentries:
token: your-log-token-here token: TOKEN
``` ```
Configuration variables: Configuration variables:
- **token** (*Required*): Your Logentries log token - **token** (*Required*): Your Logentries log token.

View File

@ -23,7 +23,6 @@ To setup the `recorder` component in your installation, add the following to you
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
recorder: recorder:
purge_days: 14
``` ```
Configuration variables: Configuration variables:
@ -31,6 +30,14 @@ Configuration variables:
- **purge_days** (*Optional*): Delete events and states older than x days. - **purge_days** (*Optional*): Delete events and states older than x days.
- **db_url** (*Optional*): The URL which point to your database. - **db_url** (*Optional*): The URL which point to your database.
```yaml
# Example configuration.yaml entry
recorder:
purge_days: 5
db_url: sqlite:///home/user/.homeassistant/test
```
| Database engine | `db_url` | | Database engine | `db_url` |
| :---------------|:---------------------------------------------------------| | :---------------|:---------------------------------------------------------|
| SQLite | `sqlite:///PATH/TO/DB_NAME` | | SQLite | `sqlite:///PATH/TO/DB_NAME` |

View File

@ -19,15 +19,12 @@ To use the `splunk` component in your installation, add the following to your `c
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
splunk: splunk:
host: SPLUNK_HOST_IP_ADDRESS_OR_HOST_NAME
port: 8088
token: B4415DFF-683C-5C6C-3994-4F6D4A5DB03A token: B4415DFF-683C-5C6C-3994-4F6D4A5DB03A
ssl: True
``` ```
Configuration variables: Configuration variables:
- **token** (*Required*): The HTTP Event Collector Token already created in your Splunk instance.
- **host** (*Optional*): IP address or host name of your Splunk host, eg. http://192.168.1.10. Will default to `localhost` if not supplied. - **host** (*Optional*): IP address or host name of your Splunk host, eg. http://192.168.1.10. Will default to `localhost` if not supplied.
- **port** (*Optional*): Port to use. Defaults to 8088. - **port** (*Optional*): Port to use. Defaults to 8088.
- **token** (*Required*): The HTTP Event Collector Token already created in your Splunk instance.
- **ssl** (*Optional*): Use https instead of http to connect. Defaults to False. - **ssl** (*Optional*): Use https instead of http to connect. Defaults to False.

View File

@ -18,11 +18,6 @@ To use the `statsd` component in your installation, add the following to your `c
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
statsd: statsd:
host: DB_HOST_IP_ADDRESS
port: 20000
prefix: DB_TO_STORE_EVENTS
rate: 1
log_attributes: true
``` ```
Configuration variables: Configuration variables: