Skip to content

Commit 13a3c87

Browse files
agnersludeeusfrenck
authored
Improve Generic x86-64 installation instructions (home-assistant#18163)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
1 parent aafb699 commit 13a3c87

5 files changed

Lines changed: 42 additions & 21 deletions

File tree

_config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,3 +216,10 @@ installation:
216216
variants:
217217
- name: "ASUS Tinkerboard"
218218
key: "tinker"
219+
220+
generic-x86-64:
221+
board: Generic x86-64
222+
installation_media: "storage device"
223+
variants:
224+
- name: "Generic x86-64"
225+
key: "generic-x86-64"

source/_includes/installation/operating_system.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,33 @@ We will need a few things to get started with installing Home Assistant. Links b
4848

4949
{% endif %}
5050

51+
{% if page.installation_type == 'generic-x86-64' %}
52+
53+
<div class='note'>
54+
<b>Prerequisites</b>
55+
56+
This guide assumes that you have a dedicated generic x86 PC (typically an Intel or AMD-based system) available to exclusively run Home Assistant Operating System. The system must be 64-bit capable and able to boot using UEFI. Pretty much all systems produced in the last 10 years support the UEFI boot mode.
57+
</div>
58+
59+
### Configure the BIOS
60+
61+
To boot Home Assistant OS the BIOS needs to have UEFI boot mode enabled and Secure Boot disabled. The following screenshots are from a 7th generation Intel NUC system. The BIOS menu will likely look different on your systems. However, the options should still be present and named similarly.
62+
63+
1. Enter the BIOS using the can enter using the `F2` key (on some systems this might be `Del`, `F1` or `F10`).
64+
![Enter BIOS using F2, Del, F1 or F10 key](/images/installation/intel-nuc-enter-bios.jpg)
65+
66+
1. Make sure the UEFI Boot mode is enabled
67+
![Enable UEFI Boot mode](/images/installation/intel-nuc-uefi-boot.jpg)
68+
69+
1. Disable Secure Boot
70+
![Disable Secure Boot mode](/images/installation/intel-nuc-disable-secure-boot.jpg)
71+
72+
As a next step, we need to write the Operating System image to the installation media. Depending on your system this can be a S-ATA hard disk, S-ATA SSD, a M.2 SSD or even a eMMC. Home Assistant Operating System has no integrated installer. You need to use your Desktop computer (e.g. by using a USB to S-ATA adapter) or boot a live operating system on your target system to install Home Assistant Operating System.
73+
74+
If you prefer to use a live operating system, follow the instructions of your Live distribution (e.g., [this Ubuntu guide](https://ubuntu.com/tutorials/try-ubuntu-before-you-install)). Once you booted the live operating system, the following steps on how-to write the image to your installation media can be followed.
75+
76+
{% endif %}
77+
5178
### Write the image to your installation media
5279

5380
1. Attach the installation media ({{site.installation.types[page.installation_type].installation_media}}) to your computer
@@ -99,23 +126,21 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
99126

100127
### Start up your {{site.installation.types[page.installation_type].board}}
101128

129+
{% if page.installation_type == 'generic-x86-64' %}
130+
1. If you used your Desktop system to write to your installation media, install the installation media ({{site.installation.types[page.installation_type].installation_media}}) to the target system. Otherwise, shutdown the live operating system and make sure to remove the USB flash drive you have been using for the live system.
131+
2. Make sure an ethernet cable for network is plugged in
132+
3. Power the system on.
133+
{% else %}
102134
1. Insert the installation media ({{site.installation.types[page.installation_type].installation_media}}) you just created
103135
2. Attach a ethernet cable for network.
104136
3. Attach a cable for power
137+
{% endif %}
105138
4. Within a few minutes you will be able to reach Home Assistant on <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).
106139

107-
108140
{% else %}
109141

110-
{% if page.installation_type != 'generic-x86-64' %}
111-
Follow this guide if you already are running a hypervisor, if not look at the [Raspberry Pi](/installation/raspberrypi) or the [ODROID](/installation/odroid)
112-
{% endif %}
113-
114142
### Download the appropriate image
115143

116-
{% if page.installation_type == 'generic-x86-64' %}
117-
- [Generic x86-64 (e.g. Intel NUC)][generic-x86-64]
118-
{% else %}
119144
- [VirtualBox][vdi] (.vdi)
120145
{% if page.installation_type == 'macos' %}
121146
- [KVM][qcow2] (.qcow2)
@@ -130,21 +155,12 @@ Follow this guide if you already are running a hypervisor, if not look at the [R
130155
{% if page.installation_type == 'windows' %}
131156
- [Hyper-V][vhdx] (.vhdx)
132157
{% endif %}
133-
{% endif %}
134-
{% if page.installation_type == 'generic-x86-64' %}
135158

136-
1. Download the operating system from the link above.
137-
2. Attach the drive you are using in your NUC to your computer.
138-
3. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>
139-
4. Select "Flash from File" and choose the image you have just downloaded.
140-
5. Click "Select Target" and choose the drive you wish to flash too, then click "Flash".
141-
6. Start the NUC with the drive you installed the operating system to as the boot device.
142-
7. Once the initial setup has completed you will be able to reach Home Assistant on <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).
143-
{% else %}
159+
Follow this guide if you already are running a supported virtual machine hypervisor. If you are not familiar with virtual machines we recommend installation Home Assistant OS directly on a [Raspberry Pi](/installation/raspberrypi) or an [ODROID](/installation/odroid).
144160

145161
### Create the Virtual Machine
146162

147-
Load the appliance image into your virtual machine software. (Note: You are free to assign as much resources as you wish to the VM, please assign enough based on your add-on needs)
163+
Load the appliance image into your virtual machine hypervisor. (Note: You are free to assign as much resources as you wish to the VM, please assign enough based on your add-on needs)
148164

149165
Minimum recommended assignments:
150166

@@ -218,8 +234,6 @@ _All these can be extended if your usage calls for more resources._
218234

219235
{% endif %}
220236

221-
{% endif %}
222-
223237
With the Home Assistant Operating System installed and accessible you can continue with onboarding.
224238

225239
{% include getting-started/next_step.html step="Onboarding" link="/getting-started/onboarding/" %}
93.8 KB
Loading
30.9 KB
Loading
101 KB
Loading

0 commit comments

Comments
 (0)