Skip to content

Commit ba3cd7b

Browse files
committed
update os requirements
1 parent c37eee4 commit ba3cd7b

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

os_requirements.txt

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,28 @@ If you want to submit and/or maintain distribution of your choice for official S
55
* Set user to autologin (we try to achieve this in firstrun script but if you see difference not applying for your OS, be sure to do it).
66
* Disable power saving (screensavers, sleep, automatic logout etc).
77
* Disable logout option.
8-
* Shells images are running on our Shells kernel, if you want your images to be ran by your distro kernel, you will need to supply that kernel, a way to resize the disk, a bootloader, the kernel parameters etc.
8+
9+
## Naming
10+
11+
All images are typically named as `distribution-version-variation`. For
12+
example Ubuntu Focal with Ubuntu Desktop installed would be called
13+
`ubuntu-focal-ubuntu-desktop`. All images providing a desktop environment must
14+
end in `-desktop`.
15+
16+
## Custom kernel
17+
18+
By default Shells boots all images with the Shells kernel, which is a LTS
19+
vanilla kernel built by the Shells team. This kernel comes with an initrd that
20+
will perform a number of operations prior to booting the OS, such as ensuring
21+
the modules are installed for the running kernel, resizing the disk partition
22+
to use the whole disk, setup a swap partition, etc.
23+
24+
You can however supply your own kernel but will need to ensure the following:
25+
26+
* The image must be a 8GB or less BIOS-bootable bootable partition
27+
* On boot, you should check if the disk is larger than the partition(s) cover,
28+
and resize the disk appropriately. If you have a swap partition you may
29+
consider moving it toward the end of the disk.
30+
* Make sure you have the virtio modules enabled in your kernel, as well as
31+
anything required to run qxl if doing an desktop image.
32+

0 commit comments

Comments
 (0)