quine-linux/README.md
Philip Peterson 79457c2a4b Build a live ISO too, and put it in releases
live/: quine-linux plus the live session and Anaconda WebUI, adapted from
Aurora's live ISO (get-aurora-dev/iso); Titanoboa's script packs it into
the ISO. The installer installs quine-linux:latest from inside the ISO, and
plasma-setup creates the first user at first boot, as on the disk image.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-31 01:48:11 -08:00

141 lines
6.7 KiB
Markdown

# quine-linux
Quine distro of Linux based on uBlue Aurora
## Building
The image is built in two repos:
- **[`quine-global-labs/aurora`](https://forge.quinefoundation.com/quine-global-labs/aurora)**,
our fork of [Aurora](https://github.com/ublue-os/aurora). Its workflow
builds it with Aurora's own `just build` and publishes it as
`forge.quinefoundation.com/quine-global-labs/aurora:stable`. Changes that
have to happen *inside* Aurora's build (its package set, build scripts,
the Kinoite base it starts from) go there, as commits on the fork.
- **This repo's `Containerfile`**, which builds the quine-linux bootc image
on top of that, layering in everything under `overlay/`, plus a
`kmod-builder` stage that compiles the CS8409 mic-fix kernel module (see
[Hardware-specific patches](#hardware-specific-patches) below). Anything a
`RUN` step on top of Aurora can do belongs here, not in the fork. Its
workflow publishes `forge.quinefoundation.com/quine-global-labs/quine-linux`
and the installer ISO (to MinIO).
Both images are private: `sudo podman login forge.quinefoundation.com`
(with a token that can read packages) before building locally.
[`Taskfile.yml`](Taskfile.yml) (requires [`task`](https://taskfile.dev)) is
the supported way to drive all of this — run `task` with no arguments to
list what's available. Notably:
- `task build-image` — builds the image on our published Aurora. To build
on stock upstream Aurora instead, pass
`BASE_IMAGE=ghcr.io/ublue-os/aurora:stable`; on a local build of the fork,
`BASE_IMAGE=localhost/aurora:stable`. Builds locally, as root, with podman, or
docker if podman isn't installed (force either with
`CONTAINER_RUNTIME=docker|podman`). Every task below works with either;
under docker, images are copied via skopeo into a
`quine-containers-storage` volume for `bootc-image-builder` to read.
- `task build-iso` — builds a bootable install ISO from that image via
`bootc-image-builder`, landing in `output/bootiso/install.iso`.
- `task build-installer-iso` — builds an install ISO using a custom
Anaconda installer environment (`installer/Containerfile`) instead of
stock Fedora's, landing in `output/bootiso/install.iso`. See
[`docs/patched-anaconda-installer.md`](docs/patched-anaconda-installer.md)
for forking/patching Anaconda itself.
- `task build-disk-image` — builds a ready-installed disk image (qcow2)
via `bootc-image-builder`, landing in `output/qcow2/disk.qcow2`. It has
no user: plasma-setup creates the first one at first boot.
- `task build-live-iso` — builds a live ISO (`live/`, after Aurora's):
boots into a Quine Linux session with Anaconda WebUI to install it,
landing in `output/live/Quine-Linux-Live.iso`. Podman only.
- `task test:stage` / `task test:boot` — stage the locally-built image as
this machine's next boot target (`bootc switch`), optionally rebooting
into it immediately. The fast way to test a change — especially the
kernel module — against the real running system, without building an ISO
or reinstalling anything.
- `task revert` — rolls back to the previously-booted deployment and
reboots, undoing a `test:boot` switch (or any other deployment change) if
something's wrong.
Equivalently, by hand:
```sh
sudo podman build -t quine-linux -f Containerfile .
```
To build the Aurora fork yourself (Linux, with buildah, cpp, just >= 1.46,
skopeo, jq, yq and cosign), in a clone of `quine-global-labs/aurora`:
```sh
sudo just build --image aurora --tag stable --flavor main # -> localhost/aurora:stable
```
An ISO can then be generated from the built image with `bootc-image-builder`
(`ghcr.io/osbuild/bootc-image-builder`; the project now lives in
[osbuild/image-builder](https://github.com/osbuild/image-builder), and the old
`quay.io/centos-bootc/bootc-image-builder` image is no longer updated).
## overlay/
Files here mirror their path on the root filesystem and are baked into the
image via `COPY overlay/ /` in the Containerfile.
- `overlay/etc/...` — local/admin config. On the ostree-based image, content
shipped here becomes the default `/etc` and is still locally overridable
(3-way merged on upgrade), same as any package-installed `/etc` file.
- `overlay/usr/lib/systemd/...` — vendor-shipped units. `/usr` is replaced
wholesale on each image build/upgrade, so anything here always matches the
image and isn't meant to be hand-edited on a running system.
### overlay/etc/gitconfig
System-wide git config so every user on the box gets `main` as the default
init branch, not `master`.
### overlay/etc/systemd/system/rpm-ostree-cleanup.{service,timer}
Weekly, runs as root via systemd (not cron/sudoers): `rpm-ostree cleanup -rb`
(drops rollback deployment and any pending deployment). Enabled at build time
via `RUN systemctl enable` in the Containerfile.
### overlay/etc/systemd/journald.conf.d/size-cap.conf
Continuous 500M journal retention cap instead of a periodic vacuum job.
### overlay/usr/lib/systemd/user/disk-cleanup.{service,timer}
Weekly, runs as the user, no privilege needed: `podman system prune -af`,
`flatpak uninstall --unused -y`, clears `~/.cache`. Auto-enabled for every
user via `overlay/usr/lib/systemd/user-preset/90-quine-linux.preset` — no
manual `systemctl --user enable` needed.
### overlay/etc/systemd/system/cs8409-intmike-power-fixup.service
Hardware-specific fixup for the iMac19,2 internal mic (see below).
## Hardware-specific patches
`docs/` and `patches/` hold write-ups and out-of-tree kernel module patches
for hardware quirks on the machines this image runs on, that don't fit
anywhere else in this repo:
- [`docs/imac19-2-mic-fix.md`](docs/imac19-2-mic-fix.md) — the internal mic
on iMac19,2 capturing near-silence despite maxed gain; root cause, fix,
and current verification status.
- `patches/snd-hda-codec-cs8409/` — the vendored driver source and patch
backing that fix, built into `Containerfile`'s `kmod-builder` stage.
- [`docs/imac19-2-speaker-fix.md`](docs/imac19-2-speaker-fix.md) — the
internal speakers on iMac19,2 producing no sound at all; investigation and
prior-art writeup, no fix packaged yet.
## Software fork directions
Write-ups of problems found on this image that point at a fork/patch of an
upstream project, kept here before anyone's had time to act on them:
- [`docs/patched-anaconda-installer.md`](docs/patched-anaconda-installer.md)
— active: how to get a forked/patched Anaconda into the install ISO.
- [`docs/chromium-dbus-singleton-activation.md`](docs/chromium-dbus-singleton-activation.md)
— not started: Chromium lacks D-Bus activation, so KDE + Flatpak can't
dedupe a slow-starting launch, and repeated launcher clicks stack up full
duplicate browser instances instead of forwarding to the existing one.