mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-04 10:08:57 +00:00
59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
---
|
|
layout: page
|
|
title: "Getting Started"
|
|
description: "Step by step guide to get started with Home Assistant."
|
|
date: 2014-12-18 22:57
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
---
|
|
|
|
Below you can find the standard instructions. See the sidebar for installation instructions for specific platforms. If you're running a Linux based platform, we suggest to follow the [VirtualEnv Linux instructions] to avoid having to use root.
|
|
|
|
[VirtualEnv Linux instructions]: /getting-started/installation-virtualenv/
|
|
|
|
Installing and running Home Assistant on your local machine is easy. Make sure you have [Python 3.4 or higher](https://www.python.org/downloads/) installed and execute the following code in a console:
|
|
|
|
```bash
|
|
$ pip3 install homeassistant
|
|
$ hass --open-ui
|
|
```
|
|
|
|
Running these commands will:
|
|
|
|
- Install Home Assistant
|
|
- Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123)
|
|
|
|
If you prefer to watch a video tutorial, [tktino](https://github.com/tktino) has made some great ones.
|
|
|
|
- [Windows 10](https://www.youtube.com/watch?v=X27eVvuqwnY)
|
|
- [Mac OS X](https://www.youtube.com/watch?v=hej6ipN86ls)
|
|
- [Ubuntu 14.04](https://www.youtube.com/watch?v=SXaAG1lGNH0)
|
|
|
|
### {% linkable_title Updating %}
|
|
|
|
To update Home Assistant to the latest release when available, run:
|
|
|
|
```bash
|
|
pip3 install --upgrade homeassistant
|
|
```
|
|
|
|
After updating, restart Home Assistant for the changes to take effect.
|
|
|
|
### {% linkable_title Troubleshooting %}
|
|
|
|
If you run into any issues, please see [the troubleshooting page](/getting-started/troubleshooting/). It contains solutions to many of the common encountered issues.
|
|
|
|
In addition to this site, check out these sources for additional help:
|
|
|
|
- [Forum](https://community.home-assistant.io) for Home Assistant discussions and questions.
|
|
- [Gitter Chat Room](https://gitter.im/home-assistant/home-assistant) for real-time chat about Home Assistant.
|
|
- [GitHub Page](https://github.com/home-assistant/home-assistant/issues) for issue reporting.
|
|
|
|
### {% linkable_title What's next %}
|
|
|
|
To see what Home Assistant can do, launch demo mode: `hass --demo-mode` or visit the [demo page](/demo).
|
|
|
|
### [Next step: Configuring Home Assistant »](/getting-started/configuration/)
|