Community Hass.io Add-ons: Vagrant

This Vagrant box contains Home Assistant, which is based on Hass.io.

Deprecation notice

This Vagrant box has been a great help for me (and many others) during the beginning of the Home Assistant add-ons journey. Nowadays, this solution isn't needed anymore.

Add-ons can be developed more easy now, directly on a existing machine, and even in Visual Studio Remote Development containers.

Therefore, the need to maintain this repository is not longer there (as I am not using it myself anymore either).

This project has been archived for that reason and is no longer maintained.

About

This Vagrant virtual machine allows you to test and play with Hass.io and Home Assistant, and is a great environment for add-on developers. A simple vagrant up command gives you a fully-installed Hass.io system in a couple of minutes.

System requirements

This setup does not require a lot. Sure it does cost some CPU & memory, but to be honest, Google Chrome eats more memory these days.

This setup is tested on MacOS but should work fine on Linux as well. Windows 10 has been tested and is still experimental (please see notes below).

When following the installation instructions of the tools mentioned in the following chapter, please be sure to check the system requirements of each of those tools.

Getting started

Before launching your Hass.io environment, you must install VirtualBox 5.1 or higher INCLUDING the VirtualBox Extension Pack, as well as Vagrant 2.1.0 or higher. These software packages provide easy-to-use visual installers for all popular operating systems and are open source.

Once VirtualBox and Vagrant have been installed, install hassio-vagrant by simply cloning this repository. Consider cloning the repository into a folder within your "home" directory.

In case you are running this on a Linux system, you'll need to install nfsd. For example, on Ubuntu: sudo apt-get install nfs-common nfs-kernel-server.

Now the installation of this Vagrant machine:

# Goto your home directory
cd ~

# Clone this repository into a folder called `hassio`
git clone https://github.com/hassio-addons/hassio-vagrant.git hassio

You should check out a tagged version of hassio-vagrant since the master branch may not always be stable. You can find the latest stable version on the GitHub Release Page:

# Change the directory to `hassio`
cd hassio

# Checkout the desired release
git checkout v1.2.0

Once you have cloned the hassio-vagrant repository, use the following command to start Hass.io:

vagrant up hassio

After 10 minutes or so, the process should finish and the following messages will appear on your screen:

==> hassio: [INFO] Start services
==> hassio: =====================================================================
==> hassio:  Community Hass.io Add-ons: Vagrant
==> hassio:
==> hassio:  Hass.io is installed & started! It may take a couple of minutes
==> hassio:  before it is actually responding/available.
==> hassio:
==> hassio:  Home Assitant is running on the following links:
==> hassio:   - http://172.28.128.11:8123
==> hassio:   - http://192.168.1.2:8123
==> hassio: =====================================================================
==> hassio:
==> hassio: Machine 'hassio' has a post `vagrant up` message. This is a message
==> hassio: from the creator of the Vagrantfile, and not from Vagrant itself:
==> hassio:
==> hassio: Hass.io starting... wait a couple of minutes!

🎉 Congratulations! Happy testing/developing 😄

Note: The links and IP addresses are examples, yours may differ and change each time you run this virtual machine

Managing the virtual machine

If you followed the above procedure, you have Hass.io up and running. But there may be a time where you need to shut it down, start up again or maybe start over again.

Shutting down the virtual machine:

vagrant halt hassio

Starting/Resuming the virtual machine again:

vagrant up hassio

Destroying/Deleting the virtual machine:

vagrant destroy hassio

After you've destroyed your Hass.io virtual machine, you can use the start command to create a fresh one.

Note: Please, be aware! Destroying the machine would make you lose your configuration of Home Assistant!

You can also SSH into the virtual machine, giving you direct access to the Docker host:

vagrant ssh hassio

Shared folders

After starting the Hass.io virtual machine, some folders on your hard drive will be made available. These are shared folders with your Hass.io virtual machine. As files within these folders are changed, they will be kept in sync between your local machine and the Hass.io virtual environment.

The following folders are provided within the location where you have cloned this repository to:

• addons - May contain local add-on (e.g. for development).
• backup - May contain snapshots made with Hass.io.
• config - Contains the Home Assistant configuration.
• share - Cross add-on shared folder.
• ssl - May contain SSL certificate files.

Note: When destroying the Hass.io virtual machine, the contents of the config folder WILL BE DELETED. All other folders are left untouched.

Configuration

This Vagrant box ships with a small configuration file, configuration.yml, that allows you to tweak some settings of the virtual machine.

memory

The number of megabytes of memory you want to give to the virtual machine. By default, this has been set to 1024Mb. This number is pretty low, but enough for most add-on development and ensures this setup can be run on almost any machine. Feel free to upgrade the memory if you have spare.

cpus

The number of CPU cores to give to the virtual machine. Defaults to 2.

hostname

The hostname of the virtual Hass.io machine. Defaults to hassio. It might be wise to change this, in case you already have a Hass.io device in your network.

bridge

Allows you to define the specific network interface to bridge to. By default, this is set to ~, which is the same as nothing set and causes Vagrant to ask you for the network interface to use each time you start the virtual machine.

keep_config

By default, if you destroy the virtual machine, the Home Assistant configuration is removed automatically as well. This is to ensure you have a fresh start each time you start the virtual machine.

However, if you need to keep the configuration on the destruction of the virtual machine, you can simply set this option to true.

Notes for Windows Users

Please ensure you run all vagrant commands from Powershell. The Vagrant up command will prompt you to install the NFS addon, which is highly recommended. You can continue using SMB, but will likely encounter performance issues. This has only been tested using Windows 10 (1803), previous Windows versions may work, feedback is welcomed.

When using the NFS addon, the winnfsd.exe process may not terminate on a halt command. This should be killed manually (Task Manager or your preferred method) prior to issuing a Vagrant Up.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

• The Home Assistant Community Forum, we have a dedicated topic on that forum regarding this repository.
• The Home Assistant Discord Chat Server for general Home Assistant discussions and questions.
• Join the Reddit subreddit in /r/homeassistant

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2017 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.