grml-debootstrap.8.txt

   1 grml-debootstrap(8)
   2 ===================
   3
   4 Name
   5 ----
   6 grml-debootstrap - wrapper around debootstrap for installing plain Debian via grml
   7
   8 Synopsis
   9 --------
  10 grml-debootstrap [ _options_ ]
  11
  12 image:images/screenshot.png[Screenshot]
  13
  14 Introduction
  15 ------------
  16
  17 grml-debootstrap is a wrapper suite around debootstrap (and cdebootstrap if you
  18 want) for installing a plain Debian system via grml very fast and easy.
  19
  20 All you have to do is adjust a few variables in configuration file
  21 /etc/debootstrap/config (or specify some variables via commandline) and invoke
  22 grml-debootstrap without any further options then.
  23
  24 A plain and base Debian system will be installed on the given device (or
  25 directory) then. Customization of this process is possible as well.
  26
  27 CAUTION: The grml team does not take responsibility for loss of any data!
  28
  29 Options and environment variables
  30 ---------------------------------
  31
  32 *--bootappend* <_appendline for the kernel_>::
  33
  34     Specify appendline for the kernel.
  35     E.g. "_pci=nomsi_"
  36
  37 *-c*, *--config* <_file_>::
  38
  39     Use specified configuration file, defaults to /etc/debootstrap/config.
  40
  41 *--chroot-scripts* <_directory_>::
  42
  43     Execute chroot scripts from specified directory. This allows customisation
  44     of the chroot setup, the executable script(s) present in the given directory
  45     are executed at the end of the chroot procedure.
  46     Default directory: /etc/debootstrap/chroot-scripts/
  47
  48 *-d*, *--confdir* <_path_>::
  49
  50     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
  51
  52 *--debconf* <_file_>::
  53
  54     Use specified file for preseeding Debian packages instead of using
  55     the default <confdir>/debconf-selections.
  56
  57 *--debopt* <_params_>::
  58
  59     Extra parameters passed to the debootstrap command.
  60
  61 *--groot* <_device_>::
  62
  63     Specify root device for usage in grub (corresponds with $TARGET).
  64     Again, use grub syntax for specifying.
  65     Corresponding with configuration variable GROOT.
  66
  67 *--grub* <_device_>::
  68
  69     Where do you want to install grub to? Use grub syntax for specifying.
  70     Do not forget to set groot as well. Leave empty to avoid installation of grub.
  71
  72 *--help*, *-h*::
  73
  74     Show summary of options and exit.
  75
  76 *--hostname* <_hostname_>::
  77
  78     Use specified hostname instead of the default (being 'grml').
  79
  80 *-i*, *--iso* <_/mntpoint_>::
  81
  82     Specify mountpoint where you have a Debian ISO mounted loopback.
  83     Using this option instead of the mirror option gives you the possibility
  84     to install the base-system without network access. Make sure you
  85     mounted the according Debian-ISO to the given <_/mntpoint_>. See section
  86     'Usage examples' for a demonstration.
  87
  88 *--keep_src_list*::
  89
  90      Do not overwrite user provided /etc/apt/sources.list.
  91
  92 *-m*, *--mirror* <_URL_>::
  93
  94     Specify mirror which should be used for apt-get/aptitude.
  95     Corresponding with configuration variable MIRROR.
  96
  97 *--nodebootstrap*::
  98
  99     Skip debootstrap, only do configuration to the target.
 100
 101 *-p*, *--mntpoint* <_/mntpoint_>::
 102
 103     Specify mountpoint that should be used for mounting the target system.
 104     Corresponding with configuration variable MNTPOINT.
 105     Note: this option has no effect if option -t is given and represents a
 106     directory.
 107
 108 *--packages* <_file_>::
 109
 110     Use specified file as list for packages that should be installed instead of
 111     the default package list file <confdir>/packages.
 112
 113 *--password* <_password_>::
 114
 115     Use specified password as password for user root. Use with caution, as your
 116     commandline might be visible in the process list and the shell history.
 117     It's meant for automatic installation only.
 118
 119 *-r*, *--release* <_releasename_>::
 120
 121     Specify release of new Debian system. Supported releases names: etch, lenny,
 122     squeeze (note: requires current version of debootstrap) and sid.
 123     Corresponding with configuration variable RELEASE.
 124
 125 *--scripts* <_directory_>::
 126
 127     Execute scripts from specified directory. This allows customisation of
 128     the system after the chroot has been set up. The environment variable
 129     $MNTPOINT is available inside the scripts for direct access of the chroot.
 130     Default directory: /etc/debootstrap/scripts/
 131
 132 *-t*, *--target* <_target_>::
 133     Target partition (/dev/...) or directory (anything else without /dev at the
 134     beginning). To install grub using *--grub* and *--groot*, make sure to
 135     use a _device_ instead of a directory as _target_ (installation of
 136     grub as bootloader when using directories is NOT supported).
 137
 138 *-v*, *--verbose*::
 139     Increase verbosity.
 140
 141 *-V*, *--version*::
 142     Show version of program and exit.
 143
 144 WARNING: the commandline parsing of grml-debootstrap does not validate the provided
 145 arguments for the commandline options. Please be careful and check docs and
 146 /etc/debootstrap/config for further information.
 147
 148 Usage examples
 149 ---------------
 150
 151   grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0
 152
 153 Install default Debian release (stable/lenny) on /dev/sda1 and install bootmanager
 154 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 155
 156   grml-debootstrap --target /dev/sda6 --grub hd0 --groot hd0,5 --release sid
 157
 158 Install Debian unstable/sid on /dev/sda6, install bootmanager
 159 Grub in MBR (master boot record) of /dev/sda and use /dev/sda6 as system partition.
 160
 161   mount /dev/sda1 /data/chroot
 162   grml-debootstrap --target /data/chroot
 163
 164 Install default Debian release (stable/lenny) in directory /data/chroot (without
 165 any bootloader).
 166
 167   grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
 168
 169 Install default Debian release (stable/lenny) on /dev/sda3 and install bootmanager
 170 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 171 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 172
 173   mount -o loop /mnt/sda6/debian-40r0-i386-CD-1.iso /mnt/iso
 174   grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0 --iso file:/mnt/iso/debian/
 175
 176 Install Debian stable/lenny on /dev/sda1 using the loopback mounted Debian-ISO
 177 for the base-system and install bootmanager Grub in MBR (master boot record) of
 178 /dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
 179 system requires network access for all packages which are not part of the
 180 ISO.
 181
 182 Files
 183 -----
 184
 185   /etc/debootstrap/config
 186
 187 Main configuration file. You have to adjust it according to your needs
 188 before you are able to run grml-debootstrap.
 189
 190   /etc/debootstrap/chroot-script
 191
 192 The script executed within the new Debian system as soon as the main system
 193 has been installed via [c]debootstrap.
 194
 195   /etc/debootstrap/locale.gen
 196
 197 Defines the default locales used for generating locales via locale-gen.
 198
 199   /etc/debootstrap/packages
 200
 201 Defines the software packages which should be installed in the new
 202 Debian system by default.
 203
 204   /etc/debootstrap/extrapackages
 205
 206 Debian Packages dropped here will be installed into the new Debian system by
 207 default (Controlvariable: EXTRAPACKAGES)
 208
 209   /etc/debootstrap/stages/
 210
 211 The default directory for storing information about executed stages. Every
 212 single function of grml-debootstrap will write 'done' to the stages directory
 213 into a file named as the function itself if it has been executed successfully.
 214 You can adjust the location of the directory via configuration variable STAGES
 215 via /etc/debootstrap/config.  Please notice that you have to remove the stages
 216 directory on your own if you want to re-execute grml-debootstrap after running it
 217 successfully once. This should avoid recurrent execution by error of
 218 grml-debootstrap (which might delete present data).
 219
 220 Customization
 221 -------------
 222
 223 You can control execution of grml-debootstrap via adjusting
 224 /etc/debootstrap/config for some main stuff or via setting some selected
 225 variables via commandline.  The packages which should be installed in the new
 226 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 227 want to put existing files to the new Debian system you can place them into the
 228 (by default non-existing) directories boot, etc, share, usr and var in
 229 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 230 system then. If you want to install additional packages that are not available
 231 via the grml or debian mirror drop them into /etc/debootstrap/extrapackages and
 232 make sure that EXTRAPACKAGES is set to "yes".
 233
 234 Automatic installation
 235 ----------------------
 236
 237 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
 238 full automatic mode. While this mode isn't really useful for interactive
 239 execution (just configure /etc/debootstrap/configure or specify the relevant
 240 variables on the commandline instead) it is meant for use via bootoption
 241 debian2hd. The bootoption debian2hd (more precise: the kernelname on bootprompt)
 242 supports the following bootoptions (they correspond with the commandline options
 243 mentioned above):
 244
 245   target=...
 246
 247 The target partition/directory of the new Debian system. Usage example:
 248 target=/dev/sda1
 249
 250   grub=...
 251
 252 Where do you want to install grub to? Use grub syntax for specifying.
 253 Usage example: grub=hd0
 254
 255   groot=...
 256
 257 Specify root device for usage in grub (corresponds with $TARGET).
 258 Again, use grub syntax for specifying. Usage example: groot=hd0,0
 259
 260   release=...
 261
 262 Specify release of new Debian system. Defaults to Debian stable.  Supported
 263 relases: etch, lenny, squeeze and sid. Usage example: release=sid
 264
 265   mirror=...
 266
 267 Specify mirror which should be used for apt-get/aptitude instead
 268 of the default one (ftp://ftp.debian.de/debian).
 269 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 270
 271   password=...
 272
 273 Set password of user root without prompting for it but set it to the given
 274 argument. Usage example: password=AiTh5ahn
 275
 276 Usage example for automatic installation:
 277 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 278
 279   debian2hd target=/dev/sda1 grub=hd0 groot=hd0,0 mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
 280
 281 You have to enter this commandline at the bootprompt of grml. Please make sure
 282 that /dev/sda1 is the partition where you really want to install your new Debian
 283 system.
 284
 285 [NOTE]
 286 Automatic installation within booting process is done in grml-autoconfig via
 287 setting environment variable AUTOINSTALL and creation of
 288 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
 289 bootoptions for grml-debootstrap.
 290
 291 Supported Releases
 292 ------------------
 293
 294 include::releasetable.txt[]
 295
 296 [NOTE]
 297 .Etch-Release
 298 ================================================================================
 299 [1] Please notice that Etch is the current old-stable within Debian.
 300 grml-debootstrap can handle the release but you really should not use Etch
 301 anymore unless you really know what you are doing. Choose Lenny instead.
 302 ================================================================================
 303
 304 Bugs
 305 ----
 306
 307 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 308
 309 See also
 310 --------
 311
 312 debootstrap (8), cdebootstrap (1).
 313
 314 Author
 315 ------
 316 Michael Prokop <mika@grml.org>