Files
bootvine/README.md
T

76 lines
3.0 KiB
Markdown

# bootvine
A live tree of systemd jobs on the boot console, in the spirit of
[nix-output-monitor](https://github.com/maralorn/nix-output-monitor). It
replaces the scrolling kernel and systemd lines with the units still pending
and, in the room the tree leaves, a timeline of the slowest ones that ran.
I started bootvine out of frustration with the boot screen of most Linux
distributions: a wall of log lines scrolling past too fast to read, which never
gave me any idea of what was going on.
<img src="https://codeberg.org/wvhulle/bootvine/raw/branch/main/recordings/boot.gif" width="691" alt="A boot through the initrd into stage 2, with one failed unit">
It follows shutdowns and reboots too: the units being stopped, nested under the
units that have to stop first.
<img src="https://codeberg.org/wvhulle/bootvine/raw/branch/main/recordings/shutdown.gif" width="691" alt="A poweroff: units stopping under the targets waiting on them">
Passphrase prompts, such as a
[LUKS](https://gitlab.com/cryptsetup/cryptsetup) unlock in the initrd, are
answered in place over the tree.
<img src="https://codeberg.org/wvhulle/bootvine/raw/branch/main/recordings/passphrase.png" width="640" alt="A LUKS passphrase prompt floating over the initrd tree">
## Requirements
- systemd ≥ 246 as PID 1
- [libdbus](https://www.freedesktop.org/wiki/Software/dbus/)
- a virtual terminal
- a systemd initrd, to show the boot from the initrd as well as stage 2
See [Install](https://codeberg.org/wvhulle/bootvine/src/branch/main/docs/install.md)
for each distribution.
## Try it without installing
Neither of these touches your system's boot.
Play a scripted boot, poweroff and encrypted-root boot in your terminal, with
[Rust](https://www.rust-lang.org/tools/install) installed:
```sh
git clone https://codeberg.org/wvhulle/bootvine.git
cd bootvine
cargo run --example boot
cargo run --example shutdown
cargo run --example luks
```
`q` quits. The encrypted root unlocks with the passphrase `demo`; `Esc` quits
while it asks.
Or, with [Nix](https://nixos.org/download/), boot a sample [NixOS](https://nixos.org) machine with slow and
failing units in a [QEMU](https://www.qemu.org) window:
```sh
nix run git+https://codeberg.org/wvhulle/bootvine#sample-machine-vm
```
It logs in as root; `poweroff` shows the shutdown.
## Documentation
- [Install](https://codeberg.org/wvhulle/bootvine/src/branch/main/docs/install.md)
on NixOS, Ubuntu and other distributions.
- [Configuration](https://codeberg.org/wvhulle/bootvine/src/branch/main/docs/configuration.md)
of colours, timing and the console.
- [Architecture](https://codeberg.org/wvhulle/bootvine/src/branch/main/docs/architecture.md):
how bootvine follows the boot and takes the console.
- [Development](https://codeberg.org/wvhulle/bootvine/src/branch/main/docs/development.md)
and the [code style](https://codeberg.org/wvhulle/bootvine/src/branch/main/docs/style.md).
## License
[GPL-3.0-or-later](https://codeberg.org/wvhulle/bootvine/src/branch/main/LICENSE).