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-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Installation methods: add glossary references (#32287)

Browse Source 
* Installtion methods: add glossary references

* Update source/_docs/blueprint/selectors.markdown
This commit is contained in:
c0ffeeca7 2024-04-12 11:56:02 +02:00 committed by GitHub
parent 614efbeaf1
commit 3eda1db689
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_docs/blueprint/selectors.markdown
View File

@ -271,7 +271,7 @@ assist_pipeline:
## Backup location selector
This can only be used on an installation with a Supervisor (Operating System or
Supervised). For installations of type Home Assistant Core or Container, an error
Supervised). For installations of type {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %}, an error
will be displayed.
The backup location selector shows a list of places a backup could go, depending

6
source/_docs/configuration.markdown
View File

@ -20,11 +20,11 @@ The path to your configuration directory can be found in the Home Assistant {% t
Right under the version you are running, you will find what path Home Assistant has loaded the configuration from.
![Screenshot showing the top of the system information panel](/images/screenshots/System_information.png)
_If you use Home Assistant Container, you can find `configuration.yaml` in the config folder that you mounted in your container._
_If you use {% term "Home Assistant Container" %}, you can find `configuration.yaml` in the config folder that you mounted in your container._
_If you use Home Assistant Operating System, you can find `configuration.yaml` in the `/config` folder of the installation._
_If you use {% term "Home Assistant Operating System" %}, you can find `configuration.yaml` in the `/config` folder of the installation._
_If you use Home Assistant Core, you can find `configuration.yaml` in the config folder passed to the `hass` command (default is `~/.homeassistant`)._
_If you use {% term "Home Assistant Core" %} , you can find `configuration.yaml` in the config folder passed to the `hass` command (default is `~/.homeassistant`)._
## Reloading changes

2
source/_docs/configuration/secrets.markdown
View File

@ -42,7 +42,7 @@ When you start splitting your configuration into multiple files, you might end u
- A `secrets.yaml` located in the same folder as the YAML file referencing the secret,
- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main `configuration.yaml`.
To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. The latter is only available for Home Assistant Core installations given it's available through [`hass`](/docs/tools/hass/).
To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. The latter is only available for {% term "Home Assistant Core" %} installations given it's available through [`hass`](/docs/tools/hass/).
*Option 1*: Print where secrets are retrieved from to the Home Assistant log by adding the following to `secrets.yaml`:

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

@ -65,8 +65,8 @@ sensor:
### Environment variables
On Home Assistant Core installations, you can include values from your system's environment variables with `!env_var`.
Note that this will only work for Home Assistant Core installations, in a scenario where it is possible to specify these.
On {% term "Home Assistant Core" %} installations, you can include values from your system's environment variables with `!env_var`.
Note that this will only work for {% term "Home Assistant Core" %} installations, in a scenario where it is possible to specify these.
Regular Home Assistant users are recommended to use `!include` statements instead.
```yaml

2
source/_docs/locked_out.md
View File

@ -9,7 +9,7 @@ or need to recover your data.
## Forgot user name
If you’ve forgotten your username, ask the owner to help you.
If you are using the Home Assistant Operating System and have access to the Home Assistant server, you can connect a terminal and enter the `auth list` command. This command lists all users that are registered on your Home Assistant.
If you are using the {% term "Home Assistant Operating System" %} and have access to the Home Assistant server, you can connect a terminal and enter the `auth list` command. This command lists all users that are registered on your Home Assistant.
## Forgot password

2
source/_docs/troubleshooting_general.markdown
View File

@ -23,7 +23,7 @@ Recovery mode loads a minimum set of integrations to allow troubleshooting the c
You need to identify the issue in the configuration files and fix it there. The issue could be caused by something as simple as an invalid YAML file.
- If you are running Home Assistant Operating System, you can install an add-on such as VS code to edit the configuration file if needed.
- If you are running {% term "Home Assistant Operating System" %}, you can install an add-on such as VS code to edit the configuration file if needed.
- If you are still logged in, you can [edit your configuration](/docs/configuration/#editing-configurationyaml).
- In the Home Assistant user interface, open the add-on you usually use and edit the configuration file.
- Restart Home Assistant.

4
source/_docs/z-wave/controllers.markdown
View File

@ -89,8 +89,8 @@ On Raspberry Pi 3 and 4, you need to disable the on-board Bluetooth since the bo
For both processes below you will need to insert your SD card into your PC and open the configuration file with your favorite text editor.
- If you are using Home Assistant Operating System, once you mounted the disk, you will see the `config.txt` directly in the root directory.
- If you are using Home Assistant Supervised, the config file is stored in the boot folder: `/boot/config.txt`.
- If you are using {% term "Home Assistant Operating System" %}, once you mounted the disk, you will see the `config.txt` directly in the root directory.
- If you are using {% term "Home Assistant Supervised" %}, the config file is stored in the boot folder: `/boot/config.txt`.
#### Raspberry Pi 5 procedure

6
source/_includes/common-tasks/commandline.md
View File

@ -98,11 +98,11 @@ Use "ha [command] --help" for more information about a command.
### Console access
You can also access the Home Assistant Operating System via a directly connected keyboard and monitor, the console.
You can also access the {% term "Home Assistant Operating System" %} via a directly connected keyboard and monitor, the console.
#### Wiping the data disk wipe from the command line
In Home Assistant Operating System, the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed add-ons.
In {% term "Home Assistant Operating System" %}, the `ha os datadisk wipe` command wipes the data disk. The command deletes all user data as well as Home Assistant Core, Supervisor, and any installed add-ons.
The command `ha os datadisk wipe` marks the data partition (either internal on the eMMC or the SD card, or on an external attached data disk) as to be cleared on the next reboot. The command automatically reboots the system. Upon reboot, the data is cleared. Then the system continues to boot and reinstalls the latest version of all Home Assistant components.
@ -112,7 +112,7 @@ Note, if you have a Home Assistant Yellow, there is a red hardware button to wip
#### Listing all users from the command line
In Home Assistant Operating System, the `ha auth list` command lists all users that are registered on your Home Assistant.
In {% term "Home Assistant Operating System" %}, the `ha auth list` command lists all users that are registered on your Home Assistant.
The `ha auth list` command can only be run from the local terminal. Connect a display and keyboard and use the terminal.

4
source/_includes/common-tasks/data_disk.md
View File

@ -1,6 +1,6 @@
## Using external data disk
Home Assistant Operating System supports storing most data on an external storage medium, such as an USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster.
{% term "Home Assistant Operating System" %} supports storing most data on an external storage medium, such as an USB attached SSD or HDD. This data disk contains not only user data but also most of the Home Assistant software as well (Core, Supervisor, etc.). This means a fast data disk will make the system overall much faster.
![Graphics showing the architecture of the data disk feature](/images/haos/usb-data-disk.png)
@ -20,7 +20,7 @@ The data disk feature can be used on an existing installation without losing dat
<div class='note'>
If you have been using a data disk previously with Home Assistant Operating System, you need to use your host computer to delete all partitions *before* using it as a data disk again.
If you have been using a data disk previously with {% term "Home Assistant Operating System" %}, you need to use your host computer to delete all partitions *before* using it as a data disk again.
</div>

6
source/_includes/common-tasks/enable_i2c.md
View File

@ -1,6 +1,6 @@
## Enable I2C
Home Assistant using the Home Assistant Operating System which is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to
Home Assistant using the {% term "Home Assistant Operating System" %} which is a managed environment, which means you can't use existing methods to enable the I2C bus on a Raspberry Pi. In order to use I2C devices you will have to
- Enable I2C for the Home Assistant Operating System
- Setup I2C devices e.g. sensors
@ -10,7 +10,7 @@ Home Assistant using the Home Assistant Operating System which is a managed envi
You will need:
- SD card reader
- SD card with Home Assistant Operating System flashed on it
- SD card with {% term "Home Assistant Operating System" %} flashed on it
Shutdown/turn-off your Home Assistant installation and unplug the SD card.
Plug the SD card into an SD card reader and find a drive/file system named
@ -43,7 +43,7 @@ and make sure the first partition is available.
### Enable I2C via Home Assistant Operating System Terminal
Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the Home Assistant Operating System.
Alternatively, by attaching a keyboard and screen to your device, you can access the physical terminal to the {% term "Home Assistant Operating System" %}.
You can enable I2C via this terminal:

2
source/_includes/common-tasks/flashing_m1s_otg.md
View File

@ -2,7 +2,7 @@
Home Assistant can be flashed to an ODROID-M1S by connecting the device directly to your computer via the USB-OTG connection on the front of the board.
Unlike other ODROID boards, the M1S does not have a socket for an optional <abbr title="embedded MultiMediaCard">eMMC</abbr> module. It also does not have a separate flash chip that holds a dedicated bootloader.
Instead, the M1S has a build-in 64GB <abbr title="embedded MultiMediaCard">eMMC</abbr> soldered directly on the board that holds a bootloader by default. This guide will show you how to install the Home Assistant Operating System to the built-in <abbr title="embedded MultiMediaCard">eMMC</abbr>.
Instead, the M1S has a build-in 64GB <abbr title="embedded MultiMediaCard">eMMC</abbr> soldered directly on the board that holds a bootloader by default. This guide will show you how to install the {% term "Home Assistant Operating System" %} to the built-in <abbr title="embedded MultiMediaCard">eMMC</abbr>.
<ins>**Warning:</ins> Installing Home Assistant OS replaces the firmware and <abbr title="secondary program loader">SPL</abbr> on the <abbr title="embedded MultiMediaCard">eMMC</abbr> with the mainline version provided by the Home Assistant OS. As a result, it is not possible to use the SD card with the EMMC2UMS image anymore, because the mainline <abbr title="secondary program loader">SPL</abbr> is not compatible with U-Boot in the EMMC2UMS image at this time (February 2024). This does not pose any problem for standard use, just makes it more complicated in case you want to return to the Hardkernel-provided OS (see [HK Recovery](#hk-recovery)).**

2
source/_includes/common-tasks/network_storage.md
View File

@ -13,7 +13,7 @@ To list all your currently connected network storages, go to **{% my storage tit
<div class='note'>
You need to make sure you run a supported Home Assistant Supervised installation with the latest version of the [os-agent](https://github.com/home-assistant/os-agent). Make sure that your supervisor uses [slave bind propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for the data volume.
You need to make sure you run a supported {% term "Home Assistant Supervised" %} installation with the latest version of the [os-agent](https://github.com/home-assistant/os-agent). Make sure that your supervisor uses [slave bind propagation](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for the data volume.
</div>

2
source/_includes/installation/container.md
View File

@ -1,7 +1,7 @@
## Install Home Assistant Container
{% if page.installation_type != 'alternative' %}
These below instructions are for an installation of Home Assistant Container running in your own container environment, which you manage yourself. Any [OCI](https://opencontainers.org/) compatible runtime can be used, however this guide will focus on installing it with Docker.
These below instructions are for an installation of {% term "Home Assistant Container" %} running in your own container environment, which you manage yourself. Any [OCI](https://opencontainers.org/) compatible runtime can be used, however this guide will focus on installing it with Docker.
<div class='note'>
<b>Prerequisites</b>

4
source/_includes/installation/core.md
View File

@ -3,9 +3,9 @@
{% if page.installation_type == 'windows' %}
### Install WSL
To install Home Assistant Core on Windows, you will need to use the Windows Subsystem for Linux (WSL). Follow the [WSL installation instructions](https://docs.microsoft.com/windows/wsl/install-win10) and install Ubuntu from the Windows Store.
To install {% term "Home Assistant Core" %} on Windows, you will need to use the Windows Subsystem for Linux (WSL). Follow the [WSL installation instructions](https://docs.microsoft.com/windows/wsl/install-win10) and install Ubuntu from the Windows Store.
As an alternative, Home Assistant OS can be installed in a Linux guest VM. Running Home Assistant Core directly on Windows is not supported.
As an alternative, Home Assistant OS can be installed in a Linux guest VM. Running {% term "Home Assistant Core" %} directly on Windows is not supported.
{% endif %}
<div class='note warning'>

14
source/_includes/installation/operating_system.md
View File

@ -46,7 +46,7 @@ Variants without pre-installed Home Assistant:
<div class='note'>
<b>Prerequisites</b>
This guide assumes that you have a dedicated {{ site.installation.types[page.installation_type].board }} PC to exclusively run the Home Assistant Operating System.
This guide assumes that you have a dedicated {{ site.installation.types[page.installation_type].board }} PC to exclusively run the {% term "Home Assistant Operating System" %}.
- This is typically an Intel or AMD-based system.
- The system must be 64-bit capable and be able to boot using UEFI.
@ -55,7 +55,7 @@ This guide assumes that you have a dedicated {{ site.installation.types[page.ins
<b>Summary</b>
1. First, you will need to configure your {{ site.installation.types[page.installation_type].board }} PC to use UEFI boot mode.
2. Then, write the Home Assistant Operating System disk image to your boot medium.
2. Then, write the {% term "Home Assistant Operating System" %} disk image to your boot medium.
</div>
@ -88,7 +88,7 @@ Typically, an internal medium like S-ATA hard disk, S-ATA SSD, M.2 SSD, or a non
To write the HAOS image to the boot medium on your x86-64 hardware, there are 2 different methods:
**Method 1 (recommended)**: Boot Ubuntu from a USB flash drive and install the Home Assistant Operating System from there. It also works on laptops and PCs with internal hard disks.
**Method 1 (recommended)**: Boot Ubuntu from a USB flash drive and install the {% term "Home Assistant Operating System" %} from there. It also works on laptops and PCs with internal hard disks.
**Method 2**: With this method, you write the Home Assistant Operating disk image directly onto a boot medium from your regular computer. The steps are a bit more complex. If you have non-removable internal mediums (for example because you are using a laptop) or do not have the necessary adapter (for example an USB to S-ATA adapter) use method 1 instead.
@ -97,13 +97,13 @@ To write the HAOS image to the boot medium on your x86-64 hardware, there are 2
#### Required material
- Computer
- The target x86-64 hardware, on which you want to install the Home Assistant Operating System (HAOS)
- The target x86-64 hardware, on which you want to install the {% term "Home Assistant Operating System" %} (HAOS)
- USB flash drive (USB thumb drive is sufficient, it should be at least 4&nbsp;GB in size)
- Internet connection
#### To install HAOS via Ubuntu from a USB flash drive
1. **Notice**: This procedure will write the Home Assistant Operating System onto your device.
1. **Notice**: This procedure will write the {% term "Home Assistant Operating System" %} onto your device.
- This means you will lose all the data as well as the previously installed operating system.
- Back up your data before carrying out this procedure.
2. Create a *live operating system* on a USB flash drive:
@ -145,7 +145,7 @@ Use this method only if Method 1 does not work for you.
#### Required material
- Computer
- The target x86-64 hardware, on which you want to install the Home Assistant Operating System (HAOS)
- The target x86-64 hardware, on which you want to install the {% term "Home Assistant Operating System" %} (HAOS)
- Boot medium
- Internet connection
@ -157,7 +157,7 @@ Use this method only if Method 1 does not work for you.
{% endif %}
1. **Notice**: This procedure will write the Home Assistant Operating System onto your device.
1. **Notice**: This procedure will write the {% term "Home Assistant Operating System" %} onto your device.
- This means you will lose all the data as well as the previously installed operating system.
- Back up your data before continuing with the next step.
2. Attach the Home Assistant boot medium ({{site.installation.types[page.installation_type].installation_media}}) to your computer.

2
source/_includes/installation/supervised.md
View File

@ -14,6 +14,6 @@ Unless you really need this installation type, you should install Home Assistant
supported). So, make sure you understand the requirements from step 1 above.
3. Then head over to <a href="https://github.com/home-assistant/supervised-installer" target="_blank">home-assistant/supervised-installer</a> to set it up.
Once the Home Assistant Supervised installation is running and Home Assistant is accessible you can continue with onboarding.
Once the {% term "Home Assistant Supervised" %} installation is running and Home Assistant is accessible you can continue with onboarding.
{% include getting-started/next_step.html step="Onboarding" link="/getting-started/onboarding/" %}

6
source/_integrations/zwave_js.markdown
View File

@ -59,7 +59,7 @@ To run a Z-Wave network, you need the following elements:
### Setting up a Z-Wave JS server
If you are running Home Assistant Operating System or Home Assistant Supervised, the easiest way to get started is by using the built-in Z-Wave JS add-on in Home Assistant.
If you are running {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %}, the easiest way to get started is by using the built-in Z-Wave JS add-on in Home Assistant.
For other ways to setup a Z-Wave server, refer to the [advanced installation instructions](#advanced-installation-instructions).
@ -726,13 +726,13 @@ The chart below illustrates Options 1 and 2, which are available for Home Assist
**Option 1: The official Z-Wave JS add-on, as described above**
_This option is only available for Home Assistant OS (the recommended installation type) and Home Assistant Supervised installations._
_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) and {% term "Home Assistant Supervised" %} installations._
This add-on can only be configured via the built-in Z-Wave control panel in Home Assistant. If you followed the standard [installation procedure](#setting-up-a-z-wave-js-server), this is how you are running the Z-Wave JS server.
**Option 2: The Z-Wave JS UI add-on installed from the community add-on store**
_This option is only available for Home Assistant OS (the recommended installation type) and Home Assistant Supervised installations._
_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) and {% term "Home Assistant Supervised" %} installations._
This add-on includes the Z-Wave JS Server as part of the Z-Wave JS UI application. The Z-Wave network can be configured via the built-in Z-Wave control panel in Home Assistant and alternatively via the Z-Wave control panel built into Z-Wave JS UI. It provides you with a full-fledged, attractive, and feature-complete UI to manage your Z-Wave nodes and settings, which may support more advanced use cases as development continues on the Z-Wave control panel.