BOOTC-DOCS(7)

✨ BOOTC-DOCS(7) ✨

okay bestie so this is a page from the Miscellaneous Information Manual — yes, that's the manual name, and yeah it's a whole lot of miscellaneous 💅 anyway, sit down, hydrate, we're doing the tour.

🌸 NAME 🌸

bootc-docs — the guide to bootc documentation, aka your little map of everything bootc ever wrote down 🗺️

🎀 DESCRIPTION 🎀

So here's the tea: the docs that ship with bootc come in three flavors. Guides live in section 7, commands live in section 8, and configuration + services live in section 5. And the groups below? They follow the website navigation exactly, no cap. So like, if you know your way around the website, you already know your way around here. iykyk 🦋

💖 Summary

• bootc-overview(7) — bootc

💖 Installation

• bootc-base-images(7) — Base images

💖 Building images

• bootc-building-images(7) — Generic guidance for building images
• bootc-container-runtime(7) — Container runtime vs "bootc runtime"
• bootc-dns(7) — DNS and /etc/resolv.conf
• bootc-users-and-groups(7) — Users and groups
• bootc-sysusers-shadow-sync.service(5) — bootc-sysusers-shadow-sync.service
• bootc-kernel-arguments(7) — Kernel arguments
• bootc-sealed-images(7) — Sealed images
• bootc-secrets(7) — Secrets (e.g. container pull secrets)
• bootc-management-services(7) — Management services

💖 Using bootc

• bootc-upgrades(7) — Managing upgrades
• bootc-boot-failure-detection(7) — Upgrade/rollback failure detection in bootc
• bootc-registries-and-offline(7) — Accessing registries and disconnected updates
• bootc-logically-bound-images(7) — Logically Bound Images
• bootc-local-builds(7) — Booting local builds
• bootc-initramfs(7) — Managing the initramfs after installation
• bootc(8) — Deploy and transactionally in-place with bootable container images
• bootc-config(5) — Configuration file format for bootc
• bootc-config-diff(8) — Diff current /etc configuration versus default
• bootc-edit(8) — Apply full changes to the host specification
• bootc-status(8) — Display status
• bootc-upgrade(8) — Download and queue an updated container image to apply
• bootc-switch(8) — Target a new container image reference to boot
• bootc-rollback(8) — Change the bootloader entry ordering
• bootc-usr-overlay(8) — Adds a transient overlayfs on /usr that will be discarded on reboot
• bootc-fetch-apply-updates.service(5) — bootc-fetch-apply-updates.service
• bootc-status-updated.path(5) — bootc-status-updated.path
• bootc-status-updated.target(5) — bootc-status-updated.target
• bootc-api(7) — Using bootc via API

💖 Using bootc install

• bootc-installation(7) — Installing "bootc compatible" images
• bootc-install(8) — Install the running container to a target
• bootc-install-config(5) — bootc-install-config.toml
• bootc-install-to-disk(8) — Install to the target block device
• bootc-install-to-filesystem(8) — Install to an externally created filesystem structure
• bootc-install-to-existing-root(8) — Install to the host root filesystem
• bootc-install-mount(8) — Mount an installed deployment into a caller-owned directory
• bootc-install-finalize(8) — Execute this as the penultimate step of an installation using install to-filesystem
• bootc-install-ensure-completion(8) — Intended for use in environments that are performing an ostree-based installation, not bootc
• bootc-install-print-configuration(8) — Output JSON to stdout that contains the merged installation configuration as it may be relevant to calling processes using install to-filesystem that in particular want to discover the desired root filesystem type from the container image
• system-reinstall-bootc(8) — Reinstall the current system with a bootc image
• bootc-destructive-cleanup.service(5) — bootc-destructive-cleanup.service

bestie the name literally has "destructive" in it, that's your warning label right there 💀

💖 Bootc usage in containers

• bootc-in-container(7) — bootc is read-only when run in a default container
• bootc-container(8) — Operations which can be executed as part of a container build
• bootc-container-inspect(8) — Output JSON to stdout containing the container image metadata
• bootc-container-split-kernel-and-rootfs(8) — Split kernel and rootfs from a container image
• bootc-container-ukify(8) — Build a Unified Kernel Image (UKI) using ukify
• bootc-container-compute-composefs-digest(8) — Output the bootable composefs digest for a directory
• bootc-container-lint(8) — Perform relatively inexpensive static analysis checks as part of a container build

💖 Architecture

• bootc-compatible-images(7) — "bootc compatible" images
• bootc-filesystem(7) — Filesystem
• bootc-sysroot(7) — Filesystem: Physical /sysroot
• bootc-container-storage(7) — Container storage
• bootc-composefs(7) — composefs backend
• bootc-root-setup.service(5) — bootc-root-setup.service
• bootc-setup-root-conf(5) — bootc-setup-root-conf.toml
• bootc-composefs-finalize-staged(8) — Finalize a staged composefs deployment
• bootc-bootloaders(7) — Bootloaders in bootc
• bootc-loader-entries(8) — Operations on Boot Loader Specification (BLS) entries
• bootc-loader-entries-set-options-for-source(8) — Set or update the kernel arguments owned by a specific source
• bootc-filesystem-encryption(7) — Disk encryption (e.g. LUKS)

💖 Security

• bootc-security(7) — Security and threat model

💖 Experimental features

• bootc-experimental-image(7) — bootc image
• bootc-experimental-unified-storage(7) — Unified storage
• bootc-experimental-fsck(7) — bootc internals fsck
• bootc-experimental-install-reset(7) — Factory reset with bootc install reset
• bootc-experimental-progress-fd(7) — Interactive progress with --progress-fd
• bootc-experimental-container-export(7) — container export

these are experimental, so like. they might change on you. that's the whole vibe. 🙈

💖 More information

• bootc-packaging-and-integration(7) — Packaging and Integration
• bootc-package-managers(7) — Package manager integration
• bootc-relationships(7) — Relationship with other projects
• bootc-oci-artifacts(7) — How does the use of OCI artifacts intersect with this effort?
• bootc-systemd-particles(7) — Relationship with systemd "particles"

💖 Development

• bootc-internals(7) — Internals

🌈 VERSION 🌈

v1.17.1

---

and that's the whole page bestie, we ate and left absolutely no crumbs 🫶 this one's from the Miscellaneous Information Manual, version v1.17.1, and yeah — it's got the BOOTC-DOCS(7) footer energy all over it. go read a section 7 guide, you deserve it 💖✨👑