Skip to content

Display template tags in Pushbullet Home Assistant release example #1193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3 changes: 2 additions & 1 deletion source/_components/device_tracker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The following optional parameters can be used with any platform. However device
|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `track_new_devices` | True | If new discovered devices are tracked by default |
| `interval_seconds` | 12 | Seconds between each scan for new devices |
| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. |
| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (E.g. the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) |

The extended example from above would look like the following sample:

Expand Down Expand Up @@ -73,3 +73,4 @@ devicename:
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` |
| `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
| `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home |
| `consider_home` | [uses platform setting] | Allows you to override the global `consider_home` setting from the platform configuration on a per device level |
57 changes: 29 additions & 28 deletions source/_components/sensor.darksky.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -26,39 +26,40 @@ To add Dark Sky to your installation, add the following to your `configuration.y
```yaml
# Example configuration.yaml entry
sensor:
platform: darksky
api_key: YOUR_APP_KEY
monitored_conditions:
- summary
- icon
- nearest_storm_distance
- nearest_storm_bearing
- precip_type
- precip_intensity
- precip_probability
- temperature
- apparent_temperature
- dew_point
- wind_speed
- wind_bearing
- cloud_cover
- humidity
- pressure
- visibility
- ozone
- minutely_summary
- hourly_summary
- daily_summary
- temperature_max
- temperature_min
- apparent_temperature_max
- apparent_temperature_min
- precip_intensity_max
- platform: darksky
api_key: YOUR_APP_KEY
monitored_conditions:
- summary
- icon
- nearest_storm_distance
- nearest_storm_bearing
- precip_type
- precip_intensity
- precip_probability
- temperature
- apparent_temperature
- dew_point
- wind_speed
- wind_bearing
- cloud_cover
- humidity
- pressure
- visibility
- ozone
- minutely_summary
- hourly_summary
- daily_summary
- temperature_max
- temperature_min
- apparent_temperature_max
- apparent_temperature_min
- precip_intensity_max
```

Configuration variables:

- **api_key** (*Required*): Your API key.
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **summary**: A human-readable text summary of the current conditions.
- **precip_type**: The type of precipitation occurring.
Expand Down
1 change: 1 addition & 0 deletions source/_components/sensor.openweathermap.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ sensor:
Configuration variables:

- **api_key** (*Required*): Your API key for http://openweathermap.org/.
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
- **forecast** (*Optional*): Enables the forecast. The default is to display the current conditions.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **weather**: A human-readable text summary.
Expand Down
7 changes: 5 additions & 2 deletions source/_components/sensor.statistics.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ sensor:

Configuration variables:

- **entity_id** (*Required*): The entity to monitor.
- **name** (*Optional*): Name of the sensor to use in the frontend.
- **entity_id** (*Required*): The entity to monitor. Only [sensors](/components/sensor/) and [binary sensor](/components/binary_sensor/).
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Stats`.
- **sampling_size** (*Optional*): Size of the sampling. If the limit is reached then the values are rotated. Defaults to `20`.

<p class='img'>
<img src='{{site_root}}/images/screenshots/stats-sensor.png' />
</p>
2 changes: 1 addition & 1 deletion source/_components/sensor.yweather.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Configuration variables:

- **woeid** (*Optional*): See above.
- **forecast** (*Optional*): Day of forecast. The default is the current day to display conditions.
- **name** (*Optional*): The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option.
- **name** (*Optional*): The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option. Defaults to `Yweather`.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- **weather**: A human-readable text summary with picture from yahoo.
- **weather_current**: A human-readable text summary with picture from yahoo from current conditon.
Expand Down
2 changes: 1 addition & 1 deletion source/_cookbook/notify_if__new_ha_release.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@ automation:
data:
title: 'New Home Assistant Release'
target: 'YOUR_TARGET_HERE' #See Pushbullet component for usage
message: "Home Assistant {{ states.updater.updater.state }} is now available."
message: "Home Assistant {% raw %} {{ states.updater.updater.state }} {% raw %} is now available."
```

34 changes: 34 additions & 0 deletions source/_cookbook/tls_self_signed_certificate.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: page
title: "Self-signed certificate for SSL/TLS"
description: "Configure a self-signed certificate to use with Home Assistant"
date: 2016-10-06 08:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Infrastructure
---

If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. [Let's encrypt](blog/2015/12/13/setup-encryption-using-lets-encrypt/) will only work if you have a DNS entry and remote access is allowed. The solution is to use a self-signed certificate. As you most likely don't have a certification authority (CA) your browser will conplain about the security. If you have a CA then this will not be an issue.

To create locally a certificate you need the [OpenSSL](https://www.openssl.org/) command-line tool.

Change to your Home Assistant [configuration directory](/getting-started/configuration/) like `~/.homeassistant`. This will make it easier to backup your certificate and the key. Run the command shown below.

```bash
$ openssl req -new -x509 -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -days 730 -out fullchain.pem
```

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.

```yaml
http:
api_password: YOUR_SECRET_PASSWORD
ssl_certificate: /home/fab/.homeassistant/fullchain.pem
ssl_key: /home/fab/.homeassistant/privkey.pem
```

A tutorial "[Working with SSL Certificates, Private Keys and CSRs](https://www.digitalocean.com/community/tutorials/openssl-essentials-working-with-ssl-certificates-private-keys-and-csrs)" could give you some insight about special cases.
39 changes: 39 additions & 0 deletions source/_cookbook/webserver_details.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: page
title: "Details about the web server"
description: "Use nmap to scan your Home Assistant instance"
date: 2016-10-06 08:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Infrastructure
---

It was only a matter of time till the first queries for tools like [https://www.shodan.io](https://www.shodan.io/search?query=Home+Assistant) to search for Home Assistant instances showed up.

To get an idea about how your Home Assistant instance looks like for network scanner, you can use `nmap`. The `nmap` tool is already available if you are using the [nmap device tracker](/components/device_tracker/).

```yaml
$ nmap -sV -p 8123 --script=http-title,http-headers 192.168.1.3

Starting Nmap 7.12 ( https://nmap.org ) at 2016-10-06 10:01 CEST
Nmap scan report for 192.168.1.3 (192.168.1.3)
Host is up (0.00011s latency).
PORT STATE SERVICE VERSION
8123/tcp open http CherryPy wsgiserver
| http-headers:
| Content-Type: text/html; charset=utf-8
| Content-Length: 4309
| Connection: close
| Date: Thu, 06 Oct 2016 08:01:31 GMT
| Server: Home Assistant
|
|_ (Request type: GET)
|_http-server-header: Home Assistant
|_http-title: Home Assistant

Service detection performed. Please report any incorrect results at https://nmap.org/submit/ .
Nmap done: 1 IP address (1 host up) scanned in 6.70 seconds
```

1 change: 1 addition & 0 deletions source/_includes/asides/getting_started_navigation.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ <h1 class="title delta">Getting Started Guide</h1>
<li>{% active_link /getting-started/customizing-devices/ Customizing devices and services %}</li>
<li>{% active_link /getting-started/presence-detection/ Presence Detection %}</li>
<li>{% active_link /getting-started/troubleshooting-configuration/ Troubleshooting %}</li>
<li>{% active_link /getting-started/securing/ Security Check Points %}</li>
</ul>
</li>
<li>
Expand Down
8 changes: 8 additions & 0 deletions source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ sensor
- Device Tracker: The `known_device.yaml` file is now validated ([@kellerza])
- Minor features and bug fixes by [@tchellomello], [@pavoni], [@fabaff], [@pvizeli], [@lwis], [@turbokongen], [@Danielhiversen], [@persandstrom], [@balloob], [@robbiet480], [@sam-io], [@bbangert], and you if you are missing here.

### {% linkable_title Release 0.30.1 - October 8 %}

- Device Tracker `known_devices.yaml` validation is now more accepting ([@kellerza])
- Handle X10 light numbers greater than 9 ([@mtl010957])
- Fix command line covers without a template ([@roidayan])

### {% linkable_title Breaking changes %}

- All deprecated condition options from `automation` have been removed (deprecated since May and have printed warnings to your console):
Expand Down Expand Up @@ -136,6 +142,8 @@ sensor
[@tchellomello]: https://github.com/tchellomello
[@turbokongen]: https://github.com/turbokongen
[@w1ll1am23]: https://github.com/w1ll1am23
[@mtl010957]: https://github.com/mtl010957
[@roidayan]: https://github.com/roidayan

[arest]: https://arest.io/
[arest-sensor]: /components/sensor.arest/
Expand Down
12 changes: 12 additions & 0 deletions source/configuration_yaml_by_mertenats.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: page
title: "Configuration.yaml by mertenats"
description: ""
date: 2016-10-08 19:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Example configuration.yaml
ha_external_link: https://github.com/mertenats/open-home-automation/tree/master/openhome
---
2 changes: 1 addition & 1 deletion source/getting-started/presence-detection.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Home Assistant will know the location of your device if you are using OwnTracks.
### [Next step: Setting up automation &raquo;](/getting-started/automation/)

[routers]: /components/#presence-detection
[nmap]: /components/device_tracker.nmap_scanner/
[nmap]: /components/device_tracker.nmap_tracker/
[ha-owntracks]: /components/device_tracker.owntracks/
[ha-locative]: /components/device_tracker.locative/
[mqtt-self]: /components/mqtt/#run-your-own
Expand Down
28 changes: 28 additions & 0 deletions source/getting-started/securing.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: page
title: "Securing"
description: "Instructions how to secure your Home Assistant installation."
date: 2016-10-06 06:00
sidebar: true
comments: false
sharing: true
footer: true
---

One of the reasons to use Home Assistant is that it's not depending on cloud services. Even if you are only using Home Assistant in your local network, you should consider to secure your instance.

### {% linkable_title Checklist %}

- [Protect your web interface with a password](https://home-assistant.io/getting-started/basic/#password-protecting-the-web-interface)
- Secure your host. Sources could be [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/pdf/Security_Guide/Red_Hat_Enterprise_Linux-7-Security_Guide-en-US.pdf), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf), or the [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html).
- Restrict network access to your device. Set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use keys for authentication instead of passwords.
- Don't run Home Assistant as root.
- Keep your [secrets](/topics/secrets/) safe.

Additional points if you want to allow remote access:

- Protect your communication with [TLS](blog/2015/12/13/setup-encryption-using-lets-encrypt/)
- Protect your communication with [Tor](/cookbook/tor_configuration/)
- Use a [proxy](/cookbook/apache_configuration/)


2 changes: 1 addition & 1 deletion source/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="grid">
<div class="grid__item one-third lap-one-third palm-one-whole">
<div class='current-version material-card text'>
<h1>Current Version: 0.30</h1>
<h1>Current Version: 0.30.1</h1>
Released: <span class='release-date'>October 8, 2016</span>

<div class='links'>
Expand Down