jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-08 18:06:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: add glossary term reference to config file (#32777)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-15 08:54:56 +02:00 committed by GitHub
parent fffd8c63ee
commit 8abaafb32d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_docs/authentication/providers.markdown
View File

@ -1,6 +1,9 @@
--- ---
title: "Authentication providers" title: "Authentication providers"
description: "Guide on configuring different authentication providers." description: "Guide on configuring different authentication providers."
related:
- docs: /docs/configuration/
title: configuration.yaml file
--- ---
<div class='note warning'> <div class='note warning'>
@ -13,13 +16,13 @@ When you log in, an _auth provider_ checks your credentials to make sure you are
<div class='note warning'> <div class='note warning'>
Home Assistant automatically configures the standard auth providers so you don't need to specify `auth_providers` in your `configuration.yaml` file unless you are configuring more than one. Specifying `auth_providers` will disable all auth providers that are not listed, so you could reduce your security or create difficulties logging in if it is not configured correctly. Home Assistant automatically configures the standard auth providers so you don't need to specify `auth_providers` in your {% term "`configuration.yaml`" %} file unless you are configuring more than one. Specifying `auth_providers` will disable all auth providers that are not listed, so you could reduce your security or create difficulties logging in if it is not configured correctly.
If you decide to use `trusted_networks` as your `auth_provider` there won't be a way to authenticate for a device outside of your listed trusted network. To overcome this ensure you add the default `auth_provider` with `type: homeassistant` back in manually. This will then present you with the default auth login screen when trusted network authentication fails as expected from outside your LAN. If you decide to use `trusted_networks` as your `auth_provider` there won't be a way to authenticate for a device outside of your listed trusted network. To overcome this ensure you add the default `auth_provider` with `type: homeassistant` back in manually. This will then present you with the default auth login screen when trusted network authentication fails as expected from outside your LAN.
</div> </div>
Authentication providers are configured in your `configuration.yaml` under the `homeassistant:` block. Authentication providers are configured in your {% term "`configuration.yaml`" %} file under the `homeassistant:` block.
If you are moving configuration to packages, this particular configuration must stay within 'configuration.yaml'. See Issue 16441 in the warning block at the bottom of this page. If you are moving configuration to packages, this particular configuration must stay within 'configuration.yaml'. See Issue 16441 in the warning block at the bottom of this page.

4
source/_docs/configuration/basic.markdown
View File

@ -23,8 +23,8 @@ To change the general settings that were defined during onboarding, follow these
2. To change network-related configuration, such as the network name, go to {% my network title="**Settings** > **System** > **Network**" %}. 2. To change network-related configuration, such as the network name, go to {% my network title="**Settings** > **System** > **Network**" %}.
3. If some of the settings are not visible, you may need to enable **Advanced mode**. 3. If some of the settings are not visible, you may need to enable **Advanced mode**.
- In the bottom left, select your user name to go to your {% my profile title="**User profile**" %}, and enable **Advanced mode**. - In the bottom left, select your user name to go to your {% my profile title="**User profile**" %}, and enable **Advanced mode**.
4. **Troubleshooting**: If any of the settings are grayed out and can't be edited, this is because they are defined in the [`configuration.yaml` file](/docs/configuration/). 4. **Troubleshooting**: If any of the settings are grayed out and can't be edited, this is because they are defined in the {% term "`configuration.yaml`" %} file.
- If you prefer editing the settings in the UI, you have to delete these entries from the [`configuration.yaml` file](/docs/configuration/). - If you prefer editing the settings in the UI, you have to delete these entries from the {% term "`configuration.yaml`" %} file.
- For more information about the general settings in YAML, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/). - For more information about the general settings in YAML, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).
![Setting fields are grayed out because the configuration settings stored in configuration.yaml file](/images/docs/configuration/general-settings-stored-in-config-yaml.png) ![Setting fields are grayed out because the configuration settings stored in configuration.yaml file](/images/docs/configuration/general-settings-stored-in-config-yaml.png)

4
source/_docs/configuration/customizing-devices.markdown
View File

@ -4,7 +4,7 @@ description: "Simple customization for entities."
related: related:
- docs: /integrations/homeassistant/ - docs: /integrations/homeassistant/
- docs: /docs/configuration/ - docs: /docs/configuration/
title: Home Assistant Core integration documentation title: configuration.yaml file
--- ---
## Changing entity name and entity ID ## Changing entity name and entity ID
@ -30,4 +30,4 @@ To change the entity ID and friendly name of supported entities, follow these st
![Edit entity ID in automation.](/images/docs/configuration/edit_entity-id_in_automation.png) ![Edit entity ID in automation.](/images/docs/configuration/edit_entity-id_in_automation.png)
If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your [`configuration.yaml` file](/docs/configuration/). For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/). If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your {% term "`configuration.yaml`" %} file. For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/).