Home Assistant

Getting Started

Installing and running Home Assistant on your local machine is easy. Make sure you have Python 3.4 and git installed and execute the following code in a console: 

1
2
3
4

git clone --recursive https://github.com/balloob/home-assistant.git
cd home-assistant
python3 -m pip install --user -r requirements.txt
python3 -m homeassistant --open-ui

Running these commands will:

  1. Download Home Assistant
  2. Navigate to downloaded files
  3. Install the dependencies
  4. Launch Home Assistant and serve web interface on http://localhost:8123

If you run into any issues, please see the troubleshooting page.

You can run Home Assistant in demo mode by appending --demo-mode to line 4.

If you want to update to the latest version in the future, run: scripts/update.

Installation with Docker is straightforward. Adjust the following command so that /path/to/your/config/ points at the folder where you want to store your config and run it:

1

docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --net=host balloob/home-assistant

This will launch Home Assistant and serve its web interface from port 8123 on your Docker host.

When using boot2docker on OS X you are unable to map the local time to your Docker container. Replace -v /etc/localtime:/etc/localtime:ro with -e "TZ=America/Los_Angeles" (replacing America/Los_Angeles with your timezone)

Home Assistant currently does not fare well if server and client are in different time zones.

Home Assistant uses Python 3.4. This makes installation on a Raspberry Pi a bit more difficult as it is not available in the package repository. Please follow the following instructions to get it up and running.

Step 1. Install pyenv

1

curl -L https://raw.githubusercontent.com/yyuu/pyenv-installer/master/bin/pyenv-installer | bash

After the installation is done, run:

1

nano ~/.bashrc

Then add these lines to the end of the file and save:

1
2
3

export PATH="$HOME/.pyenv/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"

Step 2. Install requirements

1
2

sudo apt-get install python3-dev
sudo apt-get install libsqlite3-dev libreadline-dev libbz2-dev

Log out and then back in so your bashrc is reloaded.

NOTE: the rest of the commands are not being run as sudo and will install python etc under you user’s home directory.

Step 3. Install python 3.4.2 (this will take a few hours)

1

pyenv install 3.4.2

Step 4. Create Python Virtual Environment

1

pyenv virtualenv 3.4.2 homeassistant

Step 5. Clone the source

1

git clone --recursive https://github.com/balloob/home-assistant.git

Step 6. Set the virtual environment

1
2

cd home-assistant
pyenv local homeassistant

Step 6. Finish the install

1

python3 -m pip install -r requirements.txt

Step 7. Start it up

1

python3 -m homeassistant

It will be up and running on port 8123

You can run Home Assistant in demo mode by appending --demo-mode to line 4.

If you want to update to the latest version in the future, run: scripts/update.

Home Assistant currently does not fare well if server and client are in different time zones.

Next step: configuring Home Assistant »