Skip to content

Commit 558cada

Browse files
committed
Update addon docs
1 parent ae18d3a commit 558cada

File tree

4 files changed

+25
-14
lines changed

4 files changed

+25
-14
lines changed

source/_addons/configurator.markdown

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
11
---
22
layout: page
3-
title: "Configurator"
3+
title: "HASS Configurator"
44
description: "Browser-based configuration file editor for Home Assistant."
55
date: 2017-09-25 14:00
66
sidebar: true
77
comments: false
88
sharing: true
99
footer: true
10+
og_image: /images/hassio/screenshots/addon-hass-configurator.png
1011
---
1112

12-
As long as a fully featured configuration GUI for Home Assistant is still under development, you can use this add-on to add a browser based file-editor to your Hass.IO installation. By default it will listen on port `3218` of the host Hass.IO is running on.
13-
More information and a standalone version for regular Home Assistant installations can be found in the original repository at https://github.com/danielperna84/hass-configurator.
13+
As long as a fully featured configuration GUI for Home Assistant is still under development, you can use this add-on to add a browser based file-editor to your Hass.IO installation. By default it will listen on port `3218` of the host Hass.IO is running on.
1414

15-
![Screenshot](https://github.com/danielperna84/hass-configurator/blob/master/hass-poc-configurator.png)
15+
More information and a standalone version for regular Home Assistant installations can be found in the [GitHub repository][code].
16+
17+
[code]: https://github.com/danielperna84/hass-configurator
18+
19+
<p class='img'>
20+
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
21+
Screenshot of the HASS Configurator.
22+
</p>
1623

1724
### {% linkable_title Feature list %}
1825

@@ -25,7 +32,7 @@ More information and a standalone version for regular Home Assistant installatio
2532
- Optional authentication and IP filtering for added security.
2633
- Direct links to Home Assistant documentation and icons.
2734
- Execute shell commands within the add-on container.
28-
- Modified editor settings can be saved using [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
35+
- Editor settings are saved in your browser.
2936

3037
### {% linkable_title Add-on Configuration %}
3138

@@ -34,8 +41,8 @@ More information and a standalone version for regular Home Assistant installatio
3441
"homeassistant_api": "http://homeassistant:8123/api",
3542
"homeassistant_password": "",
3643
"username": "admin",
37-
 "password": "secret",
38-
 "certfile": "fullchain.pem",
44+
"password": "secret",
45+
"certfile": "fullchain.pem",
3946
"keyfile": "privkey.pem",
4047
"ssl": false,
4148
"allowed_networks": ["192.168.0.0/16"],
@@ -53,8 +60,10 @@ More information and a standalone version for regular Home Assistant installatio
5360
- **banned_ips** (*Optional*): List of statically banned IP addresses.
5461
- **ignore_pattern** (*Optional*): Files and folders to ignore in the UI.
5562

56-
### {% Embedding into Home-Assistant %}
57-
Home Assistant has the [panel_iframe](https://home-assistant.io/components/panel_iframe/) component. With this it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration within the Home Assistant frontend.
63+
### {% linkable_title Embedding into Home-Assistant %}
64+
65+
Using the Home Assistant component [panel_iframe](https://home-assistant.io/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration within the Home Assistant frontend.
66+
5867
An example configuration would look like this:
5968

6069
```yaml
@@ -65,6 +74,6 @@ panel_iframe:
6574
url: http://hassio.local:3218
6675
```
6776
68-
<p class='note'>
77+
<p class='note warning'>
6978
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and / or blocking based on client IP addresses, your configuration will be exposed to the internet!
7079
</p>

source/_addons/duckdns.markdown

+5-3
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ featured: true
1515
```json
1616
{
1717
"lets_encrypt": {
18-
"accept_terms": false
18+
"accept_terms": true
1919
},
2020
 "token": "sdfj-2131023-dslfjsd-12321",
21-
"domains": ["my-first-account.duckdns.org", "my-second-account.duckdns.org"]
21+
"domains": ["my-domain.duckdns.org"]
2222
}
2323
```
2424

@@ -27,4 +27,6 @@ Configuration variables:
2727
- **token** (*Required*): Your Duck DNS API key.
2828
- **domains** (*Required*): A list of domains to update DNS.
2929
- **seconds** (*Optional*): Seconds between updates to Duck DNS.
30-
- **lets_encrypt.accept_terms** (*Optional*): If that will be enabled, it generate & update let's enrypt certificate
30+
- **lets_encrypt.accept_terms** (*Optional*): If you accept the [Let's Encrypt Subscriber Agreement][le], it will generate & update Let's Enrypt certificates for your DuckDNS domain.
31+
32+
[le]: https://letsencrypt.org/repository/

source/addons/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
comments: false
88
sharing: true
99
footer: true
10-
regenerate: true
10+
regenerate: false
1111
---
1212

1313
<p>Add-ons for Hass.io allows the user to extend the functionality around Home Assistant. This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing from other computers. Add-ons can be configured via the Hass.io panel in Home Assistant.</p>

0 commit comments

Comments
 (0)