phoebus_os/installer/live/install-help.txt
Phoebus 7e9fa9c2a3
Some checks are pending
ci / test (push) Waiting to run
feat(installer): graphical welcome and install wizard over a typed bridge
Add a branded live welcome window and a Quickshell/QML installer frontend
over a narrow, fail-closed JSON bridge (phoebus-installer --gui-bridge)
that reuses the same InstallConfig, plan, validation, authorization and
staged executor as the TUI/CLI. Add the Phoebus brand system (emblem,
wordmark, wallpaper, tokens), suppress DMS first-run dialogs on the live
medium, identify the live medium as protected, make the installer
shortcut live-only, and fix the installed boot default so systemd-boot
never selects the recovery entry.

Verified in a disposable graphical VM (welcome/installer journey,
duplicate prevention, keyboard navigation, blocked AI prerequisite) plus
a real non-interactive install and detached boot (INSTALL-RC=0,
NO_SECRET_LEAK, systemd running, 0 failed units, LUKS2, Btrfs, network).
2026-09-21 13:13:40 -07:00

45 lines
1.9 KiB
Bash

Phoebus OS installation help
============================
What the installer does
-----------------------
The installer creates a GPT disk layout with an EFI system partition, a LUKS2
encrypted container and a Btrfs filesystem with the @ / @home / @var
/@snapshots / @swap subvolumes. It then installs a verified Gentoo stage3 and
the packages needed for a Mango + DankMaterialShell desktop with PipeWire,
Flatpak and Nix.
Nothing is written to a disk until you have reviewed the plan and typed ERASE
on the confirmation screen.
Requirements
------------
- 64-bit UEFI machine.
- At least 4 GiB of RAM and enough disk space (32 GiB or more recommended).
- A network connection during installation (the stage3 and packages are
downloaded; the installed system can boot and run offline).
- A connected AI model. Phoebus ships no model. Connect a hosted provider
(DeepSeek or OpenAI) or point the installer at a model you serve locally.
The installed system works without the model; you can always use the
deterministic `sys` command instead.
Choosing a disk
---------------
Only whole, writable disks are offered. Disks that hold mounted filesystems,
the live installation medium, optical/loop device-mapper devices and read-only
devices are protected and cannot be selected.
Destructive changes
-------------------
Everything on the selected disk is destroyed. If the installation fails, the
screen tells you whether disk changes occurred and what the safe next actions
are. A failed installation can be restarted from the review screen; the disk is
re-created from scratch.
Getting help
------------
- The full installer log is at /var/log/phoebus-installer/install.log.
- The serial console (Ctrl+Alt+F2) logs in as phoebus / phoebus on the live
medium; sudo is passwordless there.
- Open "Advanced tools" on the welcome screen for a terminal, system log,
installer log and disk information.