feat: nixify

Author: Liassica

.gitignore

@@ -0,0 +1,2 @@
+result
+result-*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Liassica
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,54 +1,33 @@
-GRUB2 Live ISO Multiboot
-========================
+# glim-flake
 
-https://github.com/thias/glim | http://glee.thias.es/GLIM
+A flake for [glim](https://github.com/thias/glim) with a couple of customizations.
 
+## Overview
 
-Overview
---------
+I've Nixified the upstream glim script, so it should work out of the box on systems with Nix. I've also added a few customizations like enabling Secure Boot support and switching the default theme out for [Catppuccin Frappe](https://github.com/catppuccin/grub).
 
-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.
+## Installation
 
-Advantages over extracting files or using special Live USB creation tools :
+Follow the upstream instructions for setting up your USB device.
 
- * 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)
+Then, install glim to your USB by running `nix run github:Liassica/glim-flake`. You can override the theme by adding this repo as a flake input and overriding the 'theme' input.
 
-Disadvantages :
+E.g, to use the Breeze GRUB theme:
 
- * 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.
-
-
-Screenshots
------------
-
-![Main Menu](https://github.com/thias/glim/raw/master/screenshots/GLIM-3.0-shot1.png)
-![Ubuntu Submenu](https://github.com/thias/glim/raw/master/screenshots/GLIM-3.0-shot2.png)
-
-
-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) :
-
-    ./glim.sh
+```nix
+{ pkgs, glim, ...}:
+{
+  environment.systemPackages = [
+    glim.packages.x86_64-linux.glim.override {
+      theme = "${pkgs.kdePackages.breeze-grub}/grub/themes/breeze";
+    };
+  ];
+}
+```
 
-Once finished, you may change the filesystem label to anything you like.
+## Supported distros
 
-The supported `boot/iso/` sub-directories (in alphabetical order) are :
+<!-- prettier-ignore-start -->
 
 [//]: # (distro-list-start)
 
@@ -77,6 +56,7 @@ The supported `boot/iso/` sub-directories (in alphabetical order) are :
 * [`memtest`](https://memtest.org/) - _Only .bin/.efi, not .iso_
 * [`mxlinux`](https://mxlinux.org/)
 * [`netrunner`](https://www.netrunner.com/)
+* [`nixos`](https://nixos.org/)
 * [`openbsd`](https://www.openbsd.org/)
 * [`opensuse`](https://www.opensuse.org/) - _Live from Alternative Downloads only_
 * [`peppermint`](https://peppermintos.com/)
@@ -96,135 +76,8 @@ 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.
-
-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
-------------
-
-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.
-
-Here is a generic idea how to keep it nicely ordered when you have multiple
-releases of some distro:
-
-- touch your **release** iso files with the release date
-- touch your **point release** iso files with the original release date plus a
-  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:
-
-|                                    | iso mtime               |
-|------------------------------------|-------------------------|
-| Debian Live 12.0.0 amd64 standard  | 10 June 2023            |
-| 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 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  |
-
-Special Cases
--------------
-
-### iPXE
-
-The `.iso` files don't work when booting using EFI, you simply need to use
-`.efi` files instead.
-
-### LibreELEC
-
-LibreELEC isn't provided as ISO images, nor is it able to find the `KERNEL` and
-`SYSTEM` files it needs anywhere else than at the root of a filesystem.
-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.
-
-### Memtest86+
-
-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:
-
-```
-mkdir slim
-iso=ubuntu-22.04.2-desktop-amd64.iso
-
-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
-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.
-
-
-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
-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
-virtual machine that uses it.
-For UEFI testing, you'll 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
-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...
-
-
-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 :
- * All changes properly and fully tested.
- * New entries added similarly to the existing ones :
-   * In alphabetical 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
-   `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/
+<!-- prettier-ignore-end -->
 
-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
-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/
+## License
 
+MIT, with the exception of some theme files. See the upstream repository's license for details.

flake.lock

@@ -0,0 +1,18 @@
+{
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+
+  outputs =
+    { self, nixpkgs }:
+    let
+      system = "x86_64-linux";
+      pkgs = nixpkgs.legacyPackages.${system};
+    in
+    {
+      packages.${system} = {
+        glim = pkgs.callPackage ./nix/package {
+          theme = (pkgs.catppuccin-grub.override { flavor = "frappe"; }).outPath;
+        };
+        default = self.packages.${system}.glim;
+      };
+    };
+}

flake.nix

@@ -20,7 +20,7 @@ terminal_output gfxterm
 loadfont unicode
 
 insmod png
-set theme=${prefix}/themes/invader/theme.txt
+set theme=${prefix}/themes/theme/theme.txt
 
 set isopath=/boot/iso
 probe --set rootuuid --fs-uuid $root
@@ -289,6 +289,12 @@ if any_exists ${isopath}/netrunner/netrunner-*.iso; then
   }
 fi
 
+if any_exists ${isopath}/nixos/nixos-*-linux.iso; then
+  menuentry "NixOS >" --class NixOS {
+    configfile "${prefix}/inc-nixos.cfg"
+  }
+fi
+
 if any_exists ${isopath}/openbsd/*.iso; then
   menuentry "OpenBSD >" --class openbsd {
     configfile "${prefix}/inc-openbsd.cfg"