From 02ee39a27c72edbd866d51f7194aef8b63bee43a Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:11:25 +0200 Subject: [PATCH] f-integrations: add glossary reference to config file (#32755) --- source/_integrations/fail2ban.markdown | 6 +++--- source/_integrations/fan.mqtt.markdown | 3 ++- source/_integrations/ffmpeg.markdown | 2 +- source/_integrations/file.markdown | 6 +++--- source/_integrations/fireservicerota.markdown | 2 +- source/_integrations/firmata.markdown | 2 +- source/_integrations/folder.markdown | 2 +- source/_integrations/foobot.markdown | 2 +- source/_integrations/foursquare.markdown | 2 +- source/_integrations/freedns.markdown | 2 +- source/_integrations/frontend.markdown | 8 ++++---- source/_integrations/futurenow.markdown | 2 +- 12 files changed, 20 insertions(+), 19 deletions(-) diff --git a/source/_integrations/fail2ban.markdown b/source/_integrations/fail2ban.markdown index e8481d13f81..76ab10e5677 100644 --- a/source/_integrations/fail2ban.markdown +++ b/source/_integrations/fail2ban.markdown @@ -65,7 +65,7 @@ For those of us using Docker, the above tutorial may not be sufficient. The foll #### Set HTTP logger -In your `configuration.yaml` file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. +In your {% term "`configuration.yaml`" %} file, add the following to the `logger` integration to ensure that Home Assistant prints failed login attempts to the log. ```yaml logger: @@ -161,7 +161,7 @@ server { } ``` -Once that's added to the NGINX configuration, we need to modify the Home Assistant `configuration.yaml` such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` integration: +Once that's added to the NGINX configuration, we need to modify the Home Assistant {% term "`configuration.yaml`" %} such that the `X-Forwarded-For` header can be parsed. This is done by adding the following to the `http` integration: ```yaml http: @@ -172,7 +172,7 @@ At this point, once the Let's Encrypt and Home Assistant dockers are restarted, #### Add the fail2ban sensor -Now that we've correctly set everything up for Docker, we can add our sensors to `configuration.yaml` with the following: +Now that we've correctly set everything up for Docker, we can add our sensors to {% term "`configuration.yaml`" %} with the following: ```yaml sensor: diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index e6a84090b2c..0433ed81bc9 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -18,7 +18,8 @@ When a `state_topic` is not available, the fan will work in optimistic mode. In Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect fan operation. -To enable MQTT fans in your installation, add the following to your `configuration.yaml` file: +To enable MQTT fans in your installation, add the following to your {% term "`configuration.yaml`" %} file. +{% include integrations/restart_ha_after_config_inclusion.md %} ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/ffmpeg.markdown b/source/_integrations/ffmpeg.markdown index fc1b56c5551..dacc5224b28 100644 --- a/source/_integrations/ffmpeg.markdown +++ b/source/_integrations/ffmpeg.markdown @@ -20,7 +20,7 @@ you have FFmpeg installed on your system. ## Configuration -To set it up, add the following information to your `configuration.yaml` file: +To set it up, add the following information to your {% term "`configuration.yaml`" %} file: ```yaml ffmpeg: diff --git a/source/_integrations/file.markdown b/source/_integrations/file.markdown index 458d208aae5..02953330523 100644 --- a/source/_integrations/file.markdown +++ b/source/_integrations/file.markdown @@ -62,7 +62,7 @@ To use notifications, please see the [getting started with automation page](/get The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs). -To enable the `file` sensor, add the following lines to your `configuration.yaml`: +To enable the `file` sensor, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry @@ -105,7 +105,7 @@ Assuming that the log file contains multiple values formatted as JSON like shown {"temperature": 22, "humidity": 36} ``` -This would require the following entry in the `configuration.yaml` file to extract the temperature: +This would require the following entry in the {% term "`configuration.yaml`" %} file to extract the temperature: {% raw %} @@ -131,7 +131,7 @@ timestamp,temperature,humidity 1631472949,22,36 ``` -This would require the following entry in the `configuration.yaml` file to extract the temperature: +This would require the following entry in the {% term "`configuration.yaml`" %} file to extract the temperature: {% raw %} diff --git a/source/_integrations/fireservicerota.markdown b/source/_integrations/fireservicerota.markdown index d4c62376b76..4dd7cb63dc0 100644 --- a/source/_integrations/fireservicerota.markdown +++ b/source/_integrations/fireservicerota.markdown @@ -215,7 +215,7 @@ This screenshot shows what a FireServiceRota dashboard can look like. ## Debugging -The FireServiceRota integration will log additional information about WebSocket incidents received, response and duty status gathered, and other messages when the log level is set to `debug`. Add the relevant lines below to the `configuration.yaml`: +The FireServiceRota integration will log additional information about WebSocket incidents received, response and duty status gathered, and other messages when the log level is set to `debug`. Add the relevant lines below to the {% term "`configuration.yaml`" %}: ```yaml logger: diff --git a/source/_integrations/firmata.markdown b/source/_integrations/firmata.markdown index a72cac55431..fcb3f7ecb6d 100644 --- a/source/_integrations/firmata.markdown +++ b/source/_integrations/firmata.markdown @@ -35,7 +35,7 @@ There is currently support for the following device types within Home Assistant: You will need to upload a [Firmata firmware](https://github.com/firmata/) to your board. Please upload any `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information for uploading sketches. Firmata is available in the Arduino Library Manager in the Arduino IDE. You may also use a [Firmata Express](https://github.com/MrYsLab/FirmataExpress). -To integrate Arduino boards with Home Assistant, add the following section to your `configuration.yaml` file: +To integrate Arduino boards with Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file:
Firmata does not store the last state across power cycles. This means that with every powerup the pins are set to off/low and after every initialization, they will be set to the default that you have configured in YAML. diff --git a/source/_integrations/folder.markdown b/source/_integrations/folder.markdown index b9a1763969e..f47e4a52f80 100644 --- a/source/_integrations/folder.markdown +++ b/source/_integrations/folder.markdown @@ -17,7 +17,7 @@ The sensor exposes the number of filtered files in the folder, total size in byt ## Configuration -To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file: +To enable the `folder` sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml sensor: diff --git a/source/_integrations/foobot.markdown b/source/_integrations/foobot.markdown index baf75ce54b8..3e4b97074d2 100644 --- a/source/_integrations/foobot.markdown +++ b/source/_integrations/foobot.markdown @@ -17,7 +17,7 @@ This sensor requires an API token. Please obtain one at [Foobot API site](https: ## Configuring the Platform -To enable this sensor, add the following lines to your `configuration.yaml` file: +To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml sensor: diff --git a/source/_integrations/foursquare.markdown b/source/_integrations/foursquare.markdown index e5567e14225..5f13eee2d23 100644 --- a/source/_integrations/foursquare.markdown +++ b/source/_integrations/foursquare.markdown @@ -47,7 +47,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values. You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes". -After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your `configuration.yaml` as the `access_token`. +After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your {% term "`configuration.yaml`" %} as the `access_token`. ### Real-Time API diff --git a/source/_integrations/freedns.markdown b/source/_integrations/freedns.markdown index 5522c1af716..f6f77adab2e 100644 --- a/source/_integrations/freedns.markdown +++ b/source/_integrations/freedns.markdown @@ -47,7 +47,7 @@ You need to determine your update URL or your access token. ## Configuration (API V2) -To use the integration in your installation, add the following to your `configuration.yaml` file: +To use the integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown index cdb056af35b..3f47415e916 100644 --- a/source/_integrations/frontend.markdown +++ b/source/_integrations/frontend.markdown @@ -145,7 +145,7 @@ Theme `day_and_night`: This theme has both a `light` and a `dark` mode section. As with all configuration, you can either: -- Directly specify the themes inside your `configuration.yaml` file. +- Directly specify the themes inside your {% term "`configuration.yaml`" %} file. - Put them into a separate file (e.g., `themes.yaml`) and include that in your configuration (`themes: !include themes.yaml`). - Create a dedicated folder (e.g., `my_themes`) and include all files from within this folder (`themes: !include_dir_merge_named my_themes`). @@ -157,7 +157,7 @@ Check our [community forums](https://community.home-assistant.io/c/projects/them There are two themes-related services: -- `frontend.reload_themes`: Reloads theme configuration from your `configuration.yaml` file. +- `frontend.reload_themes`: Reloads theme configuration from your {% term "`configuration.yaml`" %} file. - `frontend.set_theme`: Sets backend-preferred theme name. ### Service `set_theme` @@ -165,14 +165,14 @@ There are two themes-related services: | Service data attribute | Description | | ---------------------- | --------------------------------------------------------------------------------------------------- | | `name` | Name of the theme to set, `default` for the default theme or `none` to restore to the default. | -| `mode` | If the theme should be applied in light or dark mode `light` or `dark` (Optional, default `light`). | +| `mode` | If the theme should be applied in light or dark mode `light` or `dark` (Optional, default `light`). | If no dark mode backend theme is set, the light mode theme will also be used in dark mode. The backend theme settings will be saved and restored on a restart of Home Assistant. ### Manual theme selection -When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately. +When themes are enabled in the {% term "`configuration.yaml`" %} file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately. This will overrule the theme settings set by the above service calls, and will only be applied to the current device.

diff --git a/source/_integrations/futurenow.markdown b/source/_integrations/futurenow.markdown index 2ccf6263bec..e2b50ac041b 100644 --- a/source/_integrations/futurenow.markdown +++ b/source/_integrations/futurenow.markdown @@ -73,7 +73,7 @@ devices: ### Extended Configuration Sample -The following example `configuration.yaml` has two different FutureNow units with multiple channels: +The following example {% term "`configuration.yaml`" %} has two different FutureNow units with multiple channels: ```yaml # Example configuration.yaml entry