Release new version 1:20180603+grml.1
[live-boot-grml.git] / manpages / en / live-boot.7
1 .TH LIVE\-BOOT 7 2015\-09\-22 5.0~a5-1 "Live Systems Project"
2
3 .SH NAME
4 \fBlive\-boot\fR \- System Boot Components
5
6 .SH DESCRIPTION
7 \fBlive\-boot\fR contains the components that configure a live system during the boot process (early userspace).
8 .PP
9 .\" FIXME
10 live\-boot is a hook for the initramfs\-tools, used to generate a initramfs capable to boot live systems, such as those created by \fIlive\-helper\fR(7). This includes the Live systems ISOs, netboot tarballs, and usb stick images.
11 .PP
12 At boot time it will look for a (read\-only) medium containing a "/live" directory where a root filesystems (often a compressed filesystem image like squashfs) is stored. If found, it will create a writable environment, using aufs, to boot the system from.
13 .\" FIXME
14
15 .SH CONFIGURATION
16 \fBlive\-boot\fR can be configured through a boot parameter or a configuration file.
17 .PP
18 To configure the live\-boot parameters used by default in a live image, see the \-\-bootappend\-live option in the \fIlb_config\fR(1) manual page.
19
20 .SS Kernel Parameters
21 \fBlive\-boot\fR is only activated if 'boot=live' was used as a kernel parameter.
22 .PP
23 In addition, there are some more boot parameters to influence the behaviour, see below.
24
25 .SS Configuration Files
26 \fBlive\-boot\fR can be configured (but not activated) through configuration files. Those files can be placed either in the root filesystem itself (/etc/live/boot.conf, /etc/live/boot/*), or on the live media (live/boot.conf, live/boot/*).
27 These environment variables can only be set in the configuration files:
28
29 .TP
30 \fBDISABLE_CDROM\fR=[\fItrue\fR|\fIfalse\fR]
31 Disable support for booting from CD-ROMs.  If set to '\fIy\fR' mkinitramfs will build an initramfs without the kernel modules for reading CD-ROMs.
32
33 .TP
34 \fBDISABLE_FAT\fR=[\fItrue\fR|\fIfalse\fR]
35 Disable support for booting from FAT file systems.  If set to '\fIy\fR' mkinitramfs will build an initramfs without the kernel module vfat and some nls_* modules.
36
37 .TP
38 \fBDISABLE_FUSE\fR=[\fItrue\fR|\fIfalse\fR]
39 Disable support for booting from FUSE-based file systems.  If set to '\fIy\fR' mkinitramfs will build an initramfs without the kernel module fuse and file systems that depend on it (like curlftpfs and httpfs2).
40
41 .TP
42 \fBDISABLE_NTFS\fR=[\fItrue\fR|\fIfalse\fR]
43 Disable support for booting from NTFS file systems.  If set to '\fIy\fR' mkinitramfs will build an initramfs without the kernel module ntfs.
44
45 .TP
46 \fBDISABLE_USB\fR=[\fItrue\fR|\fIfalse\fR]
47 Disable support for booting from USB devices.  If set to '\fIy\fR' mkinitramfs will build an initramfs without the kernel module sd_mod.
48
49 .TP
50 \fBMINIMAL\fR=[\fItrue\fR|\fIfalse\fR]
51 Build a minimal initramfs.  If set to '\fIy\fR' mkinitramfs will build an initramfs without some udev scripts and without rsync.
52
53 .TP
54 \fBPERSISTENCE_FSCK\fR=[\fItrue\fR|\fIfalse\fR]
55 Run fsck on persistence filesystem on boot. Will attempt to repair errors. The execution log will be saved in /var/log/live/fsck.log.
56
57 .TP
58 \fBFSCKFIX\fR=[\fItrue\fR|\fIfalse\fR]
59 If PERSISTENCE_FSCK or forcefsck are set, will pass -y to fsck to stop it from asking questions interactively and assume yes to all queries.
60
61 .SH OPTIONS
62 \fBlive\-boot\fR currently features the following parameters.
63 .\" FIXME
64 .IP "\fBaccess\fR=\fIACCESS\fR" 4
65 Set the accessibility level for physically or visually impaired users. ACCESS must be one of v1, v2, v3, m1, or m2. v1=lesser visual impairment, v2=moderate visual impairment, v3=blindness, m1=minor motor difficulties, m2=moderate motor difficulties.
66 .IP "\fBconsole\fR=\fITTY,SPEED\fR" 4
67 Set the default console to be used with the "live\-getty" option. Example: "console=ttyS0,115200"
68 .IP "\fBdebug\fR" 4
69 Makes initramfs boot process more verbose.
70 .br
71 Use: debug=1
72 .br
73 Without setting debug to a value the messages may not be shown.
74 .IP "\fBfetch\fR=\fIURL\fR" 4
75 .IP "\fBhttpfs\fR=\fIURL\fR" 4
76 Another form of netboot by downloading a squashfs image from a given URL.
77 The fetch method copies the image to RAM and the httpfs method uses FUSE and
78 httpfs2 to mount the image in place. Copying to RAM requires more memory and
79 might take a long time for large images. However, it is more likely to work
80 correctly because it does not require networking afterwards and the system
81 operates faster once booted because it does not require to contact the server
82 anymore.
83 .br
84 Due to current limitations in busybox's wget and DNS resolution, an URL can not contain a hostname but an IP address only.
85 .br
86 Not working: http://example.com/path/to/your_filesystem.squashfs
87 .br
88 Working: http://1.2.3.4/path/to/your_filesystem.squashfs
89 .br
90 Also note that therefore it's currently not possible to fetch an image from a name-based virtualhost of an httpd if it is sharing the IP address with the main httpd instance.
91 .br
92 You may also use the live ISO image in place of the squashfs image.
93 .IP "\fBiscsi\fR=\fIserver-ip[,server-port];target-name\fR" 4
94 Boot from an iSCSI target that has an ISO or disk live image as one of its LUNs. The specified target is searched for a LUN which looks like a live medium. If you use the \fBiscsitarget\fR software iSCSI target solution your ietd.conf might look like this:
95 .br
96 # The target-name you specify in the iscsi= parameter
97 .br
98 Target <target-name>
99   Lun 0 Path=<path-to-your-live-image.iso>,Type=fileio,IOMode=ro
100   # If you want to boot multiple machines you might want to look at tuning some parameters like
101   # Wthreads or MaxConnections
102 .IP "\fBfindiso\fR=\fI/PATH/TO/IMAGE\fI" 4
103 Look for the specified ISO file on all disks where it usually looks for the .squashfs file (so you don't have to know the device name as in fromiso=....).
104 .IP "\fBforcefsck\fR" 4
105 Run fsck on persistence filesystem on boot. Will attempt to repair errors. The execution log will be saved in /var/log/live/fsck.log.
106 .IP "\fBfromiso\fR=\fI/PATH/TO/IMAGE\fI" 4
107 Use a filesystem from within an ISO image that's available on live-media. The first part of the argument should be the block device where the image is stored, followed by the path and filename (e.g. fromiso=/dev/sda1/live/image.iso).
108 .br
109 Alternatively, it can be used to boot from an ISO embedded into an initrd (e.g. fromiso=/live/image.iso).
110 .IP "\fBignore_uuid\fR" 4
111 Do not check that any UUID embedded in the initramfs matches the discovered medium. live\-boot may be told to generate a UUID by setting LIVE_GENERATE_UUID=1 when building the initramfs.
112 .IP "\fBverify\-checksums\fR" 4
113 If specified, an MD5 sum is calculated on the live media during boot and compared to the value found in md5sum.txt found in the root directory of the live media.
114 .IP "\fBip\fR=[\fIDEVICE\fR]:[\fICLIENT_IP\fR]:[\fINETMASK\fR]:[\fIGATEWAY_IP\fR]:[\fINAMESERVER\fR] [,[\fIDEVICE\fR]:[\fICLIENT_IP\fR]:[\fINETMASK\fR]:[\fIGATEWAY_IP\fR]:[\fINAMESERVER\fR]]" 4
115 Let you specify the name(s) and the options of the interface(s) that should be configured at boot time. Do not specify this if you want to use dhcp (default). It will be changed in a future release to mimic official kernel boot param specification (e.g. ip=10.0.0.1::10.0.0.254:255.255.255.0::eth0,:::::eth1:dhcp).
116 .IP "\fBip\fR=[\fIfrommedia\fR]" 4
117 If this variable is set, dhcp and static configuration are just skipped and the system will use the (must be) media\-preconfigured /etc/network/interfaces instead.
118 .IP "{\fBlive\-media\fR|\fBbootfrom\fR}=\fIDEVICE\fR" 4
119 If you specify one of this two equivalent forms, live\-boot will first try to find this device for the "/live" directory where the read\-only root filesystem should reside. If it did not find something usable, the normal scan for block devices is performed.
120 .br
121 Instead of specifying an actual device name, the keyword 'removable' can be used to limit the search of acceptable live media to removable type only. Note that if you want to further restrict the media to usb mass storage only, you can use the 'removable\-usb' keyword.
122 .IP "{\fBlive\-media\-encryption\fR|\fBencryption\fR}=\fITYPE\fI" 4
123 live\-boot will mount the encrypted rootfs TYPE, asking the passphrase, useful to build paranoid live systems :\-). TYPE supported so far is "aes" for loop\-aes encryption type.
124 .IP "\fBlive\-media\-offset\fR=\fIBYTES\fR" 4
125 This way you could tell live\-boot that your image starts at offset BYTES in the above specified or autodiscovered device, this could be useful to hide the live system ISO or image inside another ISO or image, to create "clean" images.
126 .IP "\fBlive\-media\-path\fR=\fIPATH\fR" 4
127 Sets the path to the live filesystem on the medium. By default, it is set to '/live' and you should not change that unless you have customized your media accordingly.
128 .IP "\fBlive\-media\-timeout\fR=\fISECONDS\fI" 4
129 Set the timeout in seconds for the device specified by "live\-media=" to become ready before giving up.
130 .IP "\fBmodule\fR=\fINAME\fR" 4
131 Instead of using the default optional file "filesystem.module" (see below) another file could be specified without the extension ".module"; it should be placed on "/live" directory of the live medium.
132 .IP "\fBnetboot\fR[=nfs|cifs]" 4
133 This tells live\-boot to perform a network mount. The parameter "nfsroot=" (with optional "nfsopts="), should specify where is the location of the root filesystem.  With no args, will try cifs first, and if it fails nfs.
134 .IP "\fBnfsopts\fR=" 4
135 This lets you specify custom nfs options.
136 .IP "\fBnofastboot\fR" 4
137 This parameter disables the default disabling of filesystem checks in /etc/fstab. If you have static filesystems on your harddisk and you want them to be checked at boot time, use this parameter, otherwise they are skipped.
138 .IP "\fBnopersistence\fR" 4
139 disables the "persistence" feature, useful if the bootloader (like syslinux) has been installed with persistence enabled.
140 .IP "\fBnoeject\fR" 4
141 Do not prompt to eject the live medium.
142 .IP "\fBramdisk\-size\fR" 4
143 This parameter defines a custom ramdisk size (it's the '\-o size' option of tmpfs mount). By default, there is no ramdisk size set, so the default of mount applies (currently 50% of available RAM). Note that this option has currently no effect when booting with toram.
144 .IP "\fBoverlay\-size\fR=\fISIZE\fR" 4
145 The size of the tmpfs mount (used for the upperdir union root mount) in bytes, and rounded up to entire pages. This option accepts a suffix % to limit the instance to that percentage of your physical RAM or a suffix k, m or g for Ki, Mi, Gi (binary kilo (kibi), binary mega (mebi) and binary giga (gibi)). By default, 50% of available RAM will be used.
146 .IP "\fBswap=true\fR" 4
147 This parameter enables usage of local swap partitions.
148 .IP "\fBpersistence\fR" 4
149 live\-boot will probe devices for persistence media. These can be partitions (with the correct GPT name), filesystems (with the correct label) or image files (with the correct file name). Overlays are labeled/named "persistence" (see \fIpersistence.conf\fR(5)). Overlay image files are named "persistence".
150 .IP "\fBpersistence\-encryption\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4
151 This option determines which types of encryption that are allowed to be used when probing devices for persistence media. If "none" is in the list, we allow unencrypted media; if "luks" is in the list, we allow LUKS\-encrypted media. Whenever a device containing encrypted media is probed the user will be prompted for the passphrase. The default value is "none".
152 .IP "\fBpersistence\-media\fR={\fIremovable\fR|\fIremovable\-usb\fR}" 4
153 If you specify the keyword 'removable', live\-boot will try to find persistence partitions on removable media only. Note that if you want to further restrict the media to usb mass storage only, you can use the 'removable\-usb' keyword.
154 .IP "\fBpersistence\-method\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4
155 This option determines which types of persistence media we allow. If "overlay" is in the list, we consider overlays (i.e. "live\-rw" and "home\-rw"). The default is "overlay".
156 .IP "\fBpersistence\-path\fR=\fIPATH\fR" 4
157 live\-boot will look for persistency files in the root directory of a partition, with this parameter, the path can be configured so that you can have multiple directories on the same partition to store persistency files.
158 .IP "\fBpersistence\-read\-only\fR" 4
159 Filesystem changes are not saved back to persistence media. In particular, overlays and netboot NFS mounts are mounted read-only.
160 .IP "\fBpersistence\-storage\fR=\fITYPE1\fR,\fITYPE2\fR ... \fITYPEn\fR" 4
161 This option determines which types of persistence storage to consider when probing for persistence media. If "filesystem" is in the list, filesystems with matching labels will be used; if "file" is in the list, all filesystems will be probed for archives and image files with matching filenames. The default is "file,filesystem".
162 .IP "\fBpersistence\-label\fR=\fILABEL\fR" 4
163 live-boot will use the name "LABEL" instead of "persistence" when searching for persistent storage. LABEL can be any valid filename, partition label, or GPT name.
164 .IP "\fBnoeject\fR" 4
165 This option causes live\-boot to reboot without attempting to eject the media and without asking the user to remove the boot media.
166 .IP "\fBshowmounts\fR" 4
167 This parameter will make live\-boot to show on "/" the ro filesystems (mostly compressed) on "/lib/live". This is not enabled by default because could lead to problems by applications like "mono" which store binary paths on installation.
168 .IP "\fBsilent\fR" 4
169 If you boot with the normal quiet parameter, live\-boot hides most messages of its own. When adding silent, it hides all.
170 .IP "\fBtodisk\fR=\fIDEVICE\fR" 4
171 Adding this parameter, live\-boot will try to copy the entire read\-only media to the specified device before mounting the root filesystem. It probably needs a lot of free space. Subsequent boots should then skip this step and just specify the "live\-media=DEVICE" boot parameter with the same DEVICE used this time.
172 .IP "\fBtoram\fR" 4
173 Adding this parameter, live\-boot will try to copy the whole read\-only media to the computer's RAM before mounting the root filesystem. This could need a lot of ram, according to the space used by the read\-only media.
174 .IP "\fBunion\fR=overlay|aufs\fR" 4
175 By default, live\-boot uses overlay. With this parameter, you can switch to aufs.
176 .\" FIXME
177
178 .\" FIXME
179 .SH FILES (old)
180 .IP "\fB/etc/live.conf\fR" 4
181 Some variables can be configured via this config file (inside the live system).
182 .IP "\fBlive/filesystem.module\fR" 4
183 This optional file (inside the live media) contains a list of white\-space or carriage\-return\-separated file names corresponding to disk images in the "/live" directory. If this file exists, only images listed here will be merged into the root aufs, and they will be loaded in the order listed here. The first entry in this file will be the "lowest" point in the aufs, and the last file in this list will be on the "top" of the aufs, directly below /overlay.  Without this file, any images in the "/live" directory are loaded in alphanumeric order.
184 .\" FIXME
185
186 .SH FILES
187 .IP "\fB/etc/live/boot.conf\fR" 4
188 .IP "\fB/etc/live/boot/*\fR" 4
189 .IP "\fBlive/boot.conf\fR" 4
190 .IP "\fBlive/boot/*\fR" 4
191 .IP "\fBpersistence.conf\fR" 4
192
193 .SH SEE ALSO
194 \fIpersistence.conf\fR(5)
195 .PP
196 \fIlive\-build\fR(7)
197 .PP
198 \fIlive\-config\fR(7)
199 .PP
200 \fIlive\-tools\fR(7)
201
202 .SH HOMEPAGE
203 More information about live\-boot and the Live Systems project can be found on the homepage at <\fIhttp://live-systems.org/\fR> and in the manual at <\fIhttp://live-systems.org/manual/\fR>.
204
205 .SH BUGS
206 Bugs can be reported by submitting a bugreport for the live\-boot package in the Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Live Systems mailing list at <\fIdebian-live@lists.debian.org\fR>.
207
208 .SH AUTHOR
209 live\-boot was written by Daniel Baumann <\fImail@daniel-baumann.ch\fR>.