diff --git a/.textlintrc.json b/.textlintrc.json index 4121d5ca2ec..d044e1bdf00 100644 --- a/.textlintrc.json +++ b/.textlintrc.json @@ -287,7 +287,9 @@ ["end ?to ?end", "end-to-end"], ["FRITZ!? ?Box", "FRITZ!Box"], ["grey", "gray"], + ["Hass\\.?io", "Home Assistant"], ["hass", "Home Assistant"], + ["HassOS", "Home Assistant Operating System"], ["he or she", "they"], ["he/she", "they"], ["Home-?Ass?s?iss?tt?ant", "Home Assistant"], diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown index 2dfc89d14c4..d8d91be4734 100644 --- a/source/_docs/authentication.markdown +++ b/source/_docs/authentication.markdown @@ -15,9 +15,8 @@ If you are starting Home Assistant for the first time, or you have logged out, y When you start Home Assistant for the first time the _owner_ user account is created. This account has some special privileges and can: -- Create and manage other user accounts. +- Create and manage other user accounts. - Configure integrations and other settings (coming soon). -- Configure Hass.io (coming soon).
For the moment, other user accounts will have the same access as the owner account. In the future, non-owner accounts will be able to have restrictions applied. @@ -78,11 +77,11 @@ INFO (MainThread) [homeassistant.components.http.auth] You need to use a bearer While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](/docs/configuration/): -* `auth` -* `auth_provider.homeassistant` -* `onboarding` -* `hassio` (for Hass.io users) -* `cloud` (for nabucasa users) +- `auth` +- `auth_provider.homeassistant` +- `onboarding` +- `hassio` +- `cloud` When you start Home Assistant next, you'll be required to set up authentication again. diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index adf1fabb702..b416afff1d6 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -9,13 +9,13 @@ The web interface can be found at `http://ip.ad.dre.ss:8123/` - for example if y The location of the folder differs between operating systems: -| OS | Path | -| ------- | -------------------------- | -| macOS | `~/.homeassistant` | -| Linux | `~/.homeassistant` | -| Windows | `%APPDATA%/.homeassistant` | -| Hass.io | `/config` | -| Docker | `/config` | +| OS | Path | +| -------------- | -------------------------- | +| Home Assistant | `/config` | +| Docker | `/config` | +| macOS | `~/.homeassistant` | +| Linux | `~/.homeassistant` | +| Windows | `%APPDATA%/.homeassistant` | If you want to use a different folder for configuration, use the configuration command line parameter: `hass --config path/to/config`. diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index db724c64dc3..3aadb1251ff 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -20,8 +20,8 @@ If you have incorrect entries in your configuration files you can use the [`chec One of the most common problems with Home Assistant is an invalid `configuration.yaml` or other configuration file. -- You can test your configuration using the command line with: `hass --script check_config`. - - On Hass.io you can use the [`hassio` command](/hassio/commandline/#home-assistant): `hassio homeassistant check`. +- With Home Assistant you can use the [`ha` command](/hassio/commandline/#home-assistant): `ha core check`. + - You can test your configuration with Home Assistant Core using the command line with: `hass --script check_config`. - On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `home-assistant` is the name of the container. - The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8. - You can verify your configuration's YAML structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/). diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown index 2290839f8fd..fd1ae14b363 100644 --- a/source/_docs/configuration/yaml.markdown +++ b/source/_docs/configuration/yaml.markdown @@ -66,7 +66,9 @@ sensor: ### Environmental variables -You can include values from your system's environment variables with `!env_var`. Note that this will only work in a scenario where it is possible to specify these. Hass.io users are recommended to use `!include` statements instead. +On Home Assistant Core installations, you can include values from your system's environment variables with `!env_var`. +Note that this will only work for Home Assistant Core installations, in a scenario where it is possible to specify these. +Regular Home Assistant users are recommended to use `!include` statements instead. ```yaml example: diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index 4b47a08c634..a75d3cefd74 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -5,7 +5,8 @@ description: "A guide to remotely accessing Home Assistant and securing the conn
-If you are using Hass.io do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Hass.io. +This guide is for users running Home Assistant Core. +If you are using Home Assistant do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Home Assistant.
diff --git a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown index 22d866ad873..cbd111228d1 100644 --- a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown +++ b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown @@ -26,11 +26,11 @@ The certificate **must** be `.pem` extension. openssl req -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -x509 -days 730 -out fullchain.pem ``` -For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process. +For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process. At the end you will have two files called `privkey.pem` and `fullchain.pem`. The key and the certificate. -Update the `http:` entry in your `configuration.yaml` file and let it point to your created files. +Update the `http:` entry in your `configuration.yaml` file and let it point to your created files. Hass.io: @@ -52,7 +52,7 @@ A restart of Home Assistant is required for the new certificate to take effect. If you get any log error about *ssl_key* or *ssl_certificate* that is **not a file for dictionary value** when run Home Assistant, you need to change owner or access permission of the `.pem` files as following: -Hass.io (through Console or SSH plug-in): +Home Assistant (through console or SSH add-on): ```bash chown root:root fullchain.pem privkey.pem diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index 503a8e6982f..9a4d7afe43a 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -47,13 +47,13 @@ These install options are fully supported by Home Assistant's documentation. For
-The only installation methods that allow you to use Hass.io Add-ons are the Hass.io image and [manual installer](/hassio/installation/#alternative-install-on-a-generic-linux-host). All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program. +The only installation methods that allow you to use Home Assistant Add-ons is using the Home Assistant image and [manual Supervised installer](/hassio/installation/#alternative-install-on-a-generic-linux-host). All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program.
**Method**|**You have**|**Recommended for** :-----|:-----|:----- -[Hass.io](/hassio/installation/)|Raspberry Pi
VM|Anybody +[Home Assistant](/hassio/installation/)|Raspberry Pi
VM|Anybody [Docker](/docs/installation/docker/)|Docker|Anybody already running Docker ## Alternative installs @@ -116,6 +116,6 @@ These guides are provided as-is. Some of these install methods are more limited
-
Hass.io
on generic Linux server
+
Home Assistant Supervised
on generic Linux server
diff --git a/source/_docs/installation/synology.markdown b/source/_docs/installation/synology.markdown index 306ff710362..67ebae4f995 100644 --- a/source/_docs/installation/synology.markdown +++ b/source/_docs/installation/synology.markdown @@ -11,13 +11,13 @@ Synology only provide Python 3.5.1, which is not compatible with Home Assistant There are 3 alternatives, when using Home Assistant on Synology NAS: -1. using Docker -2. directly running on DSM -3. using Hass.io in a VM (if you have an Intel based Synology) +1. Using Home Assistant Core on Docker +2. Directly running Home Assistant Core on DSM +3. Using the Home Assistant a VM (if you have an Intel based Synology) Option 1 is described on the [Docker installation page](/docs/installation/docker/). -Option 3 uses the Synology Based Virtual Machine Manager. You can import the VDI image to be found at the [Hass.io installation page](/hassio/installation/). Download the image and add it to the image store. The go to "Virtual Machine" in the interface and create a new VM with the image you just added. +Option 3 uses the Synology Based Virtual Machine Manager. You can import the VDI image to be found at the [Home Assistant installation page](/hassio/installation/). Download the image and add it to the image store. The go to "Virtual Machine" in the interface and create a new VM with the image you just added. The main benefit from this method is that you can assign Home Assistant its own IP number, so there is no risk regarding TCP/UDP port conflicts. USB dongles an be connected to the VM without the need to install a driver in DSM. diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown index ff13b539ebf..ddb57502588 100644 --- a/source/_docs/installation/updating.markdown +++ b/source/_docs/installation/updating.markdown @@ -6,7 +6,7 @@ redirect_from: /getting-started/updating/
-The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/) or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant). +The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv/#upgrading-home-assistant).
@@ -14,29 +14,28 @@ Check what's new in the latest version and potentially impacts your system in [H
-To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Hass.io](/hassio/) or [Virtualenv](/docs/installation/virtualenv). +To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv).
The default way to update Home Assistant to the latest release, when available, is: ```bash -$ pip3 install --upgrade homeassistant +pip3 install --upgrade homeassistant ``` For a Docker container, simply pull the latest one: ```bash -$ sudo docker pull homeassistant/home-assistant:latest +sudo docker pull homeassistant/home-assistant:latest ``` For a Raspberry Pi Docker container, simply pull the latest one: ```bash -$ sudo docker pull homeassistant/raspberrypi3-homeassistant:latest +sudo docker pull homeassistant/raspberrypi3-homeassistant:latest ``` - After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well. [BRUH automation](https://www.bruhautomation.io/) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant. @@ -46,7 +45,7 @@ After updating, you must start/restart Home Assistant for the changes to take ef In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release: ```bash -$ pip3 install homeassistant==0.XX.X +pip3 install homeassistant==0.XX.X ``` #### Run the beta version @@ -54,7 +53,7 @@ $ pip3 install homeassistant==0.XX.X If you would like to test next release before anyone else, you can install the beta version released every two weeks: ```bash -$ pip3 install --pre --upgrade homeassistant +pip3 install --pre --upgrade homeassistant ``` #### Run the development version @@ -69,11 +68,11 @@ If you want to stay on the bleeding-edge Home Assistant development branch, you $ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@dev ``` -### Update Hass.io installation +### Update Home Assistant installation -Best practice for updating a Hass.io installation: +Best practice for updating a Home Assistant installation: -1. Backup your installation, using the snapshot functionality Hass.io offers. +1. Backup your installation, using the snapshot functionality Home Assistant offers. 2. Check the release notes for breaking changes on [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**. 3. Check your configuration using the [Check Home Assistant configuration](/addons/check_config/) add-on. 4. If the check passes, you can safely update. If not, update your configuration accordingly. diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 00da82ff005..a0c7f5fc4e1 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -1,15 +1,18 @@ --- -title: "MQTT Brokers" -description: "Instructions on how to setup MQTT brokers for Home Assistant." +title: "MQTT Broker" +description: "Instructions on how to setup a MQTT broker for Home Assistant." logo: mqtt.png --- -The MQTT integration needs you to run an MQTT broker for Home Assistant to connect to. There are four options, each with various degrees of ease of setup and privacy. +The MQTT integration needs you to run an MQTT broker for Home Assistant to connect to. ### Run your own -This is the most private option, but it requires a little bit of work to setup. There are multiple free and open-source brokers to pick from: e.g., [Mosquitto](http://mosquitto.org/), [EMQ](https://github.com/emqx/emqx) or [Mosca](http://www.mosca.io/). -For Hass.io users, the recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto). +This is the most private option, is running your own MQTT broker. + +The recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto). + +## Configuration ```yaml # Example configuration.yaml entry @@ -48,7 +51,7 @@ protocol: type: string certificate: required: false - description: Path to the certificate file, e.g., `/home/user/.homeassistant/server.crt`. + description: Path to the certificate file, e.g., `/ssl/server.crt`. type: string tls_insecure: required: false @@ -61,26 +64,6 @@ tls_version: type: string {% endconfiguration %} -
- -There is an issue with the Mosquitto package included in Ubuntu 14.04 LTS. Specify `protocol: 3.1` in your MQTT configuration to work around this issue. - -If you get this error `AttributeError: module 'ssl' has no attribute 'PROTOCOL_TLS'` then you need to set `tls_version: '1.2'`. - -
- -
- -If you are running a Mosquitto instance on the same server as Home Assistant then you must ensure that the Mosquitto service starts before Home Assistant. For a Linux instance running Systemd (Raspberry Pi, Debian, Ubuntu and others) then you should edit the file `/etc/systemd/system/home-assistant@homeassistant.service` as `root` (e.g., `sudo nano /etc/systemd/system/home-assistant@homeassistant.service`) and add the Mosquitto service: - -```txt -[Unit] -Description=Home Assistant -After=network.target mosquitto.service -``` - -
-
If you are running a Mosquitto instance on a different server with proper SSL encryption using a service like Let's Encrypt you may have to set the certificate to the operating systems own `.crt` certificates file. In the instance of Ubuntu this would be `certificate: /etc/ssl/certs/ca-certificates.crt` @@ -161,10 +144,6 @@ mqtt: As of release 0.92, the embedded broker has been marked as deprecated. This means bugs may not be fixed, and the functionality may be removed in a future release.
-
-Before release 0.76, the embedded broker would use your API password as a password to the MQTT user. This is no longer the case. -
-
There is [an issue](https://github.com/beerfactory/hbmqtt/issues/62) with the HBMQTT broker and the WebSocket connection that is causing a memory leak. If you experience this issue, consider using another broker like Mosquitto. diff --git a/source/_docs/security.markdown b/source/_docs/security.markdown index c507c426331..1a2c72ec3a2 100644 --- a/source/_docs/security.markdown +++ b/source/_docs/security.markdown @@ -7,7 +7,7 @@ As Home Assistant is like every other service or daemon that is running on a com [Secure your installation](/docs/configuration/securing/) once you've finished with the installation process regardless of your use case. -Home Assistant is NOT able to change the configuration of your router or firewall. This means that you need to setup [port-forwarding](/docs/configuration/remote/) and adjusting firewall rules if you want to allow access from the internet. By default your frontend and your Hass.io add-ons like Mosquitto, SSH and your Samba shares are only accessible from your local network. +Home Assistant is NOT able to change the configuration of your router or firewall. This means that you need to setup [port-forwarding](/docs/configuration/remote/) and adjusting firewall rules if you want to allow access from the internet. By default your frontend and your Home Assistant add-ons like Mosquitto, SSH and your Samba shares are only accessible from your local network. ## Server banner @@ -17,8 +17,6 @@ Further [details about the fingerprint/server banner](/docs/security/webserver/) The default port of Home Assistant is 8123. This is the port where the [`frontend`](/integrations/frontend/) and the [`API`](/integrations/api/) is served. Both are depending on the [`http`](/integrations/http/) integration which contains the capability to adjust the settings like `server_host` or `server_port`. -See the [open ports](/docs/security/porosity/) of a Hass.io instance with various add-ons. - ## HTTP SSL/TLS Home Assistant is following the [Mozilla's Operations Security team recommendations](https://wiki.mozilla.org/Security/Server_Side_TLS) for Server side SSL/TLS settings. Home Assistant uses **Modern compatibility** by default. If an user wishes to use **Intermediate compatibility**, this is configurable in the [`http` integration](/integrations/http/). @@ -27,7 +25,7 @@ Home Assistant is following the [Mozilla's Operations Security team recommendati The SSH connection for [debugging](https://developers.home-assistant.io/docs/en/hassio_debugging.html) on port 22222 is not enabled by default and can only be used with keys. -If SSH is used with the [SSH server add-on](/addons/ssh/) then the user is responsible for the configuration and security. +If SSH is used with the [SSH server add-on](/addons/ssh/) then the user is responsible for the configuration and security. ## Source code diff --git a/source/_docs/security/porosity.markdown b/source/_docs/security/porosity.markdown deleted file mode 100644 index 741c030e5b9..00000000000 --- a/source/_docs/security/porosity.markdown +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: "Home Assistant/Hass.io porosity" -description: "Use nmap to scan your Home Assistant instance." ---- - -As a large amount of users are running [Hass.io](/hassio/), here we are using a Raspberry Pi 3 B and Hass.io 0.70.0 to show how Home Assistant looks from the network side. This is not a full blown investigation, just a quick overview. - -The IP address of the Home Assistant machine is 192.168.0.215. The system which is the source of the scans is a machine running Fedora 27 and Nmap 7.60 is used to perform the port scans. Both systems are in the same network. - -## SSH server Add-on - -To get access to Hass.io in secure way, SSH is provided by the [SSH server add-on](/addons/ssh/). - -```bash -$ sudo nmap -A -n --reason -Pn -T5 -p1-65535 192.168.0.215 - -Starting Nmap 7.60 ( https://nmap.org ) at 2018-05-29 15:08 CEST -Nmap scan report for 192.168.0.215 -Host is up, received arp-response (0.00051s latency). -Not shown: 65532 closed ports -Reason: 65532 resets -PORT STATE SERVICE REASON VERSION -22/tcp open ssh syn-ack ttl 63 OpenSSH 7.5 (protocol 2.0) -| ssh-hostkey: -| 2048 e3:a2:2d:20:3a:67:68:b9:b1:9e:16:fa:48:80:82:96 (RSA) -| 256 92:f0:f4:be:4f:44:60:0e:c4:92:8a:cb:34:9e:c5:c2 (ECDSA) -|_ 256 09:da:a2:14:cd:c4:69:e9:13:e6:70:64:98:d0:55:0c (EdDSA) -8123/tcp open http syn-ack ttl 64 aiohttp 3.1.3 (Python 3.6) -|_http-open-proxy: Proxy might be redirecting requests -| http-robots.txt: 1 disallowed entry -|_/ -|_http-server-header: Python/3.6 aiohttp/3.1.3 -|_http-title: Home Assistant -22222/tcp open ssh syn-ack ttl 64 Dropbear sshd 2016.74 (protocol 2.0) -MAC Address: B8:41:CD:4B:7A:5D (Raspberry Pi Foundation) -Device type: general purpose -Running: Linux 3.X|4.X -OS CPE: cpe:/o:linux:linux_kernel:3 cpe:/o:linux:linux_kernel:4 -OS details: Linux 3.2 - 4.8 -Network Distance: 1 hop -Service Info: OS: Linux; CPE: cpe:/o:linux:linux_kernel - -TRACEROUTE -HOP RTT ADDRESS -1 0.51 ms 192.168.0.215 - -OS and Service detection performed. Please report any incorrect results at https://nmap.org/submit/ . -Nmap done: 1 IP address (1 host up) scanned in 726.23 seconds -``` - -That port 22 and 8123 are open was expected. On port 22222 is an additional SSH server running. This port is for [debugging](https://developers.home-assistant.io/docs/en/hassio_debugging.html) and supports only a login with a key. This means that you would need to remove the SD card from your Raspberry Pi, create an `authorized_keys` with your SSH public key in it and put the SD Card back in your Pi to get access. - -## Mosquitto MQTT broker Add-on - -While setting up the [Mosquitto MQTT broker add-on](/addons/mosquitto/) no settings were modified, the add-on was running with the default settings. - -```bash -$ sudo nmap -A -n --reason -Pn -T5 -p1-65535 192.168.0.215 - -Starting Nmap 7.60 ( https://nmap.org ) at 2018-05-29 15:52 CEST -Nmap scan report for 192.168.0.215 -Host is up, received arp-response (0.0011s latency). -Not shown: 65532 closed ports -Reason: 65532 resets -PORT STATE SERVICE REASON VERSION -1883/tcp open mosquitto version 1.4.12 syn-ack ttl 63 -| mqtt-subscribe: -| Topics and their most recent payloads: -| $SYS/broker/load/connections/5min: 0.39 -[...] -| $SYS/broker/load/connections/15min: 0.13 -|_ $SYS/broker/clients/total: 2 -8123/tcp open http syn-ack ttl 64 aiohttp 3.1.3 (Python 3.6) -|_http-open-proxy: Proxy might be redirecting requests -| http-robots.txt: 1 disallowed entry -|_/ -|_http-server-header: Python/3.6 aiohttp/3.1.3 -|_http-title: Home Assistant -22222/tcp open ssh syn-ack ttl 64 Dropbear sshd 2016.74 (protocol 2.0) -MAC Address: B8:41:CD:4B:7A:5D (Raspberry Pi Foundation) -Device type: general purpose -Running: Linux 3.X|4.X -OS CPE: cpe:/o:linux:linux_kernel:3 cpe:/o:linux:linux_kernel:4 -OS details: Linux 3.2 - 4.8 -Network Distance: 1 hop -Service Info: OS: Linux; CPE: cpe:/o:linux:linux_kernel - -TRACEROUTE -HOP RTT ADDRESS -1 1.13 ms 192.168.0.215 - -OS and Service detection performed. Please report any incorrect results at https://nmap.org/submit/ . -Nmap done: 1 IP address (1 host up) scanned in 223.76 seconds -``` - -To secure MQTT to consider to use certificates and to specify users with password under `logins:` at least. Use port 1883 only in your local network. - -## Samba Add-on - -The [Samba add-on](/addons/samba/) enables one to use a Windows system to access the configuration and other shares. Per default there is no user set. To increase your local security we strongly suggest that you set a username and a password and don't allow guests. A sample configuration could look like the one below. - -A port scan for Hass.io with this add-on will give you the details. - -```bash -$ sudo nmap -A -n --reason -Pn -T5 -p1-65535 192.168.0.215 - -Starting Nmap 7.60 ( https://nmap.org ) at 2018-05-29 16:29 CEST -Host is up, received arp-response (0.00045s latency). -Not shown: 65523 closed ports -Reason: 65523 resets -PORT STATE SERVICE REASON VERSION -139/tcp open netbios-ssn syn-ack ttl 64 Samba smbd 3.X - 4.X (workgroup: WORKGROUP) -445/tcp open netbios-ssn syn-ack ttl 64 Samba smbd 4.7.3 (workgroup: WORKGROUP) -8123/tcp open http syn-ack ttl 64 aiohttp 3.1.3 (Python 3.6) -|_http-open-proxy: Proxy might be redirecting requests -| http-robots.txt: 1 disallowed entry -|_/ -|_http-server-header: Python/3.6 aiohttp/3.1.3 -|_http-title: Home Assistant -22222/tcp open ssh syn-ack ttl 64 Dropbear sshd 2016.74 (protocol 2.0) -MAC Address: B8:41:CD:4B:7A:5D (Raspberry Pi Foundation) -Device type: general purpose -Running: Linux 3.X|4.X -OS CPE: cpe:/o:linux:linux_kernel:3 cpe:/o:linux:linux_kernel:4 -OS details: Linux 3.2 - 4.8 -Network Distance: 1 hop -Service Info: Host: HASSIO; OS: Linux; CPE: cpe:/o:linux:linux_kernel - -Host script results: -|_nbstat: NetBIOS name: HASSIO, NetBIOS user: , NetBIOS MAC: (unknown) -| smb-os-discovery: -| OS: Windows 6.1 (Samba 4.7.3) -| Computer name: \x00 -| NetBIOS computer name: HASSIO\x00 -| Workgroup: WORKGROUP\x00 -|_ System time: 2018-05-29T16:41:05+02:00 -| smb-security-mode: -| account_used: guest -| authentication_level: user -| challenge_response: supported -|_ message_signing: disabled (dangerous, but default) -| smb2-security-mode: -| 2.02: -|_ Message signing enabled but not required -| smb2-time: -| date: 2018-05-29 16:41:05 -|_ start_date: 1601-01-01 00:53:28 - -TRACEROUTE -HOP RTT ADDRESS -1 0.46 ms 192.168.0.215 - -OS and Service detection performed. Please report any incorrect results at https://nmap.org/submit/ . -Nmap done: 1 IP address (1 host up) scanned in 727.43 seconds -``` - -139 and 445 are open and it's possible to enumerate the shares. With different tools you will get pretty much the same information. - -```bash -$ smbclient -L //192.168.0.215 -U% - - Sharename Type Comment - --------- ---- ------- - config Disk - addons Disk - share Disk - backup Disk - IPC$ IPC -IPC Service (Samba Home Assistant config share) -Reconnecting with SMB1 for workgroup listing. - - Server Comment - --------- ------- - - Workgroup Master - --------- ------- - WORKGROUP HASSIO -``` - -But without username and password you can't get access to the configuration file with the settings shown here. - -```json -[...] - "guest": false, - "username": "homeassistant", - "password": "homeassistant", - "interface": "eth0" -} -``` diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index 5d49aea9073..d8922f499a6 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -105,25 +105,25 @@ Ensure you keep a backup of this key. If you have to rebuild your system and don ## First Run -On platforms other than Hass.io and Docker, the compilation and installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed. +On platforms other than Home Assistant and Docker, the compilation and installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed. The first run after adding a device is when the `zwave` integration will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process. ## Platform specific instructions -### Hass.io +### Home Assistant You do not need to install any software to use Z-Wave. If the path of `/dev/ttyACM0` doesn't work, look in the *System* section of the *Supervisor* menu. There you'll find a *Hardware* button which will list all the hardware found. -You can also check what hardware has been found using the [`hassio` command](/hassio/commandline/#hardware): +You can also check what hardware has been found using the [`ha` command](/hassio/commandline/#hardware): ```bash -hassio hardware info +ha hardware info ``` -If you did an alternative install of Hass.io on Linux (e.g. installing Ubuntu, then Docker, then Hass.io) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu). +If you did an alternative install of Home Assistant on Linux (e.g. installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu). ### Docker @@ -149,7 +149,7 @@ The `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and On the Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant. Make sure to reboot the Raspberry Pi for the setting to take effect. -#### Linux +#### Linux with Home Assistant Core On Debian Linux platforms there are dependencies you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems): diff --git a/source/_faq/ha-vs-hassio.markdown b/source/_faq/ha-vs-hassio.markdown index f83a3beb903..1cd8f365421 100644 --- a/source/_faq/ha-vs-hassio.markdown +++ b/source/_faq/ha-vs-hassio.markdown @@ -1,11 +1,13 @@ --- -title: "Home Assistant vs. Hass.io" -description: "Home Assistant vs. Hass.io" +title: "Home Assistant vs. Home Assistant Core" +description: "Home Assistant vs. Home Assistant Core" ha_category: Installation --- -Home Assistant is a Python program, in simple words. It can be run on various operating systems and provide the ability to track, control and automate your devices. When people talking about Home Assistant they usually refer to a standalone [installation method](/docs/installation/). +Home Assistant Core is a Python program, in simple words. It can be run on various operating systems and provide the ability to track, control and automate your devices. +When people talking about Home Assistant Core they usually refer to a standalone [installation method](/docs/installation/). -[Hass.io](/hassio/) is a combination of Home Assistant and tools which allows one to run it easily on a Raspberry Pi and other platforms without setting up an operating system first. Hass.io is an all-in one-solution and has a management user interface that can be used from the Home Assistant frontend. This interface is not present in a standalone setup of Home Assistant. +[Home Assistant](/hassio/) is a combination of Home Assistant Core and tools which allows one to run it easily on a Raspberry Pi and other platforms without setting up an operating system first. +Home Assistant is an all-in one-solution and has a management user interface that can be used from the Home Assistant frontend. This interface is not present in a Home Assistant Core setup. -Be aware that add-ons are only available in Hass.io, due to the way Hass.io is installed. +Be aware that add-ons are only available in regular Home Assistant installations. diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index a09f631f603..7a7e113027b 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -148,7 +148,6 @@
  • {% active_link /docs/security/webserver/ Web server fingerprint %}
    • -
  • {% active_link /docs/security/porosity/ Porosity %}
  • diff --git a/source/_integrations/alexa.intent.markdown b/source/_integrations/alexa.intent.markdown index b70928da73a..1349c9c55b8 100644 --- a/source/_integrations/alexa.intent.markdown +++ b/source/_integrations/alexa.intent.markdown @@ -19,7 +19,7 @@ The built-in Alexa integration allows you to integrate Home Assistant into Alexa - Amazon Developer Account. You can sign on [here](https://developer.amazon.com). - An [AWS account](https://aws.amazon.com/free/) is need if you want to use Alexa Custom Skill API. Part of your Alexa Custom Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However you don't need worry the cost, AWS Lambda allow free to use up to 1 millions requests and 1GB outbound data transfer per month. -- The Alexa Custom Skill API also needs your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport), this is so account linking can take place. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io using the [Duck DNS](/addons/duckdns/) add-on is the easiest method. +- The Alexa Custom Skill API also needs your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport), this is so account linking can take place. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Home Assistant using the [Duck DNS](/addons/duckdns/) add-on is the easiest method. ### Create Your Amazon Alexa Custom Skill diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index 93da91cb92b..cb8690c9482 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -47,7 +47,7 @@ Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant: ## Requirements -- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will work, but a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport) is recommended. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io using the [Duck DNS](/addons/duckdns/) add-on is the easiest method. +- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will work, but a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport) is recommended. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Home Assistant using the [Duck DNS](/addons/duckdns/) add-on is the easiest method. - Amazon Developer Account. Sign up [here](https://developer.amazon.com). - An [Amazon Web Services (AWS)](https://aws.amazon.com/free/) account is required to host the Lambda function for your Alexa Smart Home Skill. [AWS Lambda](https://aws.amazon.com/lambda/pricing/) is free to use for up to 1-million requests and 1GB outbound data transfer per month. diff --git a/source/_integrations/almond.markdown b/source/_integrations/almond.markdown index ef85b5e4722..9e9cbcff396 100644 --- a/source/_integrations/almond.markdown +++ b/source/_integrations/almond.markdown @@ -24,9 +24,9 @@ Almond consists of three parts: ## Installation -### Hass.io installation +### Home Assistant add-on installation -To install Almond Server on Hass.io, go to Hass.io App Store, search for Almond and click on Install. Once started, it will initiate a configuration flow to finish set up in Home Assistant. You can find it on the integrations page in the configuration panel. +To install Almond Server, go to the Home Assistant add-on store, search for Almond and click on Install. Once started, it will initiate a configuration flow to finish set up in Home Assistant. You can find it on the integrations page in the configuration panel. ### Manual installation diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown index 82fa9416f57..3f34dcf5859 100644 --- a/source/_integrations/androidtv.markdown +++ b/source/_integrations/androidtv.markdown @@ -180,7 +180,7 @@ Prior to Home Assistant 0.101, this approach did not work well for newer devices The second option is to use an ADB server to connect to your Android TV and Fire TV devices. -For Hass.io users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value. +For Home Assistant users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value. ## ADB Troubleshooting diff --git a/source/_integrations/apcupsd.markdown b/source/_integrations/apcupsd.markdown index 65482765ebf..64350610ea0 100644 --- a/source/_integrations/apcupsd.markdown +++ b/source/_integrations/apcupsd.markdown @@ -17,9 +17,9 @@ There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) - [Sensor](#sensor) -## Hass.io Installation +## Home Assistant add-on installation -Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on. +Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Home Assistant. Keep in mind that we can't give you support for this add-on. After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below. @@ -47,7 +47,7 @@ port:
    -If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine. +If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addresses will not connect.
    diff --git a/source/_integrations/beewi_smartclim.markdown b/source/_integrations/beewi_smartclim.markdown index 9380153b7a7..70a54b08ad0 100644 --- a/source/_integrations/beewi_smartclim.markdown +++ b/source/_integrations/beewi_smartclim.markdown @@ -16,9 +16,9 @@ The `beewi_smartclim` sensor platform allows one to monitor room or external tem Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system: -- On [Hass.io](/hassio/installation/): `beewi_smartclim` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does). -- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. -- On other Linux systems: +- `beewi_smartclim` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does). +- Using [Home Assistant Core on Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. +- On other Home Assistant Core systems: - Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one. - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. - Windows and macOS are currently not supported by the `btlewrap` library. diff --git a/source/_integrations/bme680.markdown b/source/_integrations/bme680.markdown index 32e98038793..e2b3d06eb24 100644 --- a/source/_integrations/bme680.markdown +++ b/source/_integrations/bme680.markdown @@ -180,9 +180,9 @@ group: - sensor.bme680_sensor_air_quality ``` -## Directions for enabling I2C interface on Hass.io +## Directions for enabling I2C interface on the Home Assistant Operating System -Follow the instructions here to [enable I2C on Hass.io.](/hassio/enable_i2c/). +Follow the instructions here to [enable I2C here.](/hassio/enable_i2c/). ## Directions for installing SMBus support on Raspberry Pi @@ -190,7 +190,7 @@ Enable I2C interface with the Raspberry Pi configuration utility: ```bash # pi user environment: Enable I2C interface -$ sudo raspi-config +sudo raspi-config ``` Select `Interfacing options->I2C` choose `` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot. @@ -199,13 +199,13 @@ Install dependencies to use the `smbus-cffi` module and add your `homeassistant` ```bash # pi user environment: Install I2C dependencies and utilities -$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev +sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev # pi user environment: Add homeassistant user to the I2C group -$ sudo addgroup homeassistant i2c +sudo addgroup homeassistant i2c # pi user environment: Reboot Raspberry Pi to apply changes -$ sudo reboot +sudo reboot ``` ### Check the I2C address of the sensor @@ -213,10 +213,11 @@ $ sudo reboot After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors: ```bash -$ /usr/sbin/i2cdetect -y 1 +/usr/sbin/i2cdetect -y 1 ``` It will output a table like this: + ```text 0 1 2 3 4 5 6 7 8 9 a b c d e f 00: -- -- -- -- -- -- -- -- -- -- -- -- -- diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown index 14f154214c2..ea6f7418487 100644 --- a/source/_integrations/dialogflow.markdown +++ b/source/_integrations/dialogflow.markdown @@ -10,7 +10,7 @@ ha_config_flow: true The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. -To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). +To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms. diff --git a/source/_integrations/duckdns.markdown b/source/_integrations/duckdns.markdown index 88a9dd522f8..709cbc04742 100644 --- a/source/_integrations/duckdns.markdown +++ b/source/_integrations/duckdns.markdown @@ -9,6 +9,12 @@ ha_release: 0.55 With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. +
    + +If you are running the Home Assistant DuckDNS add-on this integration is not required. The add-on will keep your IP updated with DuckDNS. + +
    + ## Configuration To use the integration in your installation, add the following to your `configuration.yaml` file: @@ -39,9 +45,3 @@ Set the TXT record of your DuckDNS subdomain. | ---------------------- | -------- | ----------- | | `txt` | no | Payload for the TXT record. | - -
    - -If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this integration is not required. The add-on will keep your IP updated with DuckDNS. - -
    diff --git a/source/_integrations/emulated_hue.markdown b/source/_integrations/emulated_hue.markdown index 9f8635f9942..37d163f732f 100644 --- a/source/_integrations/emulated_hue.markdown +++ b/source/_integrations/emulated_hue.markdown @@ -152,11 +152,11 @@ Verify that the URLs above are using port 80, rather than port 8300 (i.e. `http: ### Platform specific instructions -#### Hass.io and Docker +#### Home Assistant and Home Assistant Core on Docker No further actions are required -#### Python venv +#### Home Assistant Core in a Python venv An additional step is required to run Home Assistant as a non-root user and use port 80. diff --git a/source/_integrations/ffmpeg.markdown b/source/_integrations/ffmpeg.markdown index e89bd511916..88f37659faf 100644 --- a/source/_integrations/ffmpeg.markdown +++ b/source/_integrations/ffmpeg.markdown @@ -11,13 +11,8 @@ The `ffmpeg` integration allows other Home Assistant integrations to process vid
    -You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website. -
    - -
    - -If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled. - +If you are running Home Assistant Core in a Python environment, you'll need have the `ffmpeg` binary in your system path. +On Debian 8 or Raspbian (Jessie) you can install it from [debian-backports](https://backports.debian.org/Instructions/). If you want [hardware acceleration](https://trac.ffmpeg.org/wiki/HWAccelIntro) support on a Raspberry Pi, you will need to build from source by yourself. Windows binaries are available on the [FFmpeg](http://www.ffmpeg.org/) website.
    ## Configuration diff --git a/source/_integrations/generic_ip_camera.markdown b/source/_integrations/generic_ip_camera.markdown index e701055785c..e003c60f8df 100644 --- a/source/_integrations/generic_ip_camera.markdown +++ b/source/_integrations/generic_ip_camera.markdown @@ -91,7 +91,7 @@ camera: content_type: 'image/svg+xml' ``` -### Local image with Hass.io +### Local image You can show a static image with this platform. Just place the image here: `/config/www/your_image.png` diff --git a/source/_integrations/hdmi_cec.markdown b/source/_integrations/hdmi_cec.markdown index 1bc7667a369..274597e58ee 100644 --- a/source/_integrations/hdmi_cec.markdown +++ b/source/_integrations/hdmi_cec.markdown @@ -18,14 +18,10 @@ The computer running Home Assistant must support CEC, and of course be connected ### libcec +This section only applies to users of Home Assistant Core in a Python virtual environment. + [libcec](https://github.com/Pulse-Eight/libcec) must be installed for this integration to work. Follow the installation instructions for your environment, provided at the link. `libcec` installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a [Python virtual environment](/docs/installation/virtualenv/), make sure it can access the system module, by either symlinking it or using the `--system-site-packages` flag. -
    - -If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled. - -
    - #### Symlinking into virtual environment Create a symlink to the `cec` installation including the _cec.so file. Keep in mind different installation methods will result in different locations of cec. diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index 60e9c1e2d3f..703b91bbbad 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -81,7 +81,7 @@ Configuration variables (interface): {% configuration %} host: - description: IP address or Hostname of CCU/Homegear device or Hass.io add-on. + description: IP address or hostname of CCU/Homegear device or Home Assistant add-on. required: true type: string port: diff --git a/source/_integrations/http.markdown b/source/_integrations/http.markdown index 81ebaf9d5c5..64038d3bfce 100644 --- a/source/_integrations/http.markdown +++ b/source/_integrations/http.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
    -Don't use option `server_host` on a Hass.io installation! +The option option `server_host` should only be used on a Home Assistant Core installation!
    diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown index 5f9dc845be3..803f44c5837 100644 --- a/source/_integrations/ifttt.markdown +++ b/source/_integrations/ifttt.markdown @@ -14,7 +14,7 @@ ha_config_flow: true ## Sending events from IFTTT to Home Assistant -To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). +To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). ### Setting up the integration diff --git a/source/_integrations/logger.markdown b/source/_integrations/logger.markdown index e80945e106e..38d2320776e 100644 --- a/source/_integrations/logger.markdown +++ b/source/_integrations/logger.markdown @@ -43,16 +43,16 @@ logger: logs: # log level for HA core homeassistant.core: fatal - + # log level for MQTT integration homeassistant.components.mqtt: warning - + # log level for all python scripts homeassistant.components.python_script: warning - + # individual log level for this python script homeassistant.components.python_script.my_new_script.py: debug - + # log level for SmartThings lights homeassistant.components.smartthings.light: info @@ -69,7 +69,7 @@ logger: The log entries are in the form *timestamp* *log-level* *thread* [**namespace**] *message* -where **namespace** is the ** currently logging. +where **namespace** is the ** currently logging. {% configuration %} default: @@ -87,12 +87,12 @@ where **namespace** is the ** currently logging. type: string {% endconfiguration %} -In the example, do note the difference between 'glances_api' and 'homeassistant.components.glances' namespaces, -both of which are at root. They are logged by different APIs. +In the example, do note the difference between 'glances_api' and 'homeassistant.components.glances' namespaces, +both of which are at root. They are logged by different APIs. -If you want to know the namespaces in your own environment then check your log files on startup. -You will see INFO log messages from homeassistant.loader stating `loaded from `. -Those are the namespaces available for you to set a `log level` against. +If you want to know the namespaces in your own environment then check your log files on startup. +You will see INFO log messages from homeassistant.loader stating `loaded from `. +Those are the namespaces available for you to set a `log level` against. ### Log Levels @@ -144,11 +144,10 @@ The log information are stored in the and you can read it with the command-line tool `cat` or follow it dynamically with `tail -f`. -If you are a Hass.io user, you can use the example below, when logged in through -the [SSH add-on](/addons/ssh/): +You can use the example below, when logged in through the [SSH add-on](/addons/ssh/): ```bash -$ tail -f /config/home-assistant.log +tail -f /config/home-assistant.log ``` On Docker you can use your host command line directly - follow the logs dynamically with: diff --git a/source/_integrations/mailgun.markdown b/source/_integrations/mailgun.markdown index 2c6a03fed88..97808d3cf9f 100644 --- a/source/_integrations/mailgun.markdown +++ b/source/_integrations/mailgun.markdown @@ -8,7 +8,7 @@ ha_release: 0.38 ha_config_flow: true --- -To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). +To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun. diff --git a/source/_integrations/mcp23017.markdown b/source/_integrations/mcp23017.markdown index 08bd69a0593..0bd216f2caf 100644 --- a/source/_integrations/mcp23017.markdown +++ b/source/_integrations/mcp23017.markdown @@ -16,7 +16,7 @@ The `mcp23017` integration is the base for all related mcp23017 platforms in Hom For more details about the MCP23017 I2C I/O port expander you can find its datasheet here: [MCP23017](https://www.microchip.com/wwwproducts/en/MCP23017). -If you are using Hass.io on HassOS you can’t use existing methods to enable the I2C bus on a Raspberry Pi, you will have to [enable the I2C interface in the Hass.io configuration](https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/raspberrypi.md#i2c) using a USB stick. To accomplish that, follow this step by step instructions: [Enable HassOS i2c](https://www.home-assistant.io/hassio/enable_i2c). +If you are using the Home Assistant Operating System you can’t use existing methods to enable the I2C bus on a Raspberry Pi, you will have to [enable the I2C interface manually](https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/raspberrypi.md#i2c) using a USB stick. To accomplish that, follow this step by step instructions: [Enable Home Assistant Operating System i2c](https://www.home-assistant.io/hassio/enable_i2c). ## Binary Sensor diff --git a/source/_integrations/mhz19.markdown b/source/_integrations/mhz19.markdown index 4cd801814c0..34c02aa2969 100644 --- a/source/_integrations/mhz19.markdown +++ b/source/_integrations/mhz19.markdown @@ -32,6 +32,7 @@ sensor: - **temperature** Full example: + ```yaml sensor: - platform: mhz19 @@ -42,7 +43,7 @@ sensor: - temperature ``` -## Raspberry Pi 3(+) GPIO UART and Hass.io +## Raspberry Pi GPIO UART and the Home Assistant Operating System To directly connect the sensor on the GPIO pins of a RPi, first append the following to `config.txt` in the boot directory: diff --git a/source/_integrations/miflora.markdown b/source/_integrations/miflora.markdown index d37335c10a5..40cd9a68e7e 100644 --- a/source/_integrations/miflora.markdown +++ b/source/_integrations/miflora.markdown @@ -19,8 +19,8 @@ There are "Chinese" and "International" versions available and there is a [repor Before configuring Home Assistant you need a Bluetooth backend and the MAC address of your sensor. Depending on your operating system, you may have to configure the proper Bluetooth backend for your system: -- On [Hass.io](/hassio/installation/): Miflora will work out of the box. -- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. +- On [Home Assistant](/hassio/installation/): Miflora will work out of the box. +- On [Home Assistant Core on Docker](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. - On other Linux systems: - Preferred solution: Install the `bluepy` library (via pip). When using a virtual environment, make sure to install the library in the right one.  - Fallback solution: Install `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated` diff --git a/source/_integrations/mitemp_bt.markdown b/source/_integrations/mitemp_bt.markdown index cea293437fe..5defcfe1d80 100644 --- a/source/_integrations/mitemp_bt.markdown +++ b/source/_integrations/mitemp_bt.markdown @@ -14,8 +14,8 @@ The `mitemp_bt` sensor platform allows one to monitor room temperature and humid Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system: -- On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does). -- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. +- On [Home Assistant](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does). +- On a [Home Assistant Core on Docker](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. - On other Linux systems: - Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one. - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. diff --git a/source/_integrations/nmap_tracker.markdown b/source/_integrations/nmap_tracker.markdown index 1eddbb7cacc..dbe44deb1fb 100644 --- a/source/_integrations/nmap_tracker.markdown +++ b/source/_integrations/nmap_tracker.markdown @@ -13,11 +13,11 @@ As an alternative to the router-based device tracking, it is possible to directl Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.
    • -You might have to install the packages for `arp` and `nmap`. On Debian based hosts (for example Raspbian) do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`. -
    -If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled. +If you are running Home Assistant Core in a Python virtual environment, you might have to install the packages for `arp` and `nmap`. +On Debian based hosts (for example Raspbian) do so by running `sudo apt-get install net-tools nmap`. +On a Fedora host run `sudo dnf -y install nmap`.
    @@ -78,6 +78,7 @@ device_tracker: - 10.0.0.2 - 10.0.0.15 ``` + In the above example, Nmap will be call with the process: `nmap -oX - 192.168.1.1/24 10.0.0.2 10.0.0.15 -F --host-timeout 5s` @@ -88,10 +89,11 @@ An example of how the Nmap scanner can be customized: On Linux systems (such as Hass.io) you can extend the functionality of Nmap, without having to run it as root, by using *Linux capabilities*. Be sure to specify the full path to wherever you installed Nmap: ```bash -$ sudo setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nmap +sudo setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip /usr/bin/nmap ``` And you can set up the device tracker as + ```yaml - platform: nmap_tracker hosts: 192.168.1.1-25 diff --git a/source/_integrations/onewire.markdown b/source/_integrations/onewire.markdown index 9b48997f5d4..6c7aae9ebfe 100644 --- a/source/_integrations/onewire.markdown +++ b/source/_integrations/onewire.markdown @@ -27,7 +27,7 @@ The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using ## Raspberry Pi setup In order to setup 1-Wire support on Raspberry Pi, you'll need to edit `/boot/config.txt` following [this documentation](https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire). -To edit `/boot/config.txt` on Hass.io use [this documentation](https://developers.home-assistant.io/docs/en/hassio_debugging.html) to enable SSH and edit `/mnt/boot/config.txt` via `vi`. +To edit `/boot/config.txt` on the Home Assistant Operating System, use [this documentation](https://developers.home-assistant.io/docs/en/hassio_debugging.html) to enable SSH and edit `/mnt/boot/config.txt` via `vi`. ## Interface adapter setup @@ -49,6 +49,7 @@ Connect to your database using the instructions from [Database section](/docs/ba ```sql SELECT entity_id, COUNT(*) as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10; ``` + Alter the names of sensors using the following examples: ```sql diff --git a/source/_integrations/pi_hole.markdown b/source/_integrations/pi_hole.markdown index 207992a9385..86729d56da2 100644 --- a/source/_integrations/pi_hole.markdown +++ b/source/_integrations/pi_hole.markdown @@ -26,7 +26,7 @@ pi_hole: {% configuration %} host: description: > - The hostname (and port), e.g. '192.168.0.3:4865' of the host where Pi-hole is running. Hass.io add-on users should be sure to specify port `4865`. + The hostname (and port), e.g. '192.168.0.3:4865' of the host where Pi-hole is running. Home Assistant add-on users should be sure to specify port `4865`. required: true type: string name: @@ -62,7 +62,7 @@ api_key: ### Full examples -Single Pi-hole running via Hass.io add-on: +Single Pi-hole running via Home Assistant add-on: ```yaml pi_hole: @@ -105,7 +105,7 @@ Disables configured Pi-hole(s) for the specified amount of time. | Service data attribute | Required | Type | Description | | ---------------------- | -------- | -------- | ----------- | -| `duration` | `True` | timedelta | Time for which Pi-hole should be disabled | +| `duration` | `True` | timedelta | Time for which Pi-hole should be disabled | | `name` | `False` | string | If preset, disables the named Pi-hole, otherwise, disables all configured Pi-holes | _Note: This service requires `api_key` to be specified in the configuration._ diff --git a/source/_integrations/ps4.markdown b/source/_integrations/ps4.markdown index c8ae4aa1851..1dd2f2a5784 100644 --- a/source/_integrations/ps4.markdown +++ b/source/_integrations/ps4.markdown @@ -39,14 +39,14 @@ The `ps4` integration allows you to control a The PlayStation 4 integration requires the use of privileged ports to work correctly, specifically UDP port 987 and TCP port 997. Depending on your OS of your Home Assistant instance, you may need to allow usage of privileged ports manually.
    - Do not run your Home Assistant instance itself as root or with root/sudo privileges to accomplish this. This would create a security risk for your host system. + Do not run your Home Assistant Core instance itself as root or with root/sudo privileges to accomplish this. This would create a security risk for your host system.
    There are varying methods to perform this, dependent on your OS that is running Home Assistant. Specifically, your *Python Interpreter*, which runs your Home Assistant instance, needs access to the mentioned ports.
    -If your Home Assistant device is running **Hass.io** on **HassOS**, it does not require additional configuration. +Additional configuration is only required for Home Assistant Core users **not** running on Docker.
    diff --git a/source/_integrations/rpi_pfio.markdown b/source/_integrations/rpi_pfio.markdown index 7a762c590c0..23d94d78d9c 100644 --- a/source/_integrations/rpi_pfio.markdown +++ b/source/_integrations/rpi_pfio.markdown @@ -19,9 +19,12 @@ There is currently support for the following device types within Home Assistant: Set the jumpers on the PiFace board for address 0 (JP1: 1-2, JP2: 1-2). -## Use with HassOS +## Using with the Home Assistant Operating System -Note that the PiFace Digital 2 uses the Raspberry Pi SPI port, which is disabled by default when using [HassOS](https://github.com/home-assistant/hassos). When using HassOS, you must mount the SD card on another computer and access the boot partition on the card. Edit the `config.txt` file and add the line `dtparam=spi=on` to the end. This should enable SPI when HassOS is booted and allow Home Assistant to access the PiFace Digital 2 board. +Note that the PiFace Digital 2 uses the Raspberry Pi SPI port, which is disabled by default when using the [Home Assistant Operating System](https://github.com/home-assistant/hassos). +You must mount the SD card on another computer and access the boot partition on the card. Edit the `config.txt` file and add the line `dtparam=spi=on` to the end. + +This should enable SPI when the Home Assistant Operating System is booted to access the PiFace Digital 2 board. ## Binary Sensor diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown index 3cdc0a6c2c6..3f59a1bf7ee 100644 --- a/source/_integrations/samsungtv.markdown +++ b/source/_integrations/samsungtv.markdown @@ -37,7 +37,7 @@ host: required: true type: string port: - description: The port of the Samsung Smart TV. If set to 8001, the new websocket connection will be used (required for 2016+ TVs) - for installs other than Hass.io or Docker you may need to install a Python package, see below. + description: The port of the Samsung Smart TV. If set to 8001, the new websocket connection will be used (required for 2016+ TVs) - For Home Assistant Core installations, you may need to install a Python package, see below. required: false type: integer default: automatically detected @@ -166,11 +166,7 @@ media_content_type: channel It's possible to switch between the 2 sources `TV` and `HDMI`. -### Hass.io - -No additional actions are required - -### Docker +### Home Assistant & Home Assistant Core on Docker No additional actions are required diff --git a/source/_integrations/seven_segments.markdown b/source/_integrations/seven_segments.markdown index ec15c7a7d6e..47d1ce6e8e8 100644 --- a/source/_integrations/seven_segments.markdown +++ b/source/_integrations/seven_segments.markdown @@ -11,11 +11,9 @@ ha_iot_class: Local Polling The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/). -
    +## Home Assistant Core Requirements -If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled. - -
    +If you are running Home Assistant Core in a Python virtual environment, you need to ensure the following requirements are met. `ssocr` needs to be available on your system. Check the installation instruction below: @@ -30,6 +28,8 @@ sudo make PREFIX=/usr install # On most systems make deb # (Optional) This allows you to make a deb so that you apt is aware of ssocr ``` +## Configuration + To enable the OCR of a seven segment display in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -105,7 +105,7 @@ source: It's suggested that the first attempt to determine the needed parameters is using `ssocr` directly. This may require a couple of iterations to get the result ```bash -$ ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png +ssocr -D erosion crop 390 250 490 280 -t 20 -d 4 seven-seg.png ``` This would lead to the following entry for the `configuration.yaml` file: diff --git a/source/_integrations/tellstick.markdown b/source/_integrations/tellstick.markdown index 22919db444f..65d9428db29 100644 --- a/source/_integrations/tellstick.markdown +++ b/source/_integrations/tellstick.markdown @@ -33,7 +33,7 @@ To get started, add the devices to your `configuration.yaml` file. tellstick: ``` -For Hass.io users there is a [TellStick add-on](/addons/tellstick/) available. +There is a [TellStick add-on](/addons/tellstick/) available in the Home Assistant add-on store. ```yaml # Example configuration.yaml entry for Hass.io with the TellStick add-on @@ -49,7 +49,7 @@ signal_repetitions: type: integer default: 1 host: - description: If you run TellStick on another server or with the Hass.io add-on. + description: If you run TellStick on another server or with the Home Assistant add-on. required: inclusive type: string port: diff --git a/source/_integrations/traccar.markdown b/source/_integrations/traccar.markdown index 1d9061f5fbf..775b7cc1f08 100644 --- a/source/_integrations/traccar.markdown +++ b/source/_integrations/traccar.markdown @@ -11,7 +11,7 @@ ha_codeowners: - '@ludeeus' --- -`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Hass.io addon. +`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Home Assistant add-on. ## Traccar Client diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown index 1602543048f..cf2ba725149 100644 --- a/source/_integrations/tradfri.markdown +++ b/source/_integrations/tradfri.markdown @@ -51,7 +51,7 @@ allow_tradfri_groups: After updating your IKEA Trådfri Gateway firmware it might be necessary to repeat the configuration process. One error you might experience after a firmware update is `Fatal DTLS error: code 115`. If you encounter problems: - when configured using the integration: remove the integration through Settings > Integrations > Tradfri > delete (trash can icon) -- with manual configuration: delete the `.tradfri_psk.conf` file in your `/.homeassistant` directory (`/config` directory if using Hass.io or Docker) +- with manual configuration: delete the `.tradfri_psk.conf` file in your `/config` directory (`/.homeassistant` directory if using Home Assistant Core) Then restart Home Assistant. When prompted, enter the security key and click *configure*, just like during initial setup. diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown index 230ba85268a..6a2c761f8c7 100644 --- a/source/_integrations/twilio.markdown +++ b/source/_integrations/twilio.markdown @@ -39,7 +39,7 @@ auth_token: After configuring the base Twilio component, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality. -To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). +To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio. diff --git a/source/_integrations/updater.markdown b/source/_integrations/updater.markdown index 1bf493780d8..aa6593e9a59 100644 --- a/source/_integrations/updater.markdown +++ b/source/_integrations/updater.markdown @@ -10,7 +10,7 @@ ha_codeowners: - '@home-assistant/core' --- -The `updater` binary sensor will check daily for new releases. The state will be "on" when an update is available. Otherwise, the state will be "off". The newer version, as well as the link to the release notes, are attributes of the updater. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this binary sensor on Hass.io. +The `updater` binary sensor will check daily for new releases. The state will be "on" when an update is available. Otherwise, the state will be "off". The newer version, as well as the link to the release notes, are attributes of the updater. The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/updater). @@ -65,6 +65,7 @@ It is possible to report the integrations that you are using to the Home Assista For an added bonus, an automation integration can be created to send a message with a notifier when that state of this component's entity changes. {% raw %} + ```yaml # Example configuration.yaml entry automation: @@ -79,4 +80,5 @@ automation: data_template: message: "Home Assistant {{ state_attr('binary_sensor.updater', 'newest_version') }} is available." ``` + {% endraw %} diff --git a/source/_integrations/version.markdown b/source/_integrations/version.markdown index 533711be237..cfe399ea2e5 100644 --- a/source/_integrations/version.markdown +++ b/source/_integrations/version.markdown @@ -46,7 +46,7 @@ source: default: local {% endconfiguration %} -### Supported images for Hass.io and Docker +### Supported images for Home Assistant `default`, `qemux86`, `qemux86-64`, `qemuarm`, `qemuarm-64`, `intel-nuc`, `raspberrypi`, `raspberrypi2`, `raspberrypi3`, `raspberrypi3-64`, `raspberrypi4`, `raspberrypi4-64`, `tinker`, `odroid-c2`, `odroid-xu` diff --git a/source/_integrations/vlc.markdown b/source/_integrations/vlc.markdown index b974ec9201b..4c9b005d704 100644 --- a/source/_integrations/vlc.markdown +++ b/source/_integrations/vlc.markdown @@ -10,6 +10,14 @@ ha_iot_class: Local Polling The `vlc` platform allows you to control [VLC media player](https://www.videolan.org/vlc/index.html). +
    + +The VLC media player integration, is currently only available for installations that are based on the Home Assistant Core in a Python virtual environment. + +
    + +## Configuration + To add a VLC media player to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -45,7 +53,7 @@ media_player: arguments: '--alsa-audio-device=hw:1,0' ``` -##### Additional configuration on macOS +## Additional configuration on macOS On macOS `python-vlc` won’t find the VLC plugin directory unless you add this to the user’s `.bash_profile` that is running Home Assistant: @@ -53,14 +61,10 @@ On macOS `python-vlc` won’t find the VLC plugin directory unless you add this export VLC_PLUGIN_PATH=$VLC_PLUGIN_PATH:/Applications/VLC.app/Contents/MacOS/plugins ``` -##### Additional configuration for Rasperry Pi +## Additional configuration for Raspberry Pi You need to add the `homeassistant` user to the `audio` group: ```bash sudo usermod -a -G audio homeassistant ``` - -##### VLC currently not supported with Hass.io - -According to the forum topic ["How to add VLC into my Hassio"](https://community.home-assistant.io/t/how-to-add-vlc-into-my-hassio/23000/5), it is not possible to install packages like VLC on Hass.io. diff --git a/source/_integrations/vlc_telnet.markdown b/source/_integrations/vlc_telnet.markdown index 896aa5f3ca7..2847a27216d 100644 --- a/source/_integrations/vlc_telnet.markdown +++ b/source/_integrations/vlc_telnet.markdown @@ -62,6 +62,7 @@ media_player: password: your-secure-password ``` -##### Additional configuration for Rasperry Pi +## Home Assistant Add-on -You can run a VLC Media Player inside your Hass.io installation using the [hassio-local-vlc add-on](https://github.com/rodripf/hassio-local-vlc). Using it you can play files on the local network, Internet or files and playlist locally saved to the /share folder of your Hass.io installation. +You can run a VLC Media Player on your Home Assistant installation using the a community provided [add-on](https://github.com/rodripf/hassio-local-vlc). +Using it you can play files on the local network, Internet or files and playlist locally saved to the `/share` folder of your Home Assistant installation. diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 81c317ec862..c4475c53612 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -150,7 +150,7 @@ Using a Philips Hue Dimmer Switch is probably the easiest way to factory-reset y Follow the instructions on [https://github.com/vanviegen/hue-thief/](https://github.com/vanviegen/hue-thief/) (EZSP-based Zigbee USB stick required) -### ZHA Start up issue with Home Assistant Docker/Hass.io installs on Linux hosts +### ZHA Start up issue with Home Assistant Supervised or Home Assistant Core on Docker On Linux hosts ZHA can fail to start during HA startup or restarts because the Zigbee USB device is being claimed by the host's modemmanager service. To fix this disable the modemmanger on the host system. diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown index 6237d916c90..09f63818744 100644 --- a/source/getting-started/configuration.markdown +++ b/source/getting-started/configuration.markdown @@ -7,11 +7,11 @@ The onboarding process takes care of the initial setup for Home Assistant, such
    -The steps below only apply if you've installed Home Assistant via Hass.io. If you've used another installation method, [see here](/docs/configuration/). +The steps below do not apply to Home Assistant Core installations, for those types of installations, [see here](/docs/configuration/).
    -We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Hass.io add-on store: the Configurator. To get to the add-on store, click on the menu icon in the top left, then click on Hass.io. On the new page, open the add-on store tab. +We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Home Assistant add-on store: the Configurator. To get to the add-on store, click on the menu icon in the top left, then click on Supervisor. On the new page, open the add-on store tab.

    @@ -53,15 +53,15 @@ Screenshot of the "General" page in the configuration panel.

    - - If you have watched any videos about setting up Home Assistant using configuration.yaml (particularly ones that are old), you might notice your default configuration file is much smaller than what the videos show. Don't be concerned, you haven't done anything wrong. Many items in the default configuration files shown in those old videos are now included in the `default_config:` line that you see in your configuration file. [See here](/integrations/default_config/) for more information on what's included in that line. + + If you have watched any videos about setting up Home Assistant using `configuration.yaml` (particularly ones that are old), you might notice your default configuration file is much smaller than what the videos show. Don't be concerned, you haven't done anything wrong. Many items in the default configuration files shown in those old videos are now included in the `default_config:` line that you see in your configuration file. [See here](/integrations/default_config/) for more information on what's included in that line.
    ### Editing configuration via Samba/Windows Networking -Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can also be installed from the Hass.io add-on store. This will make your configuration accessible via the network tab on your computer. +Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can also be installed from the Home Assistant add-on store. This will make your configuration accessible via the network tab on your computer. -Go to the add-on store and look for Samba in the core section. After you have installed the add-on, click on START. Hass.io should now be available in the networking tab on your computer. +Go to the add-on store and look for Samba in the core section. After you have installed the add-on, click on START. Home Assistant should now be available in the networking tab on your computer. We suggest that to edit `configuration.yaml`, you use the free text editor [Visual Studio Code](https://code.visualstudio.com/) in combination with the [Home Assistant Configuration Helper extension](https://marketplace.visualstudio.com/items?itemName=keesschollaart.vscode-home-assistant). diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index 107182cbdd4..ab059dc7850 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -19,13 +19,13 @@ So here are guidelines: - Do not talk about YAML if it can be partially/fully done in UI. - Do not tell people about stuff they can do later. This can be added to a 2nd tier guide. - - The first page of the guide is for installation, hence Hass.io specific. + - The first page of the guide is for installation, hence Home Assistant specific. Other pages should not refer to it except for the page introducing the last page that introduces `configuration.yaml`. {% endcomment %} -This guide will help you get Home Assistant running on a Raspberry Pi. The easiest way to do this is by using the [Hass.io](/hassio/) installer, which is our all-in-one solution that turns Raspberry Pis and other devices into the ultimate home automation hub. +This guide will help you get Home Assistant running on a Raspberry Pi, turning your Raspberry Pi into the ultimate home automation hub. Follow this guide if you want to get started with Home Assistant easily or if you have little to no Linux experience. For advanced users (or if you don't have a [device that is supported by this guide][supported]), check out our [alternative installation methods](/docs/installation/). Once you finish your alternative installation, you can continue at the [next step][next-step]. @@ -42,7 +42,7 @@ We will need a few things to get started with installing Home Assistant. The Ras ### Software requirements -- Download and extract the HassOS image for [your device](/hassio/installation/) +- Download and extract the Home Assistant image for [your device](/hassio/installation/) - Download [balenaEtcher] to write the image to an SD card [balenaEtcher]: https://www.balena.io/etcher @@ -50,7 +50,7 @@ We will need a few things to get started with installing Home Assistant. The Ras ### Installation 1. Put the SD card in your card reader. -2. Open balenaEtcher, select the HassOS image and flash it to the SD card. +2. Open balenaEtcher, select the Home Assistant image and flash it to the SD card. 3. Unmount the SD card and remove it from your card reader. 4. Follow this step if you want to configure Wi-Fi or a static IP address (this step requires a USB stick). Otherwise, move to step 5. - Format a USB stick to FAT32 with the volume name `CONFIG`. diff --git a/source/hassio/commandline.markdown b/source/hassio/commandline.markdown index 1023c77882b..9e5360ff931 100644 --- a/source/hassio/commandline.markdown +++ b/source/hassio/commandline.markdown @@ -1,93 +1,96 @@ --- -title: "Hass.io via the Command line" -description: "Command line utility to control Hass.io." +title: "Home Assistant via the command line" +description: "Command line utility to control Home Assistant." ---

    -Hass.io upgrade process from the SSH command line +Home Assistant upgrade process from the SSH command line

    -On the SSH command line, you can use the `hassio` command to retrieve logs, check the details of connected hardware, and more. +On the SSH command line, you can use the `ha` command to retrieve logs, check the details of connected hardware, and more. ## Home Assistant ```bash -hassio homeassistant check -hassio homeassistant info -hassio homeassistant logs -hassio homeassistant options -hassio homeassistant rebuild -hassio homeassistant restart -hassio homeassistant start -hassio homeassistant stats -hassio homeassistant stop -hassio homeassistant update +ha core check +ha core info +ha core logs +ha core options +ha core rebuild +ha core restart +ha core start +ha core stats +ha core stop +ha core update ``` ## Supervisor ```bash -hassio supervisor info -hassio supervisor logs -hassio supervisor reload -hassio supervisor update +ha supervisor info +ha supervisor logs +ha supervisor reload +ha supervisor update ``` ## Host ```bash -hassio host reboot -hassio host shutdown -hassio host update +ha host reboot +ha host shutdown +ha host update ``` ## Hardware ```bash -hassio hardware info -hassio hardware audio +ha hardware info +ha hardware audio ``` ## Usage examples To update Home Assistant to a specific version, use the command: ```bash -hassio homeassistant update --version=x.y.z +ha core update --version=x.y.z ``` Replace x.y.z with the desired version like `--version=0.74.2` -You can get a better description of the CLI capabilities by typing `hassio help`: +You can get a better description of the CLI capabilities by typing `ha help`: ```bash +The Home Assistant CLI is a small and simple command line utility that allows +you to control and configure different aspects of Home Assistant + Usage: - hassio [command] + ha [command] Available Commands: - addons Install, update, remove and configure Hass.io add-ons - dns Get information, update or configure the Hass.io DNS server - hardware Provides hardware information about your system - hassos HassOS specific for updating, info and configuration imports - help Help about any command - homeassistant Provides control of Home Assistant running on Hass.io - host Control the host/system that Hass.io is running on - info Provides a general Hass.io information overview - snapshots Create, restore and remove snapshot backups - supervisor Monitor, control and configure the Hass.io Supervisor + addons Install, update, remove and configure Home Assistant add-ons + authentication Authentication for Home Assistant users. + core Provides control of the Home Assistant Core + dns Get information, update or configure the Home Assistant DNS server + hardware Provides hardware information about your system + help Help about any command + host Control the host/system that Home Assistant is running on + info Provides a general Home Assistant information overview + os Operating System specific for updating, info and configuration imports + snapshots Create, restore and remove snapshot backups + supervisor Monitor, control and configure the Home Assistant Supervisor Flags: - --api-token string Hass.io API token + --api-token string Home Assistant Supervisor API token --config string Optional config file (default is $HOME/.homeassistant.yaml) - --endpoint string Endpoint for Hass.io Supervisor ( default is 'hassio' ) - -h, --help help for hassio + --endpoint string Endpoint for Home Assistant Supervisor ( default is 'supervisor' ) + -h, --help help for ha --log-level string Log level (defaults to Warn) --no-progress Disable the progress spinner --raw-json Output raw JSON from the API -Use "hassio [command] --help" for more information about a command. - +Use "ha [command] --help" for more information about a command. ``` ## Console access -You can also access HassOS via a directly connected keyboard and monitor, the console. To log in to the physical console the username is `root`, with no password. +You can also access the Home Assistant Operating System via a directly connected keyboard and monitor, the console. To log in to the physical console the username is `root`, with no password. diff --git a/source/hassio/enable_i2c.markdown b/source/hassio/enable_i2c.markdown index 4ac3a14928c..4c4d2693381 100644 --- a/source/hassio/enable_i2c.markdown +++ b/source/hassio/enable_i2c.markdown @@ -1,11 +1,12 @@ --- -title: "Enable HassOS i2c" -description: "Instructions on how to enable I2C on a Raspberry PI for Hass.io." +title: "Enable i2c on the Home Assistant Operating System" +description: "Instructions on how to enable I2C on a Raspberry PI" --- -Hass.io is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. +Home Assistant using the Home Assistant Operating System, is a managed environment. +Which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. -If you're attempting to add an external sensor, you will have to [enable the I2C interface in the Hass.io configuration](https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/raspberrypi.md#i2c) using a USB stick. +If you're attempting to add an external sensor, you will have to [enable the I2C interface in the Home Assistant configuration](https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/raspberrypi.md#i2c) using a USB stick. ## Step by step instructions @@ -38,8 +39,8 @@ Format a USB stick with FAT32/EXT4/NTFS and name the drive `CONFIG` (uppercase). ### Step 3 - Load the new USB configuration - Insert the USB drive into your Raspberry Pi. -- Now go to your Home Assistant web interface, in the sidebar click **Hass.io** > **System**. +- Now go to your Home Assistant web interface, in the sidebar click **Supervisor** > **System**. - Now click `Import from USB`. -- This will restart your Hass.io instance, and load the new USB configuration. +- This will restart your Home Assistant instance, and load the new USB configuration. When the service has restarted, you will have a working I2C interface. diff --git a/source/hassio/index.markdown b/source/hassio/index.markdown index 405fed31ee3..fd05b8106a7 100644 --- a/source/hassio/index.markdown +++ b/source/hassio/index.markdown @@ -17,7 +17,7 @@ The advantages of using Home Assistant: - Management web interface integrated into Home Assistant - Create and restore full backups of your whole configuration with ease - Install many popular add-ons with a single click! For example [Google Assistant], encryption via [Let's Encrypt] and dynamic DNS via [Duck DNS].

    [Browse available add-ons »][all]

    -- Active community that is helpful and sharing add-ons including AppDaemon, Homebridge and InfluxDB.

    [Browse the forums »][forums]
    [Join the Hass.io chat »][chat]
    [Browse community add-on repositories »][comm-add-ons]

    +- Active community that is helpful and sharing add-ons including AppDaemon, Homebridge and InfluxDB.

    [Browse the forums »][forums]
    [Join the Home Assistant chat »][chat]
    [Browse community add-on repositories »][comm-add-ons]

    diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 4bb0a6dfd62..d36d8a696b3 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -82,7 +82,7 @@ Best practice for updating a Home Assistant installation: SSH to your Home Assistant system, or connect to the console, and run: ```bash -hassio ha update --version=0.XX.X +ha core update --version=0.XX.X ``` ## Run the beta version on Home Assistant @@ -90,16 +90,17 @@ hassio ha update --version=0.XX.X If you would like to test next release before anyone else, you can install the beta version released every three weeks: 1. Backup your installation, using the snapshot functionality Home Assistant offers. -2. Check the [Home Assistant RC release notes](https://rc.home-assistant.io/latest-release-notes/) for breaking changes. Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**. +2. Check the [Home Assistant Beta release notes](https://rc.home-assistant.io/latest-release-notes/) for breaking changes. Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**. 3. Select _System_ tab from the _Supervisor_ menu, then select _Join Beta Channel_ under _Supervisor_, then select _Reload_. 4. Select _Dashboard_ tab from the _Supervisor_ menu, and then select _Update_. -## Alternative: install on a generic Linux host +## Alternative: install Home Assistant Supervised on a generic Linux host -For advanced users, it is also possible to try Home Assistant on your [Linux server or inside a virtual machine][linux]. -Examples given here are tested on Ubuntu and Arch Linux, but the instructions should work as a guideline for installing on other Linux distributions. +You can also install Home Assistant on a Linux operating system of choice, called Home Assistant Supervised. -The packages you need to have available on your system that will run Home Assistant may vary. +Home Assistant Supervised, will still give you access to most features Home Assistant has to offer, including add-ons. + +The packages you need to have available on your system needed to Home Assistant may vary. ### Debian/Ubuntu @@ -208,23 +209,23 @@ When you use this installation method, the core SSH add-on may not function corr A detailed guide about running Home Assistant as a virtual machine is available in the [blog][hassio-vm]. [balenaEtcher]: https://www.balena.io/etcher -[Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md -[hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md -[pi0-w]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi0-w-3.10.img.gz -[pi1]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi-3.10.img.gz -[pi2]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi2-3.10.img.gz -[pi3-32]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi3-3.10.img.gz -[pi3-64]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi3-64-3.10.img.gz -[pi4-32]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi4-3.10.img.gz -[pi4-64]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_rpi4-64-3.10.img.gz -[tinker]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_tinker-3.10.img.gz -[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_odroid-c2-3.10.img.gz -[odroid-n2]: https://github.com/home-assistant/hassos/releases/download/4.2/hassos_odroid-n2-4.2.img.gz -[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_odroid-xu4-3.10.img.gz -[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_intel-nuc-3.10.img.gz -[vmdk]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_ova-3.10.vmdk.gz -[vhdx]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_ova-3.10.vhdx.gz -[vdi]: https://github.com/home-assistant/hassos/releases/download/3.10/hassos_ova-3.10.vdi.gz +[Virtual Appliance]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/boards/ova.md +[hassos-network]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/network.md +[pi0-w]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_rpi0-w-3.10.img.gz +[pi1]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_rpi-3.10.img.gz +[pi2]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_rpi2-3.10.img.gz +[pi3-32]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_rpi3-3.10.img.gz +[pi3-64]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_rpi3-64-3.10.img.gz +[pi4-32]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_rpi4-3.10.img.gz +[pi4-64]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_rpi4-64-3.10.img.gz +[tinker]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_tinker-3.10.img.gz +[odroid-c2]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_odroid-c2-3.10.img.gz +[odroid-n2]: https://github.com/home-assistant/operating-system/releases/download/4.2/hassos_odroid-n2-4.2.img.gz +[odroid-xu4]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_odroid-xu4-3.10.img.gz +[intel-nuc]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_intel-nuc-3.10.img.gz +[vmdk]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_ova-3.10.vmdk.gz +[vhdx]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_ova-3.10.vhdx.gz +[vdi]: https://github.com/home-assistant/operating-system/releases/download/3.10/hassos_ova-3.10.vdi.gz [linux]: https://github.com/home-assistant/hassio-installer [local]: http://hassio.local:8123 [samba]: /addons/samba/ diff --git a/source/hassio/installing_third_party_addons.markdown b/source/hassio/installing_third_party_addons.markdown index 21310ad6a68..fd812d71cb9 100644 --- a/source/hassio/installing_third_party_addons.markdown +++ b/source/hassio/installing_third_party_addons.markdown @@ -3,7 +3,7 @@ title: "Installing third-party add-ons" description: "Instructions on how to get started using third-party add-ons." --- -Hass.io allows anyone to create add-on repositories to share their add-ons for Hass.io easily. To try this locally, you can use our example add-on repository at +Home Assistant allows anyone to create add-on repositories to share their add-ons easily. To try this locally, you can use our example add-on repository at ```text https://github.com/home-assistant/hassio-addons-example @@ -15,7 +15,7 @@ Home Assistant cannot guarantee the quality or security of third-party add-ons.

    -From the Hass.io main panel open the add-on store. +From the Supervisor main panel open the add-on store.

    @@ -25,4 +25,4 @@ Add the URL of the repository and then press "Add". A new card for the repositor ### Help: Repository is not showing up -If you have added a repository, but it's not showing up, it means that the repository contains invalid configuration. Go to the Hass.io panel and then the System tab to find the System log. It should tell you what went wrong. Report this information to the repository author. +If you have added a repository, but it's not showing up, it means that the repository contains invalid configuration. Go to the Supervisor panel and then the System tab to find the System log. It should tell you what went wrong. Report this information to the repository author. diff --git a/source/hassio/zwave.markdown b/source/hassio/zwave.markdown index 23dd5da322d..9499c3922c1 100644 --- a/source/hassio/zwave.markdown +++ b/source/hassio/zwave.markdown @@ -12,7 +12,8 @@ zwave: ## RAZBERRY BOARD -If you need GPIO on Raspberry Pi 3 for your Z-Wave module, add the following line into `config.txt` (you have to access that on the SD card directly. Simply plug it into your PC and edit it there. The `config.txt` is not accessible from your Hass.io system, you may need to open the SD card on a Windows or Linux system.): +If you need GPIO on Raspberry Pi 3 for your Z-Wave module, add the following line into `config.txt` (you have to access that on the SD card directly. Simply plug it into your PC and edit it there. +The `config.txt` is not accessible from the Home Assistant Operating System, you may need to open the SD card on a Windows or Linux system.: ```txt dtoverlay=pi3-miniuart-bt @@ -50,13 +51,13 @@ systemctl disable ModemManager.service ### Finding the path -If the above defaults don't work, you can check what hardware has been found using the [`hassio` command](/hassio/commandline/#hardware): +If the above defaults don't work, you can check what hardware has been found using the [`ha` command](/hassio/commandline/#hardware): ```bash -$ hassio hardware info +ha hardware info ``` -Or you can use the UI and look in the *System* section of the *Hass.io* menu. There you'll find a *Hardware* button which will list all the hardware found. +Or you can use the UI and look in the *System* section of the *Supervisor* menu. There you'll find a *Hardware* button which will list all the hardware found. ## Further reading