Update docs for community Hass.io add-ons (#721)

This commit is contained in:
Otto Winter 2020-07-30 10:33:46 +02:00 committed by GitHub
parent 9d38102539
commit fabf43dcc8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 19 deletions

View File

@ -144,9 +144,12 @@ by installing the tested beta:
# For docker-based installs
docker run [...] -it esphome/esphome:beta livingroom.yaml run
And for Hass.io, you will see a "ESPHome Beta" Add-On for the beta channel.
For Home Assistant supervised installs add the community addons beta repository by
adding
`https://github.com/hassio-addons/repository-beta <https://github.com/hassio-addons/repository-beta>`__
in Add-on store -> Repositories.
The beta docs can be viewed at `beta.esphome.io <https://beta.esphome.io>`__
The beta docs are available at `beta.esphome.io <https://beta.esphome.io>`__
How do I use the latest bleeding edge version?
----------------------------------------------
@ -156,22 +159,14 @@ If you find some, please do however report them if you have time :)
To install the dev version of ESPHome:
- In Hass.io: In the ESPHome add-on repository there's also a second add-on called ``ESPHome Dev``.
Install that and stop the stable version (both can't run at the same time without port collisions).
- In Hass.io: Add the ESPHome repository `https://github.com/esphome/hassio <https://github.com/esphome/hassio>`
in Add-on store -> Repositories. Then install the add-on ``ESPHome Dev``
- From ``pip``: Run ``pip install https://github.com/esphome/esphome/archive/dev.zip``
- From docker, you need to build the docker image yourself (automated dev builds are not possible
due to docker hubs limited build quota)
- From docker, use the `esphome/esphome:dev <https://hub.docker.com/r/esphome/esphome/tags?page=1&name=dev>`__ image
.. code-block:: bash
git clone https://github.com/esphome/esphome.git
cd esphome
docker build -t esphome-dev -f docker/Dockerfile .
docker run [...] -it esphome-dev livingroom.yaml compile
# Update image and rebuild
git pull
docker build -t esphome-dev -f docker/Dockerfile .
docker run [...] -it esphome:dev livingroom.yaml compile
The latest dev docs are here: `next.esphome.io <https://next.esphome.io/>`__

View File

@ -19,18 +19,19 @@ Assistant's UI.
Installation
------------
Installing the ESPHome Home Assistant add-on is easy. Just navigate to the Supervisor
panel in your Home Assistant frontend and add the ESPHome add-on repository:
https://github.com/esphome/hassio
Installing the ESPHome Home Assistant add-on is easy. Navigate to the Supervisor
panel in your Home Assistant frontend, then enter ``ESPHome`` in the searchbar of the "Add-on Store"
tab.
.. figure:: images/hassio_repo.png
Then, scroll down and locate the ESPHome Home Assistant add-ons section. Click on ESPHome, then INSTALL.
Click on ESPHome, then INSTALL.
.. figure:: images/hassio_addons_section.png
After that, wait a bit until the add-on is installed (this can take a while) and
go to the add-on page. Start the add-on and then click "Open Web UI".
go to the add-on page. Start the add-on and then click "Open Web UI". If you see "502: Bad Gateway" the
addon is currently starting, and you can refresh the page after a couple of seconds.
.. figure:: images/hassio_addon.png
:align: center

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 198 KiB

After

Width:  |  Height:  |  Size: 34 KiB