--- layout: page title: "Getting Started" description: "Step by step guide to get started with Home Assistant." date: 2014-12-18 22:57 sidebar: false comments: false sharing: true footer: true ---

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

$ pip3 install homeassistant
$ hass --open-ui

Running these commands will:

  1. Install Home Assistant
  2. Launch Home Assistant and serve web interface on http://localhost:8123

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:

$ 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 requires the Raspberry Pi to run Raspbian Jessie. This version has been released on September 24, 2015 and comes by default with Python 3.4 which is required for Home Assistant.

Execute the following code in a console:

$ pip3 install homeassistant
$ hass --open-ui

Running these commands will:

  1. Install Home Assistant
  2. Launch Home Assistant and serve web interface on http://localhost:8123

Troubleshooting

If you run into any issues, please see the troubleshooting page. It contains solutions to many of the more commonly encountered issues.

For additional help, in addition to this site, there are three sources:

  1. Gitter Chatroom for general Home Assistant discussions and questions.
  2. Development Mailing List for development related questions and discussing new features.
  3. GitHub Page for issue reporting.

What's next

If you want to have Home Assistant start on boot, autostart instructions can be found here.

To see what Home Assistant can do, launch demo mode: hass --demo-mode

To update Home Assistant to the latest release: pip3 install --upgrade homeassistant

Next step: Configuring Home Assistant »