|
| 1 | +If you want to submit and/or maintain distribution of your choice for official Shells build, you must meet the following criteria: |
| 2 | + |
| 3 | +* Make sure image is ready for Shells infrastructure (look for example into other OS build scripts here in repository). |
| 4 | +* No password for users (we disable the passwords, enabled passwordless sudo and passwordless polkit auth in firstrun script, so keep that in mind). |
| 5 | +* 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). |
| 6 | +* Disable power saving (screensavers, sleep, automatic logout etc). |
| 7 | +* Disable logout option. |
| 8 | +* Be sure to have in your image spice-vdagent and qemu-guest-agent. |
| 9 | + |
| 10 | +## Naming |
| 11 | + |
| 12 | +All images are typically named as `distribution-version-variation`. For |
| 13 | +example Ubuntu Focal with Ubuntu Desktop installed would be called |
| 14 | +`ubuntu-focal-ubuntu-desktop`. All images providing a desktop environment must |
| 15 | +end in `-desktop`. |
| 16 | + |
| 17 | +## Custom kernel |
| 18 | + |
| 19 | +By default Shells boots all images with the Shells kernel, which is a LTS |
| 20 | +vanilla kernel built by the Shells team. This kernel comes with an initrd that |
| 21 | +will perform a number of operations prior to booting the OS, such as ensuring |
| 22 | +the modules are installed for the running kernel, resizing the disk partition |
| 23 | +to use the whole disk, setup a swap partition, etc. |
| 24 | + |
| 25 | +You can however supply your own kernel but will need to ensure the following: |
| 26 | + |
| 27 | +* The image must be a 8GB or less BIOS-bootable bootable partition |
| 28 | +* On boot, you should check if the disk is larger than the partition(s) cover, |
| 29 | + and resize the disk appropriately. If you have a swap partition you may |
| 30 | + consider moving it toward the end of the disk. |
| 31 | +* Make sure you have the virtio modules enabled in your kernel, as well as |
| 32 | + anything required to run qxl if doing an desktop image. |
| 33 | + |
0 commit comments