Skip to content

docs(install-deploy): show the sign-a-downloaded-ISO command and its outputs - #135

Merged
Bugs5382 merged 1 commit into
mainfrom
docs/83-sign-downloaded-unsigned-iso
Oct 16, 2026
Merged

Bugs5382 merged 1 commit into
mainfrom
docs/83-sign-downloaded-unsigned-iso

Conversation

@Bugs5382

Copy link
Copy Markdown
Contributor

What and why

docs/install-deploy/build-bootable-image.md's "Download the unsigned image"
section told readers to sign a downloaded release asset with
cryptosctl image sign but only linked out to cryptos-node's doc for the
command itself, unlike every other build path on this page (the signed build
and the unsigned build both show the actual command and a table of the files
it writes). This adds that: the --image/--key/--cert invocation against
a downloaded unsigned ISO, and the three files it leaves beside the input
(the signed ISO, the signed .uki, and the .uki.sig cryptosctl image stage
sends for later upgrades), matching cryptos-node's docs/image-sign.md and
cryptos-appliance's docs/secure-boot.md, which are the source for this
command.

docs/install-deploy/secure-boot.md already points at this section by anchor
(#download-the-unsigned-image) for the same path, and that anchor is
unchanged, so it needed no edit.

Refs CryptOS-PKI/cryptos-appliance#83

Verification

  • Lint clean
  • Tests pass
  • Build succeeds
  • Documentation updated (if behavior or API changed)

How this was verified

This is a docs-only change to one existing section; I don't build the site on
this box. CI (npm ci && npm run build, which renders the whole site) is the
proof. Read the rendered Markdown by eye against the page's existing sections
for list and code-fence indentation, and checked that the anchor
secure-boot.md links against (#download-the-unsigned-image) still matches
the unchanged heading.

…outputs

The "Download the unsigned image" section told readers to sign a release
asset with cryptosctl image sign but only linked out for the command itself.
Every other build path on this page (signed build, unsigned build) shows the
actual command and the files it writes, so this one now does too: the
--image/--key/--cert invocation and the signed ISO, UKI and .sig it leaves
next to the input.

Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
@Bugs5382 Bugs5382 added this to the v0.1.0 milestone Oct 16, 2026
@Bugs5382 Bugs5382 added the documentation Documentation only (docs). label Oct 16, 2026
@Bugs5382 Bugs5382 self-assigned this Oct 16, 2026
@Bugs5382
Bugs5382 marked this pull request as ready for review October 16, 2026 16:20
@Bugs5382
Bugs5382 merged commit 40a7ff7 into main Oct 16, 2026
20 checks passed
@Bugs5382
Bugs5382 deleted the docs/83-sign-downloaded-unsigned-iso branch October 16, 2026 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation only (docs).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant