Repository navigation
Manual: say first boot encrypts unless the installer recorded a decline - #112
Merged
Merged
Conversation
…ecline The security and boot pages said the conversion needs a marker the installer writes, so a Mac not asked to encrypt is never touched, and the install and install-flow summaries said it converts only if asked. The encrypt hook treats a missing install.conf as encrypt=1, and only encrypt=0, recorded as phase=declined on Boot, keeps a fresh image plaintext. What keeps an installed Mac untouched is the image's own first-boot marker and deferred-steps file, not anything the installer writes. The decline also survives a factory reset (reopen_encrypt_state). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
scottjones
approved these changes
Nov 9, 2026
scottjones
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for this, it reads clearly. We checked every statement against omarchy-mac-encrypt and they all hold: a missing install.conf means encrypt, encrypt=0 is recorded as phase=declined and skips encryption, and factory reset keeps the decline. The installer's InstallConf.swift writes encrypt=0, so the two sides agree.
Contributor
Author
|
Note 🤖 Opus 5.5 replying on behalf of Victor. @scottjones, thank you for checking every statement against |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The Encryption and passwords page says: "A Mac that was not asked to encrypt is never touched. The conversion needs a marker the installer writes and refuses to run without it." The Boot chain page says the same: "The unit requires a pending marker written by the installer and refuses to run without it, so a Mac installed without encryption is never touched." The install pages agree: first boot converts the root to LUKS "if you asked for it" (Install on a Mac) or "if the installer asked for it" (How an install works).
The code does the opposite. When
/boot/efi/omarchy/install.confis missing, the encrypt hook takes it asencrypt=1(omarchy_mac_encrypt_read_confinfiles/usr/lib/omarchy/initcpio/omarchy-mac-encrypt), and first boot recordsformat=1andencrypt=1(consume_install_confinomarchy-mac-first-boot;mac-first-boot-test.shrequires it). Onlyencrypt=0keeps a fresh image plaintext. The marker the hook does require is the image's own:pendinganddeferred-stepsin/var/lib/omarchy/mac-first-boot. The installer doesn't write it.So an owner who said no to encryption, but whose installer failed to save that choice, gets an encrypted disk, while the manual says that can't happen.
Change
Docs only. One passage on each of four pages now describes what the code does:
04-security.md: the first boot encrypts unless the installer recorded a no, and encrypts if the record is missing. A no holds through a factory reset. Only a freshly written image converts, so an installed Mac is never touched.10-boot.md: the unit converts only a fresh image (pendingplusdeferred-steps). It converts unlessinstall.confsetsencrypt=0, and a missing file means encrypt. The decline is recorded asphase=declinedin/boot/omarchy/encrypt.state, so it outlives that file and a factory reset (reopen_encrypt_stateinlib/factory-reset.shleaves it).02-install.mdand09-install-flow.md: first boot converts the root unless the installer recorded a no (encrypt=0).Scope and approval
There are no code changes, because the code and its tests already agree on the default. Only the manual was wrong. The initramfs hook's
help()text already says "absent or encrypt=1", so it stays. There's noomarchy-macversion bump because no package behaviour changes. Nothing boot-critical changes, so no cold-boot evidence applies. No other passage on these pages changes.Verification
python3 mac-manual/diagrams/gen.py, thengit status --porcelain -- mac-manual/diagrams: exit 0 with no diff, on base and candidate.python3 mac-manual/build.pywithmarkdown==3.7: "built 14 pages into mac-manual/dist", exit 0, on base and candidate. The builder checks every link..github/scripts/check-scopeand.github/scripts/check-architecture-gates: exit 0.dist/trees changes onlysecurity/,boot/,install/andinstall-flow/.omarchy_mac_encrypt_read_conf,omarchy_mac_encrypt_fresh_image, thedeclinedbranch andomarchy_mac_encrypt_write_statein the hook,consume_install_confinomarchy-mac-first-boot, andreopen_encrypt_stateinlib/factory-reset.sh.The Encryption and passwords page built from
main, before this change:The same page built from this branch:
The Boot chain page's Encryption section built from
main:The same section built from this branch:
The Install on a Mac page's last install step, from
mainand then from this branch:The How an install works page's First boot list, from
mainand then from this branch:Not checked
install.confmissing, on a real Mac. These claims rest on the code paths and tests named above.Prior PRs
None make this change. #13 and #69 add text next to these passages but don't change them.
Generated with Claude Opus 5.5 and GPT-6.1 Sol in T3 Code Nightly