From 0143673690c219838bd40179f13ba88e36a2528e Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Sat, 25 Nov 2023 13:29:42 +1100 Subject: [PATCH] update doc --- doc/boot@.md | 43 ++++++++++++++++++++++++------------------- 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/doc/boot@.md b/doc/boot@.md index c26015d..c7d37c1 100644 --- a/doc/boot@.md +++ b/doc/boot@.md @@ -9,33 +9,39 @@ The boot@ instantiated service is a portable set of services to boot a machine i Like any other instantiated service to enable it you need to specify the target of the service. The target can be a random name. -This is a specific service that handles the boot sequence of a machine, it is usually enabled on a tree build especially for it and contains only this service. +This is a specific service that handles the boot sequence of a machine, it is usually enabled on a tree build especially for it. -For example: +By default the service will be set to the tree named `boot` created by the enable command with the help of the provided seed file. + +To enable it, simply do: ``` -# 66-tree -n boot -# 66-enable -t boot boot@system +# 66 enable boot@system ``` -The name of the tree need to match the name set at your `TREE=` *key=value* pair defined in the `%%skel_directory%%/init.conf` file. -Do not mark this tree enabled with the `66-tree -E` option. The [66-init](https://web.obarun.org/software/66/66-tree.html) will take care of this special tree and start it automatically. +## Changing the name of the tree + +If you wish to change the name of the tree where the service is enabled, you need to: + +- change the name of the tree at the `@intree` field of the `boot@` service frontend file. -Refer to the [66-tree](https://web.obarun.org/software/66/66-tree.html) and [66-enable](https://web.obarun.org/software/66/66-tree.html) for further information on these tools. +- change the `TREE=` *key=value* pair defined in the `%%skel_directory%%/init.conf` file with the required name. + +- make a copy of the provided seed file at `%%seed_directory%%/` with the required name. ## How to configure it This service is declared as a `module` service and comes with its own configuration file. -The configuration file can be seen and edited easily using the [66-env](https://web.obarun.org/software/66/66-env.html) tool: +The configuration file can be seen and edited easily using the [66 configure](https://web.obarun.org/software/66/66.html) command: ``` -# 66-env boot@system +# 66 configure boot@system ``` -When you are done editing this file, you need to reenable the service to have changes applied by using the -F option: +When you are done editing this file, you need to reconfigure the service to have changes applied at the next boot: ``` -# 66-enable -t boot -F boot@system +# 66 reconfigure boot@system ``` ## Configuration file key=value pair explanation @@ -65,7 +71,7 @@ Variables need to be present in the environment section/file, unless otherwise n - valid value: any valid name found at `/usr/share/kbd/keymaps` directory. - description: uses the `loadkeys` program to set the keymap for the console to use. Usually a simple string like fr, us,... - KEYMAP does not need to be present in the environment. - + - **FONT**: - type: string. - valid value: any valid name found at `/usr/share/kbd/consolefonts`. @@ -86,11 +92,11 @@ Variables need to be present in the environment section/file, unless otherwise n - **FSTAB**: - type: boolean. - description: uses the `mount -a` command to mount each filesystem set at `/etc/fstab`. - + - **SWAP**: - type: boolean. - description: uses the `swapon -a` command to activate your swap partitions/files. - + - **LVM**: - type: boolean. - description: uses the `vgchange` program to activate LVM volume groups and `cryptsetup` to open luks volumes in them. If the programs are not installed in the system, or if lvm devices are not discovered, a warning is emmited. @@ -106,7 +112,7 @@ Variables need to be present in the environment section/file, unless otherwise n - **BTRFS**: - type: boolean. - description: uses the `btrfs` program to activate BTRFS devices. If the program is not installed in the system, or if btrfs devices are not discovered, a warning is emmited. - + - **ZFS**: - type: boolean. - description: uses the `zfs` program to mount ZFS filesystems. If the program is not installed in the system, or if zfs devices are not discovered, a warning is emmited. @@ -116,8 +122,7 @@ Variables need to be present in the environment section/file, unless otherwise n - valid value: scan or zpoolcache. - description: select the import method to use to detect the ZFS devices. This variable works in conjunction with the `ZFS` variable. In case the `ZFS` variable is set to no or commented, the `ZFS_IMPORT` variable has no effect. -*LVM, DMRAID, MDRAID, BTRFS and ZFS rely on the `blkid` program from `util-linux` for device descovery.* - +*LVM, DMRAID, MDRAID, BTRFS and ZFS rely on the `blkid` program from `util-linux` for device discovery.* - **SETUPCONSOLE**: - type: boolean. @@ -143,7 +148,7 @@ Variables need to be present in the environment section/file, unless otherwise n - **LOCAL**: - type: boolean. - description: use the `%%skel_directory%%/rc.local` script. This script is launched at the end of the boot procedure. The file ***must*** exist on your system and be set as executable, with correct definition of the shebang at the start of the script. - + - **CONTAINER**: - type: boolean. - description: convenient variable used to boot inside a container. Some services will not work or be unnecessary when you boot inside a container. This variable provides you a safe default for this purpose. If set to yes the `HARDWARECLOCK`, `SETUPCONSOLE`, `KEYMAP`, `FONT`, `FONT_MAP`, `FONT_UNIMAP`, `CRYPTTAB`, `SWAP`, `LVM`, `DMRAID`, `BTRFS`, `ZFS`, `UDEV`, `SYSCTL`, `FORCECHCK`, `CGROUPS`, `MODULE_SYSTEM`, `RANDOMSEED`, `MNT_NETFS` variables have no effect. @@ -168,7 +173,7 @@ Variables need to be present in the environment section/file, unless otherwise n - type: boolean. - description: use the file `/etc/crypttab` to decrypt encrypted devices. The file `/etc/crypttab` ***must*** exist on your system. -*CRYPTTAB relies on the `blkid` program from `util-linux` for device descovery.* +*CRYPTTAB relies on the `blkid` program from `util-linux` for device discovery.* - **FIREWALL**: - type: string. -- GitLab