3.4 KiB
layout, title, description, date, sidebar, comments, sharing, footer
| layout | title | description | date | sidebar | comments | sharing | footer |
|---|---|---|---|---|---|---|---|
| page | Installation on Vagrant | Instructions to run Home Assistant on a Vagrant VM. | 2016-05-28 10:00 | true | false | true | true |
A Vagrantfile is avalable into virtualization/vagrant folder for quickly spinning up a Linux virtual machine running Home Assistant. This can be beneficial for those who want to experiment with Home Assistant and/or developers willing to easily test local changes and run test suite against them.
Vagrant is intended for testing/development only. It is NOT recommended for permanent installations.
Install Vagrant
You must have Vagrant and Virtualbox installed on your workstation.
Get Home Assistant source code
Download the home-assistant source code by either downloading the .zip file from GitHub releases page, or by using Git
git clone https://github.com/home-assistant/home-assistant.git
cd home-assistant/virtualization/vagrant
The following instructions will assume you changed your working directory to be home-assistant/virtualization/vagrant. This is mandatory because Vagrant will look for informations about the running VM inside that folder and won't work otherwise
Create the Vagrant VM and start Home Assistant
vagrant up
This will download + start a virtual machine using Virtualbox, which will internally setup the development environment necessary to start Home Assistant process and run test suite as well. After the VM has started succesfully, Home Assistant frontend will be accessible locally from your browser at http://localhost:8123
Stopping Vagrant
To shutdown the Vagrant host:
vagrant halt
To start it again, just run vagrant up
Restarting Home Assistant process to test changes
The root home-assistant directory on your workstation will be mirrored with /home-assistant inside the VM. In virtualization/vagrant there's also a config folder that you can use to drop configuration files (here you can find more information on how to configure HASS).
Any changes made to the local directory on your workstation will be available from the Vagrant host, so to apply your changes to the HASS process, just restart it:
touch restart ; vagrant provision
Run test suite (Tox)
To run tests against your changes:
touch run_tests ; vagrant provision
Cleanup
To completely remove the VM:
rm setup_done ; vagrant destroy -f
You can now recreate a completely new Vagrant host with vagrant up
{% linkable_title Troubleshooting %}
If you run into any issues, please see the troubleshooting page. It contains solutions to many of the more commonly encountered issues.
In addition to this site, check out these sources for additional help:
- Forum for Home Assistant discussions and questions.
- Gitter Chat Room for real-time chat about Home Assistant.
- GitHub Page for issue reporting.