[SKIP CI] update readme

This commit is contained in:
Drone Shipper 2019-11-22 23:06:44 +00:00
parent 507571ff75
commit 0013320ec2

172
README.md
View File

@ -8,28 +8,28 @@ Role to setup Homeassistant
## Table of content ## Table of content
* [Default Variables](#default-variables) * [Default Variables](#default-variables)
* [homeassistant_version](#homeassistant_version)
* [homeassistant_user](#homeassistant_user)
* [homeassistant_user_home](#homeassistant_user_home)
* [homeassistant_group](#homeassistant_group)
* [homeassistant_extra_groups](#homeassistant_extra_groups)
* [homeassistant_systemd_after](#homeassistant_systemd_after)
* [homeassistant_base_dir](#homeassistant_base_dir) * [homeassistant_base_dir](#homeassistant_base_dir)
* [homeassistant_conf_dir](#homeassistant_conf_dir)
* [homeassistant_packages](#homeassistant_packages)
* [homeassistant_http_bind_port](#homeassistant_http_bind_port)
* [homeassistant_client_url](#homeassistant_client_url) * [homeassistant_client_url](#homeassistant_client_url)
* [homeassistant_tls_enabled](#homeassistant_tls_enabled) * [homeassistant_cmdline_content](#homeassistant_cmdline_content)
* [homeassistant_cmdline_override_enabled](#homeassistant_cmdline_override_enabled)
* [homeassistant_conf_dir](#homeassistant_conf_dir)
* [homeassistant_exclude_modemmanager](#homeassistant_exclude_modemmanager)
* [homeassistant_extra_groups](#homeassistant_extra_groups)
* [homeassistant_group](#homeassistant_group)
* [homeassistant_http_bind_port](#homeassistant_http_bind_port)
* [homeassistant_packages](#homeassistant_packages)
* [homeassistant_serial_device](#homeassistant_serial_device)
* [homeassistant_systemd_after](#homeassistant_systemd_after)
* [homeassistant_tls_cert_path](#homeassistant_tls_cert_path)
* [homeassistant_tls_cert_source](#homeassistant_tls_cert_source)
* [homeassistant_tls_dhparam_path](#homeassistant_tls_dhparam_path) * [homeassistant_tls_dhparam_path](#homeassistant_tls_dhparam_path)
* [homeassistant_tls_dhparam_size](#homeassistant_tls_dhparam_size) * [homeassistant_tls_dhparam_size](#homeassistant_tls_dhparam_size)
* [homeassistant_tls_cert_path](#homeassistant_tls_cert_path) * [homeassistant_tls_enabled](#homeassistant_tls_enabled)
* [homeassistant_tls_key_path](#homeassistant_tls_key_path) * [homeassistant_tls_key_path](#homeassistant_tls_key_path)
* [homeassistant_tls_cert_source](#homeassistant_tls_cert_source)
* [homeassistant_tls_key_source](#homeassistant_tls_key_source) * [homeassistant_tls_key_source](#homeassistant_tls_key_source)
* [homeassistant_cmdline_override_enabled](#homeassistant_cmdline_override_enabled) * [homeassistant_user](#homeassistant_user)
* [homeassistant_cmdline_content](#homeassistant_cmdline_content) * [homeassistant_user_home](#homeassistant_user_home)
* [homeassistant_exclude_modemmanager](#homeassistant_exclude_modemmanager) * [homeassistant_version](#homeassistant_version)
* [homeassistant_serial_device](#homeassistant_serial_device)
* [Dependencies](#dependencies) * [Dependencies](#dependencies)
* [License](#license) * [License](#license)
* [Author](#author) * [Author](#author)
@ -38,36 +38,57 @@ Role to setup Homeassistant
## Default Variables ## Default Variables
### homeassistant_version ### homeassistant_base_dir
#### Default value #### Default value
```YAML ```YAML
homeassistant_version: 0.92.1 homeassistant_base_dir: /opt/homeassistant
``` ```
### homeassistant_user ### homeassistant_client_url
#### Default value #### Default value
```YAML ```YAML
homeassistant_user: homeassistant homeassistant_client_url: https://hassio.example.com
``` ```
### homeassistant_user_home ### homeassistant_cmdline_content
#### Default value #### Default value
```YAML ```YAML
homeassistant_user_home: /home/{{ homeassistant_user }} homeassistant_cmdline_content: console=tty1 root=/dev/mmcblk0p3 rootfstype=ext4 elevator=deadline
rootwait
``` ```
### homeassistant_group ### homeassistant_cmdline_override_enabled
Override `/boot/cmdline.txt` with given conten. This can be necessary if you use searial hardware, but be careful! Wrong configuration may leave your system unusable!
#### Default value #### Default value
```YAML ```YAML
homeassistant_group: '{{ homeassistant_user }}' homeassistant_cmdline_override_enabled: false
```
### homeassistant_conf_dir
#### Default value
```YAML
homeassistant_conf_dir: '{{ homeassistant_base_dir }}/config'
```
### homeassistant_exclude_modemmanager
Prevent ModemManger from binding to serial devices and therefor blocking controllers like a `CC2531`. Devices can be skipped by a udev rule.
#### Default value
```YAML
homeassistant_exclude_modemmanager: false
``` ```
### homeassistant_extra_groups ### homeassistant_extra_groups
@ -80,37 +101,12 @@ homeassistant_extra_groups:
- dialout - dialout
``` ```
### homeassistant_systemd_after ### homeassistant_group
#### Default value #### Default value
```YAML ```YAML
homeassistant_systemd_after: homeassistant_group: '{{ homeassistant_user }}'
- network-online.target
```
### homeassistant_base_dir
#### Default value
```YAML
homeassistant_base_dir: /opt/homeassistant
```
### homeassistant_conf_dir
#### Default value
```YAML
homeassistant_conf_dir: '{{ homeassistant_base_dir }}/config'
```
### homeassistant_packages
#### Default value
```YAML
homeassistant_packages: []
``` ```
### homeassistant_http_bind_port ### homeassistant_http_bind_port
@ -121,20 +117,47 @@ homeassistant_packages: []
homeassistant_http_bind_port: 8123 homeassistant_http_bind_port: 8123
``` ```
### homeassistant_client_url ### homeassistant_packages
#### Default value #### Default value
```YAML ```YAML
homeassistant_client_url: https://hassio.example.com homeassistant_packages: []
``` ```
### homeassistant_tls_enabled ### homeassistant_serial_device
#### Default value #### Default value
```YAML ```YAML
homeassistant_tls_enabled: false homeassistant_serial_device:
- vendor_id: '0000'
product_id: xxxx
```
### homeassistant_systemd_after
#### Default value
```YAML
homeassistant_systemd_after:
- network-online.target
```
### homeassistant_tls_cert_path
#### Default value
```YAML
homeassistant_tls_cert_path: '{{ homeassistant_base_dir }}/tls/certs/mycert.pem'
```
### homeassistant_tls_cert_source
#### Default value
```YAML
homeassistant_tls_cert_source: mycert.pem
``` ```
### homeassistant_tls_dhparam_path ### homeassistant_tls_dhparam_path
@ -153,12 +176,12 @@ homeassistant_tls_dhparam_path: '{{ homeassistant_base_dir }}/tls/dhparam.pem'
homeassistant_tls_dhparam_size: 2048 homeassistant_tls_dhparam_size: 2048
``` ```
### homeassistant_tls_cert_path ### homeassistant_tls_enabled
#### Default value #### Default value
```YAML ```YAML
homeassistant_tls_cert_path: '{{ homeassistant_base_dir }}/tls/certs/mycert.pem' homeassistant_tls_enabled: false
``` ```
### homeassistant_tls_key_path ### homeassistant_tls_key_path
@ -169,14 +192,6 @@ homeassistant_tls_cert_path: '{{ homeassistant_base_dir }}/tls/certs/mycert.pem'
homeassistant_tls_key_path: '{{ homeassistant_base_dir }}/tls/private/mykey.pem' homeassistant_tls_key_path: '{{ homeassistant_base_dir }}/tls/private/mykey.pem'
``` ```
### homeassistant_tls_cert_source
#### Default value
```YAML
homeassistant_tls_cert_source: mycert.pem
```
### homeassistant_tls_key_source ### homeassistant_tls_key_source
#### Default value #### Default value
@ -185,43 +200,28 @@ homeassistant_tls_cert_source: mycert.pem
homeassistant_tls_key_source: mykey.pem homeassistant_tls_key_source: mykey.pem
``` ```
### homeassistant_cmdline_override_enabled ### homeassistant_user
Override `/boot/cmdline.txt` with given conten. This can be necessary if you use searial hardware, but be careful! Wrong configuration may leave your system unusable!
#### Default value #### Default value
```YAML ```YAML
homeassistant_cmdline_override_enabled: false homeassistant_user: homeassistant
``` ```
### homeassistant_cmdline_content ### homeassistant_user_home
#### Default value #### Default value
```YAML ```YAML
homeassistant_cmdline_content: console=tty1 root=/dev/mmcblk0p3 rootfstype=ext4 elevator=deadline homeassistant_user_home: /home/{{ homeassistant_user }}
rootwait
``` ```
### homeassistant_exclude_modemmanager ### homeassistant_version
Prevent ModemManger from binding to serial devices and therefor blocking controllers like a `CC2531`. Devices can be skipped by a udev rule.
#### Default value #### Default value
```YAML ```YAML
homeassistant_exclude_modemmanager: false homeassistant_version: 0.92.1
```
### homeassistant_serial_device
#### Default value
```YAML
homeassistant_serial_device:
- vendor_id: '0000'
product_id: xxxx
``` ```
## Dependencies ## Dependencies