Skip to content

Commit a38dca8

Browse files
authored
Merge pull request lxc#491 from gibmat/add-incus-docs
Add incus install docs
2 parents f14163f + d68a62a commit a38dca8

12 files changed

+140
-1
lines changed

doc/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
:maxdepth: 1
55
66
Installing on hardware </getting-started/installation/physical>
7-
Installing on Proxmox </getting-started/installation/virtual-proxmox>
87
Installing on Incus </getting-started/installation/virtual-incus>
8+
Installing on Proxmox </getting-started/installation/virtual-proxmox>
99
Installing on VirtualBox </getting-started/installation/virtual-virtualbox>
1010
Installing on VMware </getting-started/installation/virtual-vmware>
1111
```
Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,140 @@
11
# Installing in an Incus virtual machine
2+
3+
IncusOS can be easily installed in an Incus virtual machine.
4+
5+
## Get and import install media
6+
7+
Follow the instructions to [get an IncusOS image](../download.md). This document will assume an ISO image is used.
8+
9+
Once downloaded, import the ISO image to Incus' storage.
10+
11+
````{tabs}
12+
13+
```{group-tab} Command line
14+
15+
incus storage volume import default Downloads/IncusOS_202511050158.iso IncusOS_202511050158.iso --type=iso
16+
17+
```
18+
19+
```{group-tab} Web interface
20+
21+
![Incus ISO image import](../../images/incus-webui-import-iso.png)
22+
23+
```
24+
25+
````
26+
27+
## Create a new virtual machine
28+
29+
````{tabs}
30+
31+
```{group-tab} Command line
32+
33+
Create a new virtual machine and attach the ISO image.
34+
35+
incus init --empty --vm IncusOS \
36+
-c security.secureboot=false \
37+
-c limits.cpu=1 \
38+
-c limits.memory=4GiB \
39+
-d root,size=50GiB
40+
incus config device add IncusOS vtpm tpm
41+
incus config device add IncusOS boot-media disk pool=default source=IncusOS_202511050158.iso boot.priority=10
42+
43+
```
44+
45+
```{group-tab} Web interface
46+
47+
Create a new virtual machine and attach the ISO image.
48+
49+
![Incus VM configuring ISO](../../images/incus-webui-vm-configure-iso.png)
50+
51+
Set `Enable secureboot (VMs only)` to false. This is unfortunately named a bit confusingly, but will configure the virtual machine to boot without any configured Secure Boot keys so that the IncusOS installer can automatically enroll the necessary Secure Boot keys.
52+
53+
![Incus VM configuring Secure Boot](../../images/incus-webui-vm-configure-secure-boot.png)
54+
55+
Add a TPM device.
56+
57+
![Incus VM configuring TPM](../../images/incus-webui-vm-configure-tpm.png)
58+
59+
```
60+
61+
````
62+
63+
### Secure Boot and TPM configuration
64+
65+
IncusOS depends on Secure Boot and a v2.0 TPM. When configuring the virtual machine, make the following selections:
66+
67+
* Set `security.secureboot=false` to disable loading of default Secure Boot keys
68+
69+
* Add a virtual TPM device
70+
71+
### CPU, memory, network, and local storage
72+
73+
Configure the CPU and memory for the virtual machine as desired and add at least one network interface.
74+
75+
Remember that the main system drive must be at least 50GiB or larger.
76+
77+
## IncusOS installation
78+
79+
````{tabs}
80+
81+
```{group-tab} Command line
82+
83+
Start the virtual machine, and IncusOS will begin its installation.
84+
85+
incus start IncusOS
86+
87+
Wait a few seconds for the Secure Boot key enrollment to occur, then attach to the virtual machine's console.
88+
89+
incus console IncusOS --type=vga
90+
91+
![Incus VM installing IncusOS](../../images/incus-cli-vm-install.png)
92+
93+
Upon completion of the install, stop the virtual machine and remove the CDROM device.
94+
95+
incus stop IncusOS
96+
incus config device remove IncusOS boot-media
97+
98+
![Incus VM installation complete](../../images/incus-cli-vm-install-complete.png)
99+
100+
```
101+
102+
```{group-tab} Web interface
103+
104+
Start the virtual machine, and IncusOS will begin its installation.
105+
106+
![Incus VM installing IncusOS](../../images/incus-webui-vm-install.png)
107+
108+
Upon completion of the install, click "Detach ISO" to remove the CDROM device and then stop the virtual machine.
109+
110+
![Incus VM installation complete](../../images/incus-webui-vm-install-complete.png)
111+
112+
```
113+
114+
````
115+
116+
## IncusOS is ready for use
117+
118+
````{tabs}
119+
120+
```{group-tab} Command line
121+
122+
Start the virtual machine, and IncusOS will perform its first boot configuration.
123+
124+
incus start IncusOS --console=vga
125+
126+
![Incus VM running IncusOS](../../images/incus-cli-vm-incusos-running.png)
127+
128+
```
129+
130+
```{group-tab} Web interface
131+
132+
Start the virtual machine, and IncusOS will perform its first boot configuration.
133+
134+
![Incus VM running IncusOS](../../images/incus-webui-vm-incusos-running.png)
135+
136+
```
137+
138+
````
139+
140+
Once complete, follow the instructions for [accessing the system](../access.md).
208 KB
Loading
104 KB
Loading
69.4 KB
Loading
58.6 KB
Loading
61.3 KB
Loading
169 KB
Loading
47.8 KB
Loading
128 KB
Loading

0 commit comments

Comments
 (0)