xoxys.homeassistant_docker/README.md

238 lines
4.6 KiB
Markdown
Raw Normal View History

2019-10-17 06:54:09 +00:00
# xoxys.homeassistant
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.homeassistant/status.svg)](https://drone.rknet.org/ansible/xoxys.homeassistant)
2019-04-27 11:52:50 +00:00
2019-10-17 06:54:09 +00:00
2019-11-06 20:09:07 +00:00
Role to setup Homeassistant
2019-10-17 06:54:09 +00:00
## Table of content
* [Default Variables](#default-variables)
* [homeassistant_base_dir](#homeassistant_base_dir)
2019-11-22 23:06:44 +00:00
* [homeassistant_client_url](#homeassistant_client_url)
* [homeassistant_cmdline_content](#homeassistant_cmdline_content)
* [homeassistant_cmdline_override_enabled](#homeassistant_cmdline_override_enabled)
2019-10-17 06:54:09 +00:00
* [homeassistant_conf_dir](#homeassistant_conf_dir)
2019-11-22 23:06:44 +00:00
* [homeassistant_exclude_modemmanager](#homeassistant_exclude_modemmanager)
* [homeassistant_extra_groups](#homeassistant_extra_groups)
* [homeassistant_group](#homeassistant_group)
2019-10-17 06:54:09 +00:00
* [homeassistant_http_bind_port](#homeassistant_http_bind_port)
2019-11-22 23:06:44 +00:00
* [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)
2019-10-17 06:54:09 +00:00
* [homeassistant_tls_dhparam_path](#homeassistant_tls_dhparam_path)
* [homeassistant_tls_dhparam_size](#homeassistant_tls_dhparam_size)
2019-11-22 23:06:44 +00:00
* [homeassistant_tls_enabled](#homeassistant_tls_enabled)
2019-10-17 06:54:09 +00:00
* [homeassistant_tls_key_path](#homeassistant_tls_key_path)
* [homeassistant_tls_key_source](#homeassistant_tls_key_source)
2019-11-22 23:06:44 +00:00
* [homeassistant_user](#homeassistant_user)
* [homeassistant_user_home](#homeassistant_user_home)
* [homeassistant_version](#homeassistant_version)
2019-10-17 06:54:09 +00:00
* [Dependencies](#dependencies)
* [License](#license)
* [Author](#author)
---
## Default Variables
2019-11-22 23:06:44 +00:00
### homeassistant_base_dir
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_base_dir: /opt/homeassistant
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_client_url
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_client_url: https://hassio.example.com
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_cmdline_content
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_cmdline_content: console=tty1 root=/dev/mmcblk0p3 rootfstype=ext4 elevator=deadline
rootwait
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### 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!
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_cmdline_override_enabled: false
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_conf_dir
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_conf_dir: '{{ homeassistant_base_dir }}/config'
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### 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.
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_exclude_modemmanager: false
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_extra_groups
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_extra_groups:
- tty
- dialout
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_group
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_group: '{{ homeassistant_user }}'
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_http_bind_port
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_http_bind_port: 8123
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_packages
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_packages: []
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_serial_device
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_serial_device:
- vendor_id: '0000'
product_id: xxxx
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_systemd_after
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_systemd_after:
- network-online.target
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_tls_cert_path
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_tls_cert_path: '{{ homeassistant_base_dir }}/tls/certs/mycert.pem'
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_tls_cert_source
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_tls_cert_source: mycert.pem
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_tls_dhparam_path
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_tls_dhparam_path: '{{ homeassistant_base_dir }}/tls/dhparam.pem'
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_tls_dhparam_size
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_tls_dhparam_size: 2048
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_tls_enabled
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_tls_enabled: false
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_tls_key_path
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_tls_key_path: '{{ homeassistant_base_dir }}/tls/private/mykey.pem'
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_tls_key_source
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_tls_key_source: mykey.pem
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_user
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_user: homeassistant
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_user_home
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_user_home: /home/{{ homeassistant_user }}
2019-10-17 06:54:09 +00:00
```
2019-11-22 23:06:44 +00:00
### homeassistant_version
2019-10-17 06:54:09 +00:00
#### Default value
```YAML
2019-11-22 23:06:44 +00:00
homeassistant_version: 0.92.1
2019-10-17 06:54:09 +00:00
```
## Dependencies
None.
## License
MIT
## Author
2019-11-07 08:29:48 +00:00
[xoxys](https://gitea.rknet.org/xoxys)