From 9f9ce8b5aabe67f276f9b3c5837214c24d692b6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82?= Date: Sun, 16 Aug 2026 19:15:09 +0200 Subject: [PATCH] docs: document container and native build paths, update release notes and netinstall-add docs --- docs/building.md | 49 ++++++++++++++++++++++++++++++++++++++++++-- docs/development.md | 1 - docs/index.md | 27 ++++++++++++++++-------- docs/installer.md | 4 ++-- docs/launcher.md | 6 +++--- docs/overlay-live.md | 2 +- docs/packages.md | 4 +--- 7 files changed, 72 insertions(+), 21 deletions(-) diff --git a/docs/building.md b/docs/building.md index d6ec555..7befb6c 100644 --- a/docs/building.md +++ b/docs/building.md @@ -6,13 +6,53 @@ nav_order: 2 # Building the ISO -The ISO is built with `buildiso` (from Artix `artools` package) plus a customized profile. You need an **Artix-based** system to build. +The ISO is built with `buildiso` (from Artix `artools` package) plus a customized profile. There are two supported paths: **Option A (container)** for systems without pacman, and **Option B (native)** for pacman-based systems. -## Prerequisites +## Option A: Build in a container (non-pacman distros — recommended) + +No Artix/Arch needed. Works on Gentoo, Fedora, Debian — anything **without pacman** that has podman. This is the same path GitHub Actions CI uses. ```bash +# Build the image (installs artools + deps inside an Artix container) +podman build -t antergos-build . + +# Build the ISO (rootful podman required — artools chroots mount devtmpfs, +# which rootless containers cannot do) +sudo podman run --rm --privileged \ + -v /var/lib/artools-buildiso:/var/lib/artools/buildiso \ + -v "$(pwd)/iso-output:/workspace/iso-output" \ + -e WORKSPACE_DIR=/workspace \ + antergos-build +``` + +Or use the helper script: + +```bash +./build-iso-podman.sh +``` + +The finished `.iso` lands in `iso-output/`. + +## Option B: Native build (just pacman + artools) + +You do **not** need an Artix-based system — `buildiso` is plain bash on top of `pacman`. You need: + +- `pacman` (native on Arch/Artix/**KaOS**; on other distros, install it or extract the `.pkg.tar.zst` files) +- the artools libraries from the Artix repo: `artools-base` (provides `basestrap`, `artix-chroot`, `fstabgen`) and `artools-iso` (provides `buildiso`) plus their deps +- `squashfs-tools`, `grub`, `xorriso`/`libisoburn`, `dosfstools`, `mtools` + +## Prerequisites (native path) + +```bash +# On Arch/Artix: pacman -S artools squashfs-tools modprobe loop + +# On KaOS (pacman native, but artools not in KaOS repos — extract from Artix): +pacman -S squashfs-tools + +# On other distros: grab artools-base/artools-iso from the Artix repo and +# extract them over /, then install pacman and the deps listed above. ``` `squashfs-tools` is needed for `mksquashfs`. The `loop` module must be loaded for `mount -o loop` during image assembly. @@ -120,6 +160,11 @@ rm -rf /var/lib/artools/buildiso/pkg/antergos/cache/ Then rebuild. +## Which option do I use? + +> - **Arch / Artix / KaOS / any pacman-based distro** → Option B (native). +> - **Anything else** (Gentoo, Fedora, Debian, ...) → Option A (podman). + ## CI builds The CI pipeline (`.github/workflows/build.yml`) handles all of the above automatically. It runs in an Artix container, sets `WORKSPACE_DIR`, overrides pacman config, mounts a 12 GB tmpfs, and builds the ISO. It also runs the AI community moderator on issues/PRs (`.github/workflows/ai-moderator.yml`). diff --git a/docs/development.md b/docs/development.md index 2695284..50c5da8 100644 --- a/docs/development.md +++ b/docs/development.md @@ -16,7 +16,6 @@ antergos-iso/ │ │ ├── profile.yaml # Packages, services (rootfs + livefs), compression │ │ ├── root-overlay/ # Merged into rootfs → live session + offline install │ │ └── live-overlay/ # Merged into live environment only -│ ├── antergos-minimal/ # Minimal profile (unmaintained) │ └── common/ │ └── common.yaml # Shared base packages (kernel, firmware, filesystem) ├── pacman.conf.d/ diff --git a/docs/index.md b/docs/index.md index a334246..d4143fb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,29 +6,38 @@ nav_order: 1 # Antergos NeXT -A community revival of Antergos for the post-systemd era — **Artix Linux** base with **Dinit**, **KDE Plasma**, and the **Calamares** installer. +A technical successor to Antergos for the post-systemd era — **Artix Linux** base with **Dinit**, **KDE Plasma**, and the **Calamares** installer. Its own branding, its own identity — the lineage continues, the Antergos feeling doesn't get replaced. ## Download [**Download the latest ISO**](https://github.com/Antergos-NeXT/antergos-iso/releases) _Published to GitHub Releases. (The Internet Archive upload step in CI is currently disabled — see [CI](ci).)_ -### Latest release — v2026.07.11 +### Latest release — v2026.08.11 (Xeitoso) -What works in the latest release: +What's in the latest release (v2026.08.11 "Xeitoso"): -- KDE Plasma 6 on Wayland (with SDDM) -- Full audio support on installed systems -- Custom SDDM theme (not Breeze) +- KDE Plasma 6 on Wayland (with SDDM) — KDE installs correctly (DE/DM choosers no longer fight over the netinstall queue) +- Clock syncs after install (`ntp-dinit` installed, `ntpd` enabled) +- Full audio support on installed systems (patched pipewire launcher for dinit) +- Custom SDDM theme — `pixie-sddm-git` (Material Design 3, not Breeze) - Correct `/usr/lib/os-release` (shows "Antergos NeXT", not "Artix Linux") - Choose your desktop (Plasma/Xfce/Cinnamon/MATE/LXQt/i3/Sway/Hyprland/COSMIC) +- Choose your init during install (dinit/runit/s6) - GRUB with Antergos theme -- Custom Calamares slideshow +- Custom Calamares slideshow + DM selector with screenshots +- LightDM with slick-greeter and proper config out of the box +- Filesystem tools in the default group (btrfs-progs, xfsprogs, f2fs-tools, snapper) - Xlibre X server included +- Offline bare-minimum installer (`antergos-offline-install`) -> Note: the current `master` branch moves the SDDM theme to `pixie` (`pixie-sddm-git`). The v2026.07.11 release used the older theme — see the [releases page](https://github.com/Antergos-NeXT/antergos-iso/releases) for per-release changes. +Only KDE Plasma was tested this release. The other DEs are in the installer but best-effort — see the [release notes](https://github.com/Antergos-NeXT/antergos-iso/releases/tag/v2026.08.11-release). The offline installer is also **experimental and best-effort** — the online Calamares flow is the supported path. -The offline bare-minimum installer is **experimental and best-effort** — the online Calamares flow is the supported path. +### Known issues in this release + +- **COSMIC breaks the display manager on an online install** — the online `displaymanager.conf` never listed `greetd`, so Calamares skips `DMgreetd` and never writes `/etc/greetd/config.toml`. Fixed on `master` (`00e1390`, hotfix, Aug 13) and will ship in the next release. +- **KDE Plasma is the only tested DE** — Xfce, Cinnamon, MATE, LXQt, i3, Sway, Hyprland and COSMIC are in the installer but unverified. Report results in an issue. +- **The offline installer is experimental and best-effort** — the online Calamares flow is the supported path. ## Quick links diff --git a/docs/installer.md b/docs/installer.md index 263f426..267073f 100644 --- a/docs/installer.md +++ b/docs/installer.md @@ -84,7 +84,7 @@ If you prefer to supply your own config, you can deselect the config package in ## Display manager selector -The DM selector (`packagechooser@dm`) uses `method: netinstall-select`. Available options: +The DM selector (`packagechooser@dm`) uses `method: netinstall-add`, with each display manager's packages defined inline in the chooser items. Available options: - **SDDM** — KDE's QML-based display manager (default). Ships with `pixie-sddm-git` theme. - **LightDM** — GTK-based, cross-desktop @@ -92,7 +92,7 @@ The DM selector (`packagechooser@dm`) uses `method: netinstall-select`. Availabl - **greetd** — Minimal, recommended for COSMIC - **LY** — TUI-based, minimal -The selected DM's group is marked as checked in the netinstall tree automatically. +The selected DM's inline group is appended to the netinstall tree via the `netinstallAdd` key, exactly like the DE selector. ## Branding diff --git a/docs/launcher.md b/docs/launcher.md index c37e18e..e839ccc 100644 --- a/docs/launcher.md +++ b/docs/launcher.md @@ -35,14 +35,14 @@ The installer runs two `packagechooser` instances in sequence, followed by the ` | Step | Instance | Module Config | Method | Purpose | |------|----------|---------------|--------|---------| | 4 | `packagechooser@de` | `packagechooser_de.conf` | `netinstall-add` | Desktop environment picker (required, default Plasma) | -| 5 | `packagechooser@dm` | `packagechooser_dm.conf` | `netinstall-select` | Display manager picker (required, default SDDM) | +| 5 | `packagechooser@dm` | `packagechooser_dm.conf` | `netinstall-add` | Display manager picker (required, default SDDM) | | 6 | `netinstall` | `netinstall.yaml` | — | Refine packages, add optional groups | ### How `netinstall-add` works When the user selects a DE, `packagechooser@de` writes a group definition to the `netinstallAdd` global storage key. When the `netinstall` module loads, it reads this key and appends the DE's package group to the tree. This allows users to see and refine the packages for their chosen DE — for example, deselecting specific applications. -The DM selector uses `netinstall-select`, which marks the chosen DM group (e.g. SDDM) as checked in the netinstall tree. Both keys are read by the netinstall module's `onActivate()` method at runtime. See `NetInstallPage.cpp` in the Calamares source for details. +The DM selector (`packagechooser@dm`) works the same way — `netinstall-add` with each DM's packages defined inline in the chooser items. Selecting a DM appends its group to the netinstall tree. Both keys are read by the netinstall module's `onActivate()` method at runtime. See `NetInstallPage.cpp` in the Calamares source for details. ### Available DE groups @@ -69,7 +69,7 @@ The `calamares-extensions` package ships an "Install Artix Linux" desktop entry Configs live in `live-overlay/etc/calamares/modules/` (overriding the copies installed by `calamares-branding-antergos-next`): - `packagechooser_de.conf` — desktop environment selector using `method: netinstall-add` -- `packagechooser_dm.conf` — display manager selector using `method: netinstall-select` +- `packagechooser_dm.conf` — display manager selector using `method: netinstall-add` with inline DM groups - `netinstall.yaml` / `netinstall.conf` — the netinstall package tree - `services-artix.conf` — service enablement via `artix-service` - `grubcfg.conf` — GRUB default configuration (`/etc/default/grub`) diff --git a/docs/overlay-live.md b/docs/overlay-live.md index 09ec7a8..3af5cac 100644 --- a/docs/overlay-live.md +++ b/docs/overlay-live.md @@ -63,7 +63,7 @@ live-overlay/ The online install sequence. Defines two `packagechooser` instances: - `packagechooser@de` — desktop environment selector using `method: netinstall-add`. Writes the selected DE's package group to the `netinstallAdd` global storage key. The DE group is dynamically appended to the netinstall tree when the netinstall module loads. -- `packagechooser@dm` — display manager selector using `method: netinstall-select`. Marks the chosen DM group as checked in the netinstall tree. +- `packagechooser@dm` — display manager selector using `method: netinstall-add` with inline DM groups. Appends the chosen DM group to the netinstall tree. The `modules-search: [ local ]` directive resolves module configs from the same directory as the settings file (`/etc/calamares/modules/`). diff --git a/docs/packages.md b/docs/packages.md index 94b3056..f261b95 100644 --- a/docs/packages.md +++ b/docs/packages.md @@ -29,14 +29,12 @@ Built and published in this order (from `packages.yaml` in `antergos-packages`): | `antergos-release` | `/usr/lib/os-release` with "Antergos NeXT" identification | | `pixie-sddm-git` | Material Design 3 SDDM theme (from AUR) | | `antergos-wallpapers` | Default wallpapers for KDE and other DEs | -| `antergos-plasma-theme` | Plasma theme / start-here icons | | `antergos-welcome` | "About Antergos NeXT" welcome app (KF6 + Qt6) | | `antergos-grub-theme` | GRUB boot theme | -| `antergos-live` | Live session meta package (per-init: `antergos-live-dinit`, `antergos-live-openrc`) | +| `antergos-live` | Live session meta package (per-init: `antergos-live-base`, `antergos-live-dinit`, `antergos-live-openrc`) | | `pipewire` (forked) | Patched `artix-pipewire-launcher` for dinit support + XDG autostart entry | | `calamares` | Built with `packagechooser` module enabled | | `calamares-branding-antergos-next` | Branding: slideshow, `branding.desc`, launcher script, packagechooser configs | -| `calamares-branding-antergos-next-minimal` | Minimal branding variant | | `antergos-xfce-theme` | Xfce theme | | `downgrade` | AUR package (downgrade helper) | | `yay` | AUR helper |