Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/home-assistant-ecosystem/home-assistant-ansible
:performing_arts: Ansible playbooks/role for the setup of Home Assistant.
https://github.com/home-assistant-ecosystem/home-assistant-ansible
ansible configuration-management debian fedora home-assistant home-automation
Last synced: about 2 months ago
JSON representation
:performing_arts: Ansible playbooks/role for the setup of Home Assistant.
- Host: GitHub
- URL: https://github.com/home-assistant-ecosystem/home-assistant-ansible
- Owner: home-assistant-ecosystem
- License: other
- Created: 2016-05-22T09:30:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T20:42:58.000Z (11 months ago)
- Last Synced: 2024-08-02T15:11:50.592Z (5 months ago)
- Topics: ansible, configuration-management, debian, fedora, home-assistant, home-automation
- Language: Jinja
- Homepage:
- Size: 99.6 KB
- Stars: 62
- Watchers: 6
- Forks: 29
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](hhttps://opensource.org/licenses/Apache-2.0)
Home Assistant
==============
This role deploys [Home Assistant](https://home-assistant.io/) to a remote system.
Requirements
------------
One requirement is to have a system with a configured instance of Ansible. This means that you have an inventory and access to the remote system via SSH with keys.
1. Add the remote system to your Ansible's `hosts` (`/etc/ansible/hosts`) file to the group `[home-assistant]`.
2. For every system you want to manage, you need to have the master's SSH key in the *authorized_keys* file of the managed/remote system.
From the management system for the user **root**:
```bash
$ sudo ssh-copy-id -i /home/[your local user]/.ssh/id_rsa.pub root@[IP address of remote system]
```
While checking if you are able to login the remote system without password, you should check if Python and the DNF Python binding are available. If not, install them to save some time later.
```bash
$ sudo dnf -y install python python-dnf
```
3. Perform a first check if Ansible works. You need to use the user `root`:
```bash
$ ansible home-assistant -m ping -u root -b
192.168.1.2 | success >> {
"changed": false,
"ping": "pong"
}
```
For further details about the setup of Ansible, check their [documentation](http://docs.ansible.com/ansible/).
Role Variables
--------------
- **ha_venv**: The location of the virtual environment. Defaults to `/opt/home-assistant`
- **ha_user**: The user for Home Assistant. Defaults to `ha`.
- **ha_port**: The default port which is 8123. If you change that, you will need to modify the `configuration.yml` file of Home Assistant.
- **pkgs**: List of packages to install on the remote system.
Dependencies
------------
There are no dependencies for this role.
Example Playbook
----------------
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
```bash
- hosts: home-assistant
roles:
- home-assistant.home-assistant-ansible
```
Warning
-------
**Think first** before you implement stuff from this repository. Consider the playbooks in this repository as non-generic. They were made especially for the deployment of Home Assistant and Fedora at the moment.
License
-------
Apache 2.0
Author Information
------------------
[Fabian Affolter](https://github.com/fabaff). If you are too young to know what e-mail is, use [@fabaff](https://twitter.com/fabaff) ;-).