manpages/en/live-boot.7

   1 .TH LIVE\-BOOT 7 2010\-08\-10 3.0~a1 "Debian Live Project"
   2
   3 .SH NAME
   4 \fBlive\-boot\fR \- System Boot Scripts
   5
   6 .SH DESCRIPTION
   7 \fBlive\-boot\fR contains the scripts that configure a Debian 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 Debian Live isos, netboot tarballs, and usb stick images.
  11 .PP
  12 At boot time it will look for a (read\-only) media 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, for Debian like systems to boot from.
  13 .\" FIXME
  14
  15 .SH CONFIGURATION
  16 \fBlive\-boot\fR can be configured through a boot parameter or a configuration file.
  17
  18 .SS Kernel Parameters
  19 \fBlive\-boot\fR is only activated if 'boot=live' was used as a kernel parameter.
  20 .PP
  21 In addition, there are some more boot parameters to influence the behaviour, see below.
  22
  23 .SS Configuration Files
  24 \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.conf.d/), or on the live media (live/boot.conf, live/boot.conf.d/).
  25
  26 .SH OPTIONS
  27 \fBlive\-boot\fR currently features the following parameters.
  28 .\" FIXME
  29 .IP "\fBaccess\fR=\fIACCESS\fR" 4
  30 Set the accessibility level for physically or visually impared 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.
  31 .IP "\fBconsole\fR=\fITTY,SPEED\fR" 4
  32 Set the default console to be used with the "live\-getty" option. Example: "console=ttyS0,115200"
  33 .IP "\fBdebug\fR" 4
  34 Makes initramfs boot process more verbose.
  35 .br
  36 Use: debug=1
  37 .br
  38 Without setting debug to a value the messages may not be shown.
  39 .IP "\fBfetch\fR=\fIURL\fR" 4
  40 .IP "\fBhttpfs\fR=\fIURL\fR" 4
  41 Another form of netboot by downloading a squashfs image from a given url.
  42 The fetch method copies the image to ram and the httpfs method uses fuse and
  43 httpfs2 to mount the image in place. Copying to ram requires more memory and
  44 might take a long time for large images. However, it is more likely to work
  45 correctly because it does not require networking afterwards and the system
  46 operates faster once booted because it does not require to contact the server
  47 anymore.
  48 .br
  49 Due to current limitations in busyboxs wget and DNS resolution, an URL can not contain a hostname but an IP only.
  50 .br
  51 Not working: http://example.com/path/to/your_filesystem.squashfs
  52 .br
  53 Working: http://1.2.3.4/path/to/your_filesystem.squashfs
  54 .br
  55 Also note that therefore it's currently not possible to fetch an image from a namebased virtualhost of an httpd if it is sharing the ip with the main httpd instance.
  56 .br
  57 You may also use the live iso image in place of the squashfs image.
  58 .IP "\fBiscsi\fR=\fIserver-ip[,server-port];target-name\fR" 4
  59 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 media. If you use the \fBiscsitarget\fR software iSCSI target solution which is packaged in Debian your ietd.conf might look like this:
  60 .br
  61 # The target-name you specify in the iscsi= parameter
  62 .br
  63 Target <target-name>
  64   Lun 0 Path=<path-to-your-live-image.iso>,Type=fileio,IOMode=ro
  65   # If you want to boot multiple machines you might want to look at tuning some parameters like
  66   # Wthreads or MaxConnections
  67 .IP "\fBfromiso\fR=\fI/PATH/TO/IMAGE\fI" 4
  68 Allows to use a filesystem from within an iso image that's available on live-media.
  69 .IP "\fBignore_uuid\fR" 4
  70 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.
  71 .IP "\fBintegrity\-check\fR" 4
  72 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.
  73 .IP "\fBip\fR=[\fICLIENT_IP\fR]:[\fISERVER_IP\fR]:[\fIGATEWAY_IP\fR]:[\fINETMASK\fR]:[\fIHOSTNAME\fR]:[\fIDEVICE\fR]:[\fIAUTOCONF\fR] [,[\fICLIENT_IP\fR]:[\fISERVER_IP\fR]:[\fIGATEWAY_IP\fR]:[\fINETMASK\fR]:[\fIHOSTNAME\fR]:[\fIDEVICE\fR]:[\fIAUTOCONF\fR]]" 4
  74 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 mimick official kernel boot param specification (e.g. ip=10.0.0.1::10.0.0.254:255.255.255.0::eth0,:::::eth1:dhcp).
  75 .IP "\fBip\fR=[\fIfrommedia\fR]" 4
  76 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.
  77 .IP "{\fBlive\-media\fR|\fBbootfrom\fR}=\fIDEVICE\fR" 4
  78 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.
  79 .br
  80 Instead of specifing 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.
  81 .IP "{\fBlive\-media\-encryption\fR|\fBencryption\fR}=\fITYPE\fI" 4
  82 live\-boot will mount the encrypted rootfs TYPE, asking the passphrase, useful to build paranoid live systems :\-). TYPE supported so far are "aes" for loop\-aes encryption type.
  83 .IP "\fBlive\-media\-offset\fR=\fIBYTES\fR" 4
  84 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 Debian Live iso or image inside another iso or image, to create "clean" images.
  85 .IP "\fBlive\-media\-path\fR=\fIPATH\fR" 4
  86 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.
  87 .IP "\fBlive\-media\-timeout\fR=\fISECONDS\fI" 4
  88 Set the timeout in seconds for the device specified by "live\-media=" to become ready before giving up.
  89 .IP "\fBmodule\fR=\fINAME\fR" 4
  90 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.
  91 .IP "\fBnetboot\fR[=nfs|cifs]" 4
  92 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.
  93 .IP "\fBnfsopts\fR=" 4
  94 This lets you specify custom nfs options.
  95 .IP "\fBnofastboot\fR" 4
  96 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.
  97 .IP "\fBnopersistent\fR" 4
  98 disables the "persistent" feature, useful if the bootloader (like syslinux) has been installed with persistent enabled.
  99 .IP "\fBnoprompt\fR" 4
 100 Do not prompt to eject the CD or remove the USB flash drive on reboot.
 101 .IP "\fBswapon\fR" 4
 102 This parameter enables usage of local swap partitions.
 103 .IP "\fBpersistent\fR[=nofiles]" 4
 104 live\-boot will look for persistent and snapshot partitions or files labeled "live\-rw", "home\-rw", and files called "live\-sn*", "home\-sn*" and will try to, in order: mount as /cow the first, mount the second in /home, and just copy the contents of the latter in appropriate locations (snapshots). Snapshots will be tried to be updated on reboot/shutdown. Look at live\-snapshot(1) for more informations. If "nofiles" is specified, only filesystems with matching labels will be searched; no filesystems will be traversed looking for archives or image files. This results in shorter boot times.
 105 .IP "\fBpersistent\-path\fR=\fIPATH\fR" 4
 106 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.
 107 .IP "{\fBpreseed/file\fR|\fBfile\fR}=\fIFILE\fR" 4
 108 A path to a file present on the rootfs could be used to preseed debconf database.
 109 .IP "\fBpackage/question\fR=\fIVALUE\fR" 4
 110 All debian installed packages could be preseeded from command\-line that way, beware of blanks spaces, they will interfere with parsing, use a preseed file in this case.
 111 .IP "\fBquickreboot\fR" 4
 112 This option causes live\-boot to reboot without attempting to eject the media and without asking the user to remove the boot media.
 113 .IP "\fBshowmounts\fR" 4
 114 This parameter will make live\-boot to show on "/" the ro filesystems (mostly compressed) on "/live". This is not enabled by default because could lead to problems by applications like "mono" which store binary paths on installation.
 115 .IP "\fBsilent\fR" 4
 116 If you boot with the normal quiet parameter, live\-boot hides most messages of its own. When adding silent, it hides all.
 117 .IP "\fBtodisk\fR=\fIDEVICE\fR" 4
 118 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.
 119 .IP "\fBtoram\fR" 4
 120 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.
 121 .IP "\fBunion\fR=aufs|unionfs\fR" 4
 122 By default, live\-boot uses aufs. With this parameter, you can switch to unionfs.
 123 .\" FIXME
 124
 125 .\" FIXME
 126 .SH FILES (old)
 127 .IP "\fB/etc/live.conf\fR" 4
 128 Some variables can be configured via this config file (inside the live system).
 129 .IP "\fBlive/filesystem.module\fR" 4
 130 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 /cow.  Without this file, any images in the "/live" directory are loaded in alphanumeric order.
 131 .IP "\fB/etc/live\-persistence.binds\fR" 4
 132 This optional file (which resides in the rootfs system, not in the live media) is used as a list of directories which not need be persistent: ie. their content does not need to survive reboots when using the persistence features.
 133 .br
 134 This saves expensive writes and speeds up operations on volatile data such as web caches and temporary files (like e.g. /tmp and .mozilla) which are regenerated each time. This is achieved by bind mounting each listed directory with a tmpfs on the original path.
 135 .\" FIXME
 136
 137 .SH FILES
 138 .IP "\fB/etc/live/boot.conf\fR" 4
 139 .IP "\fB/etc/live/boot.conf.d/\fR" 4
 140 .IP "\fBlive/boot.conf\fR" 4
 141 .IP "\fBlive/boot.conf.d/\fR" 4
 142
 143 .SH SEE ALSO
 144 \fIlive\-snapshot\fR(1)
 145 .PP
 146 \fIlive\-config\fR(7)
 147 .PP
 148 \fIlive\-helper\fR(7)
 149
 150 .SH HOMEPAGE
 151 More information about live\-boot and the Debian Live project can be found on the homepage at <\fIhttp://live.debian.net/\fR> and in the manual at <\fIhttp://live.debian.net/manual/\fR>.
 152
 153 .SH BUGS
 154 Bugs can be reported by submitting a bugreport for the live\-boot package in the Debian Bug Tracking System at <\fIhttp://bugs.debian.org/\fR> or by writing a mail to the Debian Live mailing list at <\fIdebian-live@lists.debian.org\fR>.
 155
 156 .SH AUTHOR
 157 live\-boot was written by Daniel Baumann <\fIdaniel@debian.org\fR> for the Debian project.