Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README reworked #119

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

README reworked #119

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
77d71d5
README reworked
comradekingu Oct 12, 2023
b65e5fb
The changes are having a small day
comradekingu Oct 17, 2023
4c64127
Newlines
comradekingu Oct 17, 2023
cfc3453
Boot-menu entries are not shown
comradekingu Oct 20, 2023
6bfd4fa
All simplified. LibreELEC removed.
comradekingu Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 66 additions & 69 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
GRUB2 Live ISO Multiboot
========================

https://github.com/thias/glim | http://glee.thias.es/GLIM
https://github.com/thias/glim | https://glee.thias.es/GLIM


Overview
--------

GLIM is a set of grub configuration files to turn a simple VFAT formatted USB
memory stick with many GNU/Linux distribution ISO images into a neat device
from which many different Live environments can be used.
from which many different live environments can be used.

Advantages over extracting files or using special Live USB creation tools :
Advantages over extracting files or using special live USB creation tools:

* A single USB memory can hold all Live environments (the limit is its size)
* ISO images stay available to burn real CDs or DVDs
* ISO images are quick to manipulate (vs. hundreds+ files)

Disadvantages :
Disadvantages:

* There is no persistence overlay for distributions which normally support it
* Setting up isn't as easy as a simple cat from the ISO image to a block device

My experience has been that the safest filesystem to use is FAT32
(surprisingly!), though it will mean that ISO images greater than 4GB won't be
supported. Other filesystems supported by GRUB2 also work, such as ext3/ext4,
NTFS and exFAT, but the boot of the distributions must also support it, which
isn't the case for many with NTFS (Ubuntu does, Fedora doesn't) and exFAT
(Ubuntu doesn't, Fedora does). So FAT32 stays the safe bet.
The safest filesystem to use is FAT32 (surprisingly!), though it means no 4 GB+ ISOs.
Other filesystems supported by GRUB 2 also work, such as ext3/ext4,
NTFS and exFAT, but the boot of the distributions must also support it,
so no Fedora, but Ubuntu support on NTFS, and the opposite with exFAT.


Screenshots
Expand All @@ -40,15 +38,15 @@ Screenshots
Installation
------------

Once you have your USB memory with a single partition formatted as FAT32 with
the filesystem label 'GLIM', mount it, clone this git repository and just run
(as a normal user) :
Once your USB memory has a single partition formatted as FAT32 with
the filesystem label 'GLIM', mount it, clone this Git repository and
just run (as a normal user):

./glim.sh

Once finished, you may change the filesystem label to anything you like.

The supported `boot/iso/` sub-directories (in alphabetical order) are :
The supported `boot/iso/` sub-directories (in A–Z order) are:

[//]: # (distro-list-start)

Expand Down Expand Up @@ -92,41 +90,41 @@ The supported `boot/iso/` sub-directories (in alphabetical order) are :

[//]: # (distro-list-end)

Any unpopulated directory will have the matching boot menu entry automatically
disabled, so to skip any distribution, just don't copy any files into it.
Unpopulated directories turns its matching boot menu entry off,
comradekingu marked this conversation as resolved.
Show resolved Hide resolved
comradekingu marked this conversation as resolved.
Show resolved Hide resolved
so skip any distribution by not copying any files into it.

Download the right ISO image(s) to the matching directory. If you require
boot parameter tweaks, edit the appropriate `boot/grub2/inc-*.cfg` file.
Download the right ISO image(s) to the matching directory.
If you require boot parameter tweaks, edit the appropriate
`boot/grub2/inc-*.cfg` file.

Items order in the menu
------------
Item order in the menu
----------------------

Menu items for a distro are ordered by modification time of the iso files
starting from the most recent ones. If some iso files have the same mtime, their
menu items are ordered alphabetically.
Distros as menu items are ordered by the modification time of their ISO files,
starting with the most recent. If some ISO files have the same mtime,
their menu items are ordered A–Z.

Here is a generic idea how to keep it nicely ordered when you have multiple
Here is a generic idea of how to keep it nicely ordered with multiple
releases of some distro:

- touch your **release** iso files with the release date
comradekingu marked this conversation as resolved.
Show resolved Hide resolved
- touch your **point release** iso files with the original release date plus a
- Touch your **release** ISO files with the release date
comradekingu marked this conversation as resolved.
Show resolved Hide resolved
- Touch your **point release** ISO files with the original release date, plus a
comradekingu marked this conversation as resolved.
Show resolved Hide resolved
day per point. This is a way to ensure point releases never pop above the next
release like Debian 10.13.0 (released 10 Sep 2022) would still be below Debian
11.0.0 (released 14 August 2021)
- in case there are multiple flavours of some iso but the version is the same,
touch all of them with the same date for the whole group to be ordered
alphabetically

Sample ordered menu:
11.0.0 (released 14 Aug 2021)
- In case there are multiple flavours of some ISO, but the version is the same
—touch all of them with the same date to order the whole group A–Z
comradekingu marked this conversation as resolved.
Show resolved Hide resolved
comradekingu marked this conversation as resolved.
Show resolved Hide resolved

Sample-ordered menu:

| | iso mtime |
| | ISO mtime |
|------------------------------------|-------------------------|
| Debian Live 12.0.0 amd64 standard | 10 June 2023 |
comradekingu marked this conversation as resolved.
Show resolved Hide resolved
| Debian Live 11.7.0 amd64 gnome | 14 August 2021 + 7 days |
| Debian Live 11.7.0 amd64 kde | 14 August 2021 + 7 days |
| Debian Live 11.7.0 amd64 GNOME | 14 August 2021 + 7 days |
| Debian Live 11.7.0 amd64 KDE | 14 August 2021 + 7 days |
| Debian Live 11.7.0 amd64 standard | 14 August 2021 + 7 days |
| Debian Live 11.0.0 amd64 gnome | 14 August 2021 |
| Debian Live 11.0.0 amd64 kde | 14 August 2021 |
| Debian Live 11.0.0 amd64 GNOME | 14 August 2021 |
| Debian Live 11.0.0 amd64 KDE | 14 August 2021 |
| Debian Live 11.0.0 amd64 standard | 14 August 2021 |
| Debian Live 10.13.0 amd64 standard | 6 July 2019 + 13 days |
| Debian Live 9.13.0 amd64 standard | 17 June 2017 + 13 days |
Expand All @@ -141,25 +139,25 @@ The `.iso` files don't work when booting using EFI, you simply need to use

### LibreELEC

LibreELEC isn't provided as ISO images, nor is it able to find the `KERNEL` and
LibreELEC provide no ISO images, nor is able to find the `KERNEL` and
`SYSTEM` files it needs anywhere else than at the root of a filesystem.
Copy link
Author

@comradekingu comradekingu Oct 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit ambiguous.
It can't look outside its own system partition, vs. those files need to be someplace else.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, it seems broken anyway currently. I was thinking of removing LibreELEC entirely for now...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the text and marked the entry as broken.

comradekingu marked this conversation as resolved.
Show resolved Hide resolved
But it's useful to enable booting the installer by just copying both
files to the root of the USB memory stick.
Live booting is also supported, and the first launch will create a 512MB file
as /STORAGE.
Live booting is also supported, and the first launch will create a 512 MB
file as /STORAGE.

### Memtest86+

The `.iso` file doesn't work. Use either the `.bin` or the `.efi` depending on
the boot mode used.
The `.iso` file doesn't work.
Use either the `.bin` or the `.efi` depending on the boot mode used.

### Ubuntu

Recent Ubuntu desktop iso images bundle multiple versions on the Nvidia
driver. With that, the images are over 4GB, the FAT32 max file size. For example
`ubuntu-20.04.6-desktop-amd64.iso` is 4.1GB, `ubuntu-22.04.2-desktop-amd64.iso`
is 4.6GB. The driver is not required in a live system, it can be removed to make
an image fit into 4GB. For example, with 22.04.2 image in the current dir:
Recent Ubuntu desktop ISO images bundle multiple versions on the Nvidia
driver. With that, the images are 4 GB+, the max FAT32 file size. For example
`ubuntu-20.04.6-desktop-amd64.iso` is 4.1 GB, `ubuntu-22.04.2-desktop-amd64.iso` is 4.6 GB.
The driver is not required in a live system. Removing it can make an image fit into 4 GB.
For example, with 22.04.2 image in the current dir:

```
mkdir slim
Expand All @@ -169,58 +167,57 @@ xorriso -indev "$iso" -outdev slim/"$iso" \
-boot_image any replay -rm_r /pool/restricted/{l,n} --
```

Now you can copy `slim/ubuntu-22.04.2-desktop-amd64.iso` to your FAT32 formatted
Now you can copy `slim/ubuntu-22.04.2-desktop-amd64.iso` to your FAT32-formatted
GLIM USB stick.

Some Ubuntu flavours also bundle the Nvidia driver (like Kubuntu), some don't
(like Xubuntu). The same trick can be used with the former.
Some Ubuntus bundle the Nvidia driver (like Kubuntu), some don't (like Xubuntu).
The same trick can be used with the former.


Testing
-------

With KVM it should "just work". The `/dev/sdx` device should be configured as
an IDE or SATA disk (for some reason, as USB disk didn't work for me on Fedora
an IDE or SATA disk (for some reason, as USB disk doesn't work on Fedora
17), that way you can easily and quickly test changes.
Make sure you unmount the disk from the host OS before you start the KVM
Ensure you unmount the disk from the host OS before starting the KVM
virtual machine that uses it.
For UEFI testing, you'll need to use one of the `/usr/share/edk2/ovmf/*.fd`
For UEFI testing, you need to use one of the `/usr/share/edk2/ovmf/*.fd`
firmwares.


Troubleshooting
---------------

If you have any problem to boot, for instance stuck at the GRUB prompt before
If you have any problem booting, for instance being stuck at the GRUB prompt before
the menu, try re-installing.
If you have other exotic GRUB errors, such as garbage text read instead of the
configuration directives, try re-formatting your USB memory from scratch.
I've seen weird things happen...

configuration directives, try re-formatting your USB memory from scratch
and/or persist in your belief that you are of sound mind should strangeness
increase or continue.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ChatGPT, is that you? 🤣

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is HeideggerGPT :)


Contributing
------------

If you find GLIM useful but the configuration of the OS you require is missing
or simply outdated, please feel free to contribute! What you will need is to
create a GitHub pull request which includes :
If you find GLIM useful, but the configuration of the OS you picked is missing
or simply outdated, please contribute!
Create a GitHub pull request including:
* All changes properly and fully tested.
* New entries added similarly to the existing ones :
* In alphabetical order.
* New entries added similarly to the existing ones:
* In A–Z order.
* With all possible variants supported (i.e. not just the one spin you want).
* An original icon of high quality, and a shrunk 24x24 png version. Using
* An original icon of high quality, and a shrunk 24x24 PNG version. Using
`convert -size 24x24 -background 'rgba(0,0,0,0)' original.svg small.png`
may work.
* An updated supported directories list in this README file.


---
Copyleft 2012-2023 Matthias Saou http://matthias.saou.eu/
Copyleft 🄯 2012–2023 Matthias Saou https://matthias.saou.eu/

All configuration files included are public domain. Do what you want with them.
The invader logo was made by me, so unless the exact shape is covered by
All configuration files included are public domain.
The invader logo was made by me, so unless covered by
copyright somewhere, do what you want with it.
The background is "Wallpaper grey" © 2008 payalnic (DeviantArt)
The `ascii.pf2` font comes from GRUB, which is GPLv3+ licensed. For more
details as well as the source code, see http://www.gnu.org/software/grub/

The `ascii.pf2` font comes from GRUB, which is GPLv3+ licensed.
More details and source code on https://www.gnu.org/software/grub/