hassio-supervised-installer/README.md
2019-10-13 10:36:29 +00:00

73 lines
2.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[![Build Status](https://dev.azure.com/home-assistant/Hass.io/_apis/build/status/hassio-installer?branchName=master)](https://dev.azure.com/home-assistant/Hass.io/_build/latest?definitionId=6&branchName=master)
# Install Hass.io
As an alternative to using the images which include the HassOS operating system and Docker, it is also possible to run Hass.io on a generic system running another OS of your choice such as Ubuntu, Debian, etc. Because of all the various possible install options, these are more of a community supported installation choice. It follows that the more esoteric of a choice made with the OS, the less a user will find in terms of information and support from the community.
## Requirements
```
docker-ce
bash
jq
curl
avahi-daemon
dbus
```
**Important**: Don't only install NetworkManager, you need also use it on your system.
## Optional
```
apparmor-utils
network-manager
```
## Run
Run as root (sudo su):
```bash
curl -sL https://raw.githubusercontent.com/home-assistant/hassio-installer/master/hassio_install.sh | bash -s
```
### Command line arguments
| argument | default | description |
|--------------------|----------------------|--------------------------------------------------------|
| -m \| --machine | | On a special platform they need set a machine type use |
| -d \| --data-share | $PREFIX/share/hassio | data folder for hass.io installation |
| -p \| --prefix | /usr | Binary prefix for hass.io installation |
| -s \| --sysconfdir | /etc | Configuration directory for hass.io installation |
you can set these parameters by appending ` -- <parameter> <value>` like:
```bash
curl -sL https://raw.githubusercontent.com/home-assistant/hassio-installer/master/hassio_install.sh | bash -s -- -m MY_MACHINE
```
## Supported Machine types
- intel-nuc
- odroid-c2
- odroid-xu
- orangepi-prime
- qemuarm
- qemuarm-64
- qemux86
- qemux86-64
- raspberrypi
- raspberrypi2
- raspberrypi3
- raspberrypi4
- raspberrypi3-64
- raspberrypi4-64
- tinker
## Use
1. You will be able to reach your installation at http://hassio.local:8123 (if your router supports mDNS, otherwise see below).
2. Enable either the Samba add-on or the SSH add-on to manage your configuration in /config/ (From the UI choose Hass.io which is located in the sidebar).
Note: If your router doesnt support mDNS, then youll have to use the IP address of your Pi instead of hassio.local. For example, http://192.168.0.9:8123. You should be able to find the IP address of your Pi from the admin interface of your router.