Skip to content

Commit 5526af1

Browse files
committed
Merge remote-tracking branch 'origin/current' into rc
2 parents 3b4e311 + 6a9c9d7 commit 5526af1

File tree

5 files changed

+19
-6
lines changed

5 files changed

+19
-6
lines changed

source/_addons/nginx_proxy.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ In the `http` section of the `configuration.yaml` file remove `ssl_certificate`
1818
"domain": "home.example.com",
1919
"certfile": "fullchain.pem",
2020
"keyfile": "privkey.pem",
21+
"hsts": "max-age=31536000; includeSubDomains",
2122
"customize": {
2223
"active": false,
2324
"default": "nginx_proxy_default*.conf",
@@ -31,6 +32,7 @@ Configuration variables:
3132
- **domain** (*Required*): Domain they will proxy run with it.
3233
- **certfile** (*Required*): Certificate file to use in the /ssl dir.
3334
- **keyfile** (*Required*): Private key file to use in the /ssl dir.
35+
- **hsts** (*Optional*): Value for the [`Strict-Transport-Security`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) HTTP header to send. If empty or `null`, the header is not sent.
3436
- **customize** (*Optional*): If true, additional NGINX configuration files for the default server and additional servers are read from files in the /share dir specified by the `default` and `servers` variables.
3537

3638
<p class='note'>

source/_components/http.markdown

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,6 @@ To use those kind of [sensors](/components/sensor.http/) or [binary sensors](com
7575

7676
All [requests](/developers/rest_api/#post-apistatesltentity_id) need to be sent to the endpoint of the device and must be **POST**.
7777

78-
If you want to use Home Assistant to host or serve static files then create a directory called `www` under the `.homeassistant` configuration path. The static files in `.homeassistant/www/` can be accessed by the following URL `http://your.domain:8123/local/`.
79-
8078
If you want to apply additional IP filtering, and automatically ban brute force attempts, set `ip_ban_enabled` to `True` and the maximum number of attempts. After the first ban, an `ip_bans.yaml` file will be created in the root configuration folder. It will have the banned IP address and time in UTC when it was added:
8179

8280
```yaml
@@ -89,3 +87,11 @@ After a ban is added a Persistent Notification is populated to the Home Assistan
8987
<p class='note warning'>
9088
Please note, that sources from `trusted_networks` won't be banned automatically.
9189
</p>
90+
91+
## {% linkable_title Hosting files %}
92+
93+
If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config` on Hass.io, `.homeassistant` elswhere). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`.
94+
95+
<p class='note'>
96+
If you've had to create the `www/` folder for the first time, you'll need to restart Home Assistant.
97+
</p>

source/_components/media_player.mediaroom.markdown

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,17 @@ Notice that all parameters are optional, and discovery should configure everythi
4747
4848
The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082.
4949
50-
In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. In case you have more than one STB you are required to set the *host* in each one of the entries.
50+
In most cases (single STB) you just need to setup the *platform* and discovery will do the rest.
5151
5252
If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable.
5353
5454
## {% linkable_title Examples %}
5555
5656
### {% linkable_title Example `press_button` script %}
5757

58-
The `play_media` function can be used in scripts to change channels.
58+
The `play_media` function can be used in scripts to change channels and emulate button pressing from a remote control.
5959

60+
{% raw %}
6061
```yaml
6162
# Example play_media script
6263
#
@@ -67,6 +68,8 @@ press_button:
6768
entity_id: media_player.mediaroom_stb
6869
media_content_id: "{{ value }}"
6970
media_content_type: "channel"
71+
```
72+
{% endraw %}
7073

7174
### {% linkable_title Example configuration with 2 STB %}
7275

source/_docs/configuration.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ If you want to use a different folder for configuration, use the config command
2626
Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains components to be loaded with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable functionality.
2727

2828
<p class='note'>
29-
You will have to restart Home Assistant for changes to `configuration.yaml` to take effect.
29+
You will have to restart Home Assistant for most changes to `configuration.yaml` to take effect. You can load changes to [automations](/docs/automation/), [customize](/docs/configuration/customizing-devices/), [groups](/components/group/), and [scripts](/components/script/) without restarting.
3030
</p>
3131

3232
If you run into trouble while configuring Home Assistant, have a look at the [configuration troubleshooting page](/getting-started/troubleshooting-configuration/) and at the [configuration.yaml examples](/cookbook/#example-configurationyaml).
3333

3434
<p class='note tip'>
35-
Test any changes to your configuration files from the command line with `hass --script check_config`. This script allows you to test changes without the need to restart Home Assistant.
35+
Test any changes to your configuration files from the command line with `hass --script check_config`. This script allows you to test changes without the need to restart Home Assistant. Remember to run this as the user you run Home Assistant as.
3636
</p>
3737

source/developers/documentation/standards.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo
2828
* Use `[string, int]` for configuration variables that accept multiple types.
2929
* Use YAML sequence syntax in the sample code if it is supported.
3030
* All examples should be formatted to be included in `configuration.yaml` unless explicitly stated.
31+
* Use capital letters and `_` to indicate that the value needs to be replaced. E.g., `api_key: YOUR_API_KEY` or `api_key: REPLACE_ME`.
32+
* If you know that the API key or value contains [control characters](https://en.wikipedia.org/wiki/YAML#Syntax), e.g., `#`, `[`, `?`, etc., wrap it in quotes and add a note.
3133
* Component and platform names should be a link to their respective documentation pages.
3234

3335
## {% linkable_title Templates %}

0 commit comments

Comments
 (0)