6 live-initramfs - Debian Live initramfs hook
12 as kernel parameter at boot prompt.
17 live-initramfs is a hook for the initramfs-tools, used to generate a initramfs
18 capable to boot live systems, such as those created by *live-helper*(7).
19 This includes the Debian Live isos, netboot tarballs, and usb stick images.
21 At boot time it will look for a (read-only) media containing a "/live"
22 directory where a root filesystems (often a compressed filesystem image like
23 squashfs) is stored. If found, it will create a writable environment, using
24 aufs, for Debian like systems to boot from.
26 You probably do not want to install this package onto a non-live system,
27 although it will do no harm.
29 live-initramfs is a fork of link:http://packages.ubuntu.com/casper/[casper].
30 casper was originally written by Tollef Fog Heen <tfheen@canonical.com>
31 and Matt Zimmerman <mdz@canonical.com>.
36 Here is the complete list of recognized boot parameters by live-initramfs.
40 Set the accessibility level for physically or visually impared users. ACCESS
41 must be one of v1, v2, v3, m1, or m2. v1=lesser visual impairment, v2=moderate
42 visual impairment, v3=blindness, m1=minor motor difficulties, m2=moderate motor
47 Set the default console to be used with the "live-getty" option. Example:
48 "console=ttyS0,115200"
52 Makes initramfs boot process more verbose.
56 Another form of netboot by downloading a squashfs image from a given url,
57 copying to ram and booting it. Due to current limitations in busyboxs wget
58 and DNS resolution, an URL can not contain a hostname but an IP only.
60 Not working: http://example.com/path/to/your_filesystem.squashfs
61 Working: http://1.2.3.4/path/to/your_filesystem.squashfs
63 Also note that therefore it's currently not possible to fetch an image from a
64 namebased virtualhost of an httpd if it is sharing the ip with the main httpd
67 hostname=*HOSTNAME*, username=*USER*, userfullname=*USERFULLNAME*::
69 Those parameters lets you override values read from the config file.
73 Do not check that any UUID embedded in the initramfs matches the discovered
74 medium. live-initramfs may be told to generate a UUID by setting
75 LIVE_GENERATE_UUID=1 when building the initramfs.
79 If specified, an MD5 sum is calculated on the live media during boot and
80 compared to the value found in md5sum.txt found in the root directory of the
83 ip=**[CLIENT_IP]:[SERVER_IP]:[GATEWAY_IP]:[NETMASK]:[HOSTNAME]:[DEVICE]:[AUTOCONF] [,[CLIENT_IP]:[SERVER_IP]:[GATEWAY_IP]:[NETMASK]:[HOSTNAME]:[DEVICE]:[AUTOCONF]]***::
85 Let you specify the name(s) and the options of the interface(s) that should be
86 configured at boot time. Do not specify this if you want to use dhcp (default).
87 It will be changed in a future release to mimick official kernel boot param
88 specification (e.g. ip=10.0.0.1::10.0.0.254:255.255.255.0::eth0,:::::eth1:dhcp).
92 If this variable is set, dhcp and static configuration are just skipped and the
93 system will use the (must be) media-preconfigured /etc/network/interfaces
96 {keyb|kbd-chooser/method}=**KEYBOARD**, {klayout|console-setup/layoutcode}=**LAYOUT**, {kvariant|console-setup/variantcode}=**VARIANT**, {kmodel|console-setup/modelcode}=**CODE**, koptions=**OPTIONS**::
98 Configure the running keyboard as specified, if this one misses live-initramfs
99 behaves as if "keyb=us" was specified. It will be interfered from "locale=" if
100 locale is only 2 lowecase letters as a special case. You could also specify
101 console layout, variant, code, and options (no defaults).
105 This changes the auto-login on virtual terminals to use the (experimental)
106 live-getty code. With this option set the standard kernel argument "console=" is
107 parsed and if a serial console is specified then live-getty is used to autologin
108 on the serial console.
110 {live-media|bootfrom}=**DEVICE**::
112 If you specify one of this two equivalent forms, live-initramfs will first try
113 to find this device for the "/live" directory where the read-only root
114 filesystem should reside. If it did not find something usable, the normal scan
115 for block devices is performed.
117 Instead of specifing an actual device name, the keyword 'removable' can be used
118 to limit the search of acceptable live media to removable type only. Note that
119 cdrom devices are not removable, but e.g. usb mass storage is.
121 {live-media-encryption|encryption}=**TYPE**::
123 live-initramfs will mount the encrypted rootfs TYPE, asking the passphrase,
124 useful to build paranoid live systems :-). TYPE supported so far are "aes" for
125 loop-aes encryption type.
127 live-media-offset=**BYTES**::
129 This way you could tell live-initramfs that your image starts at offset BYTES in
130 the above specified or autodiscovered device, this could be useful to hide the
131 Debian Live iso or image inside another iso or image, to create "clean" images.
133 live-media-path=**PATH**::
135 Sets the path to the live filesystem on the medium. By default, it is set to
136 '/live' and you should not change that unless you have customized your media
139 live-media-timeout=**SECONDS**::
141 Set the timeout in seconds for the device specified by "live-media=" to become
142 ready before giving up.
144 {locale|debian-installer/locale}=**LOCALE**::
146 Configure the running locale as specified, if not present the live-media rootfs
147 configured locale will be used and if also this one misses live-initramfs behave
148 as "locale=en_US.UTF-8" was specified. If only 2 lowercase letter are specified
149 (like "it"), the "maybe wanted" locale is generated (like en:EN.UTF-8), in this
150 case if also "keyb=" is unspecified is set with those 2 lowercase letters
151 (keyb=us). Beside that facility, only UTF8 locales are supported by
156 Instead of using the default optional file "filesystem.module" (see below)
157 another file could be specified without the extension ".module"; it should be
158 placed on "/live" directory of the live medium.
160 netboot[=**nfs**|**cifs**]::
162 This tells live-initramfs to perform a network mount. The parameter "nfsroot="
163 (with optional "nfsopts="), should specify where is the location of the root
164 filesystem. With no args, will try cifs first, and if it fails nfs.
168 This lets you specify custom nfs options.
172 This parameter disables the automatic terminal login only, not touching gdk/kdm.
176 This parameter disables the automatic login of gdm/kdm only, not touching
181 This parameter disables the default disabling of filesystem checks in
182 /etc/fstab. If you have static filesystems on your harddisk and you want them to
183 be checked at boot time, use this parameter, otherwise they are skipped.
187 disables the "persistent" feature, useful if the bootloader (like syslinux) has
188 been installed with persistent enabled.
192 Do not prompt to eject the CD on reboot.
196 This parameter disables the automatic configuration of sudo.
200 This parameter enables usage of local swap partitions.
204 This parameter disables the creation of the default user completely.
208 This parameter disables Xorg auto-reconfiguration at boot time. This is valuable
209 if you either do the detection on your own, or, if you want to ship a custom,
210 premade xorg.conf in your live system.
212 persistent[=nofiles]::
214 live-initramfs will look for persistent and snapshot partitions or files labeled
215 "live-rw", "home-rw", and files called "live-sn*", "home-sn*" and will try to,
216 in order: mount as /cow the first, mount the second in /home, and just copy the
217 contents of the latter in appropriate locations (snapshots). Snapshots will be
218 tried to be updated on reboot/shutdown. Look at live-snapshot(1) for more
219 informations. If "nofiles" is specified, only filesystems with matching labels
220 will be searched; no filesystems will be traversed looking for archives or image
221 files. This results in shorter boot times.
225 live-initramfs will look for persistency files in the root directory of a partition,
226 with this parameter, the path can be configured so that you can have multiple
227 directories on the same partition to store persistency files.
229 {preseed/file|file}=**FILE**::
231 A path to a file present on the rootfs could be used to preseed debconf
234 package/question=**VALUE**::
236 All debian installed packages could be preseeded from command-line that way,
237 beware of blanks spaces, they will interfere with parsing, use a preseed file in
242 This option causes live-initramfs to reboot without attempting to eject the
243 media and without asking the user to remove the boot media.
247 This parameter will make live-initramfs to show on "/" the ro filesystems
248 (mostly compressed) on "/live". This is not enabled by default because could
249 lead to problems by applications like "mono" which store binary paths on
254 If you boot with the normal quiet parameter, live-initramfs hides most messages
255 of its own. When adding silent, it hides all.
259 Start up to text-mode shell prompts, disabling the graphical user interface.
261 timezone=**TIMEZONE**::
263 By default, timezone is set to UTC. Using the timezone parameter, you can set it
264 to your local zone, e.g. Europe/Zurich.
268 Adding this parameter, live-initramfs will try to copy the entire read-only
269 media to the specified device before mounting the root filesystem. It probably
270 needs a lot of free space. Subsequent boots should then skip this step and just
271 specify the "live-media=DEVICE" boot parameter with the same DEVICE used this
276 Adding this parameter, live-initramfs will try to copy the whole read-only media
277 to the computer's RAM before mounting the root filesystem. This could need a lot
278 of ram, according to the space used by the read-only media.
280 union=**aufs**|**unionfs**::
282 By default, live-initramfs uses aufs. With this parameter, you can switch to
287 By default, Debian systems do assume that the hardware clock is set to UTC. You
288 can change or explicitly set it with this parameter.
292 Uses xdebconfigurator, if present on the rootfs, to configure X instead of the
293 standard procedure (experimental).
295 xvideomode=**RESOLUTION**::
297 Doesn't do xorg autodetection, but enforces a given resolution.
304 Some variables can be configured via this config file (inside the live system).
306 /live/filesystem.module
308 This optional file (inside the live media) contains a list of white-space or
309 carriage-return-separated file names corresponding to disk images in the "/live"
310 directory. If this file exists, only images listed here will be merged into the
311 root aufs, and they will be loaded in the order listed here. The first entry
312 in this file will be the "lowest" point in the aufs, and the last file in
313 this list will be on the "top" of the aufs, directly below /cow. Without
314 this file, any images in the "/live" directory are loaded in alphanumeric order.
316 /etc/live-persistence.binds
318 This optional file (which resides in the rootfs system, not in the live media)
319 is used as a list of directories which not need be persistent: ie. their
320 content does not need to survive reboots when using the persistence features.
322 This saves expensive writes and speeds up operations on volatile data such as
323 web caches and temporary files (like e.g. /tmp and .mozilla) which are
324 regenerated each time. This is achieved by bind mounting each listed directory
325 with a tmpfs on the original path.
331 live-snapshot(1), initramfs-tools(8), live-helper(7), live-initscripts(7),
337 Report bugs against live-initramfs
338 link:http://packages.qa.debian.org/live-initramfs[http://packages.qa.debian.org/live-initramfs].
343 More information about the Debian Live project can be found at
344 link:http://debian-live.alioth.debian.org/[http://debian-live.alioth.debian.org/] and
345 link:http://wiki.debian.org/DebianLive/[http://wiki.debian.org/DebianLive/].
350 live-initramfs is maintained by Daniel Baumann <daniel@debian.org>
351 for the Debian project.
353 live-initramfs is a fork of link:http://packages.ubuntu.com/casper/[casper].
354 casper was originally written by Tollef Fog Heen <tfheen@canonical.com>
355 and Matt Zimmerman <mdz@canonical.com>.