diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index 1db05d07578..6ddb254af4c 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -10,9 +10,88 @@ footer: true redirect_from: /getting-started/installation/ --- -Home Assistant provides multiple ways to be installed. If you are a Raspberry Pi owner then the [Hassbian](/docs/hassbian/) is an easy and simple way to run home Assistant. +Home Assistant provides multiple ways to be installed. A requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**. -The only requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**. +
+ +
+ +
+
Hassbian
+
+ +
+ +
+
Rasbian
+
+ +
+ +
+
ArchLinux
+
+ +
+ +
+
armbian
+
+ +
+ +
+
Fedora
+
+ +
+ +
+
CentOS/RHEL
+
+ +
+ +
+
Windows
+
+ +
+ +
+
macOS
+
+ +
+ +
+
Synology
+
+ +
+ +
+
Docker
+
+ +
+ +
+
Vagrant
+
+
+ +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 a minute or two 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`. It may be needed that you install additional library depending on the platforms/components you want to use. diff --git a/source/_docs/installation/archlinux.markdown b/source/_docs/installation/archlinux.markdown new file mode 100644 index 00000000000..8fa7188f0a7 --- /dev/null +++ b/source/_docs/installation/archlinux.markdown @@ -0,0 +1,31 @@ +--- +layout: page +title: "Installation on ArchLinux" +description: "Installation of Home Assistant on your ArchLinux computer." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[ArchLinux](https://www.archlinux.org/) is a lightweight and flexible Linux distribution. There are official packages optimized for the i686 and x86-64 architectures available. + +Install the needed Python packages. + +```bash +$ sudo pacman -S python +$ sudo pacman -S python-pip +``` + +and Home Assistant itself. + +```bash +$ pip3 install homeassistant +``` + +Home Assistant is part of the [AUR](https://aur.archlinux.org/packages/home-assistant/). This meand that it can be installed directly with `pacman`: + +```bash +$ sudo pacman -S home-assistant +``` diff --git a/source/_docs/installation/armbian.markdown b/source/_docs/installation/armbian.markdown new file mode 100644 index 00000000000..d7b53d7ed2e --- /dev/null +++ b/source/_docs/installation/armbian.markdown @@ -0,0 +1,25 @@ +--- +layout: page +title: "Installation on a Armbian system" +description: "Instructions to install Home Assistant on an Armbian-powered systems." +date: 2017-02-23 11:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[armbian](https://www.armbian.com) runs on a wide-variety of [ARM development boards](https://www.armbian.com/download/). Currently there are around 50 boards supported inclusive the OrangePi family, Cubieboard, Pine64, and Odroid. + +Setup Python and `pip` + +```bash +$ sudo apt-get update +$ sudo apt-get install python3-dev python3-pip +``` + +Install Home Assistant. + +```bash +$ pip3 install homeassistant +``` diff --git a/source/_docs/installation/centos.markdown b/source/_docs/installation/centos.markdown new file mode 100644 index 00000000000..2a001a96448 --- /dev/null +++ b/source/_docs/installation/centos.markdown @@ -0,0 +1,15 @@ +--- +layout: page +title: "Installation on CentOS/RHEL" +description: "Installation of Home Assistant on your CentOS/RHEL computer." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +To run Python 3.x on [CentOS](https://www.centos.org/) or RHEL (Red Hat Enterprise Linux), [Software Collections](https://www.softwarecollections.org/en/scls/rhscl/rh-python34/) needs to be activated first. + +There are effort in progress to bring Python 3.4 to [Extra Packages for Enterprise Linux (EPEL)](https://fedoraproject.org/wiki/EPEL) which will allow you to follow the [Fedora Instructions](/docs/installation/fedora/). + diff --git a/source/_docs/installation/fedora.markdown b/source/_docs/installation/fedora.markdown new file mode 100644 index 00000000000..fca60e4b9bb --- /dev/null +++ b/source/_docs/installation/fedora.markdown @@ -0,0 +1,25 @@ +--- +layout: page +title: "Installation on Fedora" +description: "Installation of Home Assistant on your Fedora computer." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[Fedora](https://fedoraproject.org) is an operating system based on the Linux kernel, developed by the community-supported Fedora Project. There are releases for x86 and x86_64 including ARM and other architectures. + +Install the development package of Python. + +```bash +$ sudo dnf -y install python3-devel +``` + +and Home Assistant itself. + +```bash +$ pip3 install homeassistant +``` + diff --git a/source/_docs/installation/macos.markdown b/source/_docs/installation/macos.markdown new file mode 100644 index 00000000000..25b3706db7c --- /dev/null +++ b/source/_docs/installation/macos.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Installation on macOS" +description: "Installation of Home Assistant on your macOS system." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[macOS](http://www.apple.com/macos/) is available by default on Apple computer. If you run a different operating system, please refer to the other section of the documentation. + +To run Home Assistant on macOS you need to install Python first. Download Python from https://www.python.org/downloads/mac-osx/ and follow the instructions of the installer. + +Open a terminal and install Home Assistant. + +```bash +$ pip3 install homeassistant +``` + +Check this [video](https://www.youtube.com/watch?v=hej6ipN86ls) for the installation on macOS. diff --git a/source/_docs/installation/troubleshooting.markdown b/source/_docs/installation/troubleshooting.markdown index b78544b025a..9db877b45dc 100644 --- a/source/_docs/installation/troubleshooting.markdown +++ b/source/_docs/installation/troubleshooting.markdown @@ -38,9 +38,6 @@ On a Debian system, install the Python 3 YAML library by `sudo apt-get install p #### {% linkable_title distutils.errors.DistutilsOptionError: must supply either home or prefix/exec-prefix -- not both %} This is a known issue if you're on a Mac using Homebrew to install Python. Please follow [these instructions](https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md#note-on-pip-install---user) to resolve it. -#### {% linkable_title CentOS and Python 3 %} -To run Python 3.x on [CentOS](https://www.centos.org/) or RHEL, [Software Collections](https://www.softwarecollections.org/en/scls/rhscl/rh-python34/) needs to be activated. - #### {% linkable_title No access to the frontend %} In newer Linux distributions (at least Fedora > 22/CentOS 7) the access to a host is very limited. This means that you can't access the Home Assistant frontend that is running on a host outside of the host machine. Windows and macOS machines may also have issues with this. diff --git a/source/_docs/installation/windows.markdown b/source/_docs/installation/windows.markdown index 5ee4465c0a5..899040bc125 100644 --- a/source/_docs/installation/windows.markdown +++ b/source/_docs/installation/windows.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Installation on a Windoes system" +title: "Installation on a Windows system" description: "Instructions to install Home Assistant on a Microsoft Windows system." date: 2017-02-23 11:00 sidebar: true diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 2b3ee4418a3..7a56750b36f 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -5,13 +5,8 @@
  • {% active_link /docs/installation/ Installation %} diff --git a/source/getting-started/getting-started-alternatives.markdown b/source/getting-started/getting-started-alternatives.markdown deleted file mode 100644 index 3fded22b895..00000000000 --- a/source/getting-started/getting-started-alternatives.markdown +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: page -title: "HASSbian image for Raspberry Pi" -description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi." -date: 2016-09-26 21:00 -sidebar: true -comments: false -sharing: true -footer: true ---- - ---- -layout: page -title: "Installing Home Assistant" -description: "Instructions to get started using Home Assistant." -date: 2016-09-26 21:00 -sidebar: true -comments: false -sharing: true -footer: true ---- - -Installing Home Assistant is bla bla. Choose options: - - - [Raspberry Pi][rpi] - - [Python] - -[rpi]: /getting-started/installation-raspberry-pi-image/ -[Python]: /getting-started/installation-python/ diff --git a/source/images/supported_brands/archlinux.png b/source/images/supported_brands/archlinux.png new file mode 100644 index 00000000000..723cce38ef2 Binary files /dev/null and b/source/images/supported_brands/archlinux.png differ diff --git a/source/images/supported_brands/armbian.png b/source/images/supported_brands/armbian.png new file mode 100644 index 00000000000..496370b8b81 Binary files /dev/null and b/source/images/supported_brands/armbian.png differ diff --git a/source/images/supported_brands/centos.png b/source/images/supported_brands/centos.png new file mode 100644 index 00000000000..673e7c43d0c Binary files /dev/null and b/source/images/supported_brands/centos.png differ diff --git a/source/images/supported_brands/docker.png b/source/images/supported_brands/docker.png new file mode 100644 index 00000000000..8ff27ae939c Binary files /dev/null and b/source/images/supported_brands/docker.png differ diff --git a/source/images/supported_brands/fedora.png b/source/images/supported_brands/fedora.png new file mode 100644 index 00000000000..39b6c9127ab Binary files /dev/null and b/source/images/supported_brands/fedora.png differ diff --git a/source/images/supported_brands/vagrant.png b/source/images/supported_brands/vagrant.png new file mode 100644 index 00000000000..af2cd9ebb3d Binary files /dev/null and b/source/images/supported_brands/vagrant.png differ