From 1bacf440be0dbb0b9b758c9445ea3edce38a1ce3 Mon Sep 17 00:00:00 2001 From: DubhAd Date: Thu, 31 Jan 2019 15:53:25 +0000 Subject: [PATCH] Big bad install index rewrite (#8345) * Big bad install index rewrite Following on from [this](https://github.com/home-assistant/architecture/issues/126#issuecomment-457819615) here is the first pass. I've: * Restructured the layout, simplifying the intro slightly, and moving more of the relevant things to know up there * Removed redundant information * Used slightly emotive _tier_ language, deliberately * Put in a line and put the community provided guides underneath it Feedback appreciated if this doesn't hit the mark * Removed tier wording * Manual -> Virtualenv * Tweaks --- source/_docs/installation.markdown | 74 +++++++++--------------------- 1 file changed, 22 insertions(+), 52 deletions(-) diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index 0d1af7257e1..71e8a2bad36 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -11,55 +11,41 @@ redirect_from: /getting-started/installation/ ---

-Beginners should check our [Getting started guide](/getting-started/) first. This is for users that require advanced installations. +Beginners should check our [Getting started guide](/getting-started/) first.

-Home Assistant provides multiple ways to be installed. A requirement is that you have [Python 3.5.3 or later](https://www.python.org/downloads/) installed. +Home Assistant provides multiple ways to be installed. The first start may take up to 20 minutes because the required packages will be downloaded and installed. The web interface will be served on `http://ip.add.re.ss:8123/` - replace `ip.add.re.ss` with the IP of the computer you installed it on.

Please remember to [secure your installation](/docs/configuration/securing/) once you've finished with the installation process.

-## {% linkable_title Recommended options %} +## {% linkable_title Recommended %} -
- -
- -
-
Hass.io
(Beginner friendly)
- - -
- -
-
Hassbian (for the Raspberry Pi)
- - -
- -
-
Docker
- -
+These install options are fully supported by Home Assistant's documentation. For example, if a component requires that you install something to make it work on one of these methods then the component page will document the steps required. + +**Method**|**You have**|**Recommended for** +:-----|:-----|:----- +[Hass.io](https://www.home-assistant.io/hassio/installation/)|Raspberry Pi
VM|Anybody +[Docker](https://www.home-assistant.io/docs/installation/docker/)|Docker|Anybody already running Docker +[Hassbian](https://www.home-assistant.io/docs/hassbian/installation/)|Raspberry Pi|Those who want a more traditional Linux experience and either have experience with Linux, or intend to learn ## {% linkable_title Alternative installs %} -The following installs are only recommended for experienced users of those platforms. +If you use these install methods, we assume that you know how to manage and administer the operating system you're using. Due to the range of platforms on which these install methods can be used, component documentation may only tell you what you have to install, not how to install it. + +**Method**|**You have**|**Recommended for** +:-----|:-----|:----- +[Virtualenv
(as another user)](https://www.home-assistant.io/docs/installation/raspberry-pi/)|Any Linux, Python 3.5.3 or later|Those familiar with their operating system +[Virtualenv
(as your user)](https://www.home-assistant.io/docs/installation/virtualenv/)|Any Python 3.5.3 or later|Developers + +
+ +## {% linkable_title Community provided guides %} + +These guides are provided as-is. Some of these install methods are more limited than the methods above - some components may not work due to limitations of the platform or because required Python packages aren't available for that platform.
- -
- -
-
Raspbian (but applies to any Debian based Linux)
- - -
- -
-
On top of an existing Python 3.5.3+ installation
-
@@ -115,19 +101,3 @@ The following installs are only recommended for experienced users of those platf
FreeNAS
- -## {% linkable_title After installation %} - -Once Home Assistant is installed, execute the following code in a console/terminal to check if the setup was successful: - -```bash -$ hass -``` - -The first start may take up to 20 minutes because the needed packages will be downloaded and installed. The web interface will be served on [http://localhost:8123](http://localhost:8123). - -For more details about `hass`, please refer to the [tools section](/docs/tools/hass/). - -If you're running a Linux-based platform, we suggest you follow the [VirtualEnv instructions](/docs/installation/virtualenv/) to avoid using `root`. - -You may need to install additional libraries depending on the platforms/components you want to use.