rename boot-tree to bootvine
This commit is contained in:
1 parent
101d7bae89
commit
2d586f57f7
21 files changed
+104
-104
No files matched your search
@@ -1,4 +1,4 @@
|
||||
# boot-tree
|
||||
# bootvine
|
||||
|
||||
A live dependency tree of systemd jobs on the boot console, in the spirit of
|
||||
nix-output-monitor. It replaces the scrolling kernel and systemd lines with a
|
||||
@@ -8,7 +8,7 @@ tree of pending units and a timeline bar per row.
|
||||
|
||||
- Linux with **systemd ≥ 246 as PID 1** (private socket `/run/systemd/private`,
|
||||
`Manager.SetShowStatus`).
|
||||
- Runs as **root**, from the shipped `boot-tree.service`.
|
||||
- Runs as **root**, from the shipped `bootvine.service`.
|
||||
- **libdbus-1** at runtime.
|
||||
- A **virtual terminal** (`CONFIG_VT`); the unit draws on `/dev/tty12`.
|
||||
- Optional: a **systemd-based initrd** (NixOS `boot.initrd.systemd`, dracut, or
|
||||
@@ -17,7 +17,7 @@ tree of pending units and a timeline bar per row.
|
||||
- Optional: a large console font on HiDPI screens, e.g. Terminus `ter-v32n`
|
||||
through the distro's console font setting.
|
||||
|
||||
No kernel parameters are needed: while it runs, boot-tree lowers the kernel
|
||||
No kernel parameters are needed: while it runs, bootvine lowers the kernel
|
||||
console log level and turns systemd's status output off, and restores both when
|
||||
it hands the console over.
|
||||
|
||||
@@ -41,37 +41,37 @@ The package ships everything a system needs under `lib/`:
|
||||
|
||||
| File | Purpose |
|
||||
| --- | --- |
|
||||
| `lib/systemd/system/boot-tree.service` | the unit, used in both the initrd and stage 2 |
|
||||
| `lib/dracut/modules.d/90boot-tree/` | dracut module |
|
||||
| `lib/initcpio/install/sd-boot-tree` | mkinitcpio hook |
|
||||
| `lib/systemd/system/bootvine.service` | the unit, used in both the initrd and stage 2 |
|
||||
| `lib/dracut/modules.d/90bootvine/` | dracut module |
|
||||
| `lib/initcpio/install/sd-bootvine` | mkinitcpio hook |
|
||||
|
||||
### NixOS
|
||||
|
||||
```nix
|
||||
inputs.boot-tree.url = "git+file:/home/wvhulle/Code/boot-tree?ref=refs/heads/main";
|
||||
inputs.bootvine.url = "git+https://codeberg.org/wvhulle/bootvine";
|
||||
# in the host's modules:
|
||||
boot-tree.nixosModules.default
|
||||
{ services.boot-tree.enable = true; }
|
||||
bootvine.nixosModules.default
|
||||
{ services.bootvine.enable = true; }
|
||||
```
|
||||
|
||||
With `boot.initrd.systemd.enable` the unit is added to the initrd as well.
|
||||
|
||||
### Other distributions
|
||||
|
||||
1. Install `boot-tree` to `/usr/bin` and the files above under `/usr/lib`.
|
||||
2. `systemctl enable boot-tree.service`.
|
||||
1. Install `bootvine` to `/usr/bin` and the files above under `/usr/lib`.
|
||||
2. `systemctl enable bootvine.service`.
|
||||
3. To start it in the initrd:
|
||||
- dracut: `add_dracutmodules+=" boot-tree "` in `/etc/dracut.conf.d/boot-tree.conf`,
|
||||
- dracut: `add_dracutmodules+=" bootvine "` in `/etc/dracut.conf.d/bootvine.conf`,
|
||||
then `dracut --force`;
|
||||
- mkinitcpio: add `sd-boot-tree` after `systemd` in `HOOKS`, then
|
||||
- mkinitcpio: add `sd-bootvine` after `systemd` in `HOOKS`, then
|
||||
`mkinitcpio -P`.
|
||||
|
||||
To draw on another terminal, override `TTYPath=` with
|
||||
`systemctl edit boot-tree.service`.
|
||||
`systemctl edit bootvine.service`.
|
||||
|
||||
## Configuration
|
||||
|
||||
Colours come from `/etc/boot-tree.toml` (another path with `--config`). Every
|
||||
Colours come from `/etc/bootvine.toml` (another path with `--config`). Every
|
||||
key is optional; these are the defaults:
|
||||
|
||||
```toml
|
||||
@@ -97,13 +97,13 @@ the start of boot:
|
||||
On NixOS set the roles as options; unset ones keep their defaults:
|
||||
|
||||
```nix
|
||||
services.boot-tree.palette = {
|
||||
services.bootvine.palette = {
|
||||
running = "light-yellow";
|
||||
done = "light-green";
|
||||
};
|
||||
```
|
||||
|
||||
On dracut and mkinitcpio systems the hooks copy `/etc/boot-tree.toml` into the
|
||||
On dracut and mkinitcpio systems the hooks copy `/etc/bootvine.toml` into the
|
||||
initramfs, so rebuild it after editing.
|
||||
|
||||
## Testing
|
||||
@@ -115,7 +115,7 @@ Commands assume the dev shell is active (`direnv allow` once; `.envrc` runs
|
||||
| --- | --- |
|
||||
| Unit and render snapshot tests | `cargo test` |
|
||||
| Scripted boot animation, no systemd needed | `cargo run --example demo` (`q` quits) |
|
||||
| Live against your user manager | `nix run .#demo-units -- start`, then `nix run . -- --user --target boot-tree-demo.target --hold 3s` |
|
||||
| Live against your user manager | `nix run .#demo-units -- start`, then `nix run . -- --user --target bootvine-demo.target --hold 3s` |
|
||||
| Boot a demo VM in a window | `env -u LD_LIBRARY_PATH nix run .#vm` |
|
||||
| Automated boot test with OCR | `nix build .#checks.x86_64-linux.boot` (screenshots in `result/`) |
|
||||
| Same test, interactively | `nix run .#checks.x86_64-linux.boot.driverInteractive`, then `test_script()` |
|
||||
|
||||
Reference in new issue
Block a user