4dea071ff8
This commit is a large refactoring of the getting started page. This version contains only the information necessary to get off the ground and get your bearings. There is also one consistent flow on information rather than a spaghetti flow. Advanced installation details have been moved to their own page (Docker and daemons). Details about opening firewall ports have been expanded a bit and moved to the troubleshooting page. The install instructions contain details about all three install types (production, beta, and dev).
4.9 KiB
| layout | title | description | date | sidebar | comments | sharing | footer |
|---|---|---|---|---|---|---|---|
| page | Getting Started | Step by step guide to get started with Home Assistant. | 2014-12-18 22:57 | false | false | true | true |
Requirements
Home Assistant requires at least Python 3.4. For the Raspberry Pi, install instructions can be found here. Other systems generally have this bundled or contain easy to install packages.
To ensure Python 3.4 is installed, type the following command into the console:
python3 --version
Installation
Installing from the production channel is fast, easy, and will provide you with access to the newest stable builds. This is recommended for most users. To install, 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 web interface on http://localhost:8123
When new stable versions are released, you can upgrade to newest version by typing the following into a console:
```bash pip3 install --upgrade homeassistant ```The beta channel will provide you with newer features sooner but at the risk of reduced stability. The brave and curious are welcomed here. To install, execute the following code in a console:
```bash pip3 install --pre homeassistant hass --open-ui ```Running these commands will:
- Install Home Assistant
- Launch Home Assistant and serve web interface on http://localhost:8123
When new a new release candidate, alpha, or beta version is released, you can upgrade to newest version by typing the following into a console:
```bash pip3 install --pre --upgrade homeassistant ```The development channel provides builds that are on the bleeding edge. This builds have not been fully tested or used. This is best for potential contributors and tinkerers. Subscribing to this channel is not for the faint of heart and requires significant knowledge of Git and Python.
```bash # Clone repo from git, you may want to use your own fork git clone --recursive https://github.com/balloob/home-assistant.git cd home-assistant # You may want to switch to a virtual environment here # Install Home Assistant in development mode python3 setup.py develop # Optionally pre-emptively install all possible dependencies pip3 install -r requirements_all.txt ```To keep up-to-date with the development channel, you will have to fetch and merge from the dev branch in the head repository. Be careful when doing this.
```bash git fetch balloob git merge remotes/balloob/dev ```Troubleshooting
If you run into any issues, please see the troubleshooting page. It contains solutions to many of the common issues.
For additional help, in addition to this site, there are three sources:
- Gitter Chatroom for general Home Assistant discussions and questions.
- Development Mailing List for development related questions and discussing new features.
- GitHub Page for issue reporting.
What's Next
If you want to see what Home Assistant can do, you can start the demo mode by running hass --demo-mode. Home Assistant has a few other command line flags that can be displayed by running hass --help.
From here you may now start configuring Home Assistant to your liking. For more advanced users, the advanced configuration page contains brief tutorials on creating more advanced installations such as installing daemons and using Docker.