grml-debootstrap.8.txt

   1 grml-debootstrap(8)
   2 ===================
   3
   4 Name
   5 ----
   6 grml-debootstrap - wrapper around debootstrap for installing plain Debian
   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 very fast and easy.
  19
  20 All you have to do is adjust a few variables in the configuration file
  21 /etc/debootstrap/config or specify some command line options and invoke
  22 grml-debootstrap. If invoked without any configuration modifications or command
  23 line options a dialog based frontend will be available to control some basic
  24 configuration options.
  25
  26 A plain and base Debian system will be installed on the given device, directory
  27 or virtual image file then. Customization of this process is possible as well.
  28
  29 CAUTION: The Grml team does not take responsibility for loss of any data!
  30
  31 Options and environment variables
  32 ---------------------------------
  33
  34 *--arch* _architecture_::
  35
  36     Set target architecture you want to install. Defaults to the architecture
  37     you are currently running. If you're running an amd64 kernel and want to
  38     deploy an i386 system use this option. Note: deploying amd64 from an i386
  39     kernel does *not* work. Example: "_--arch i386_"
  40
  41 *--backportrepos*::
  42
  43     Enable Debian's Backports repository (http://backports.debian.org/) via the
  44     /etc/apt/sources.list.d/backports.list configuration file. This provides the
  45     option to install Debian packages from Debian's backports repository.
  46
  47 *--bootappend* _appendline-for-the-kernel_::
  48
  49     Specify appendline for the kernel.
  50     E.g. "_pci=nomsi_"
  51
  52 *-c*, *--config* _file_::
  53
  54     Use specified configuration file, defaults to /etc/debootstrap/config.
  55
  56 *--chroot-scripts* _directory_::
  57
  58     Execute chroot scripts from specified directory. This allows customisation
  59     of the chroot setup, the executable script(s) present in the given directory
  60     are executed at the end of the chroot procedure.
  61     Default directory: /etc/debootstrap/chroot-scripts/
  62
  63 *-d*, *--confdir* _path_::
  64
  65     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
  66
  67 *--debconf* _file_::
  68
  69     Use specified file for preseeding Debian packages instead of using
  70     the default <confdir>/debconf-selections.
  71
  72 *--debopt* _params_::
  73
  74     Extra parameters passed to the debootstrap command.
  75
  76 *--debug*::
  77
  78    Execute in very verbose way. Useful for debugging possible problems
  79    with grml-debootstrap or identify what's actually executed.
  80
  81 *--filesystem* _filesystem_::
  82
  83     Filesystem that should be created when installing to a partition.
  84     If unset defaults to ext4. Valid values are all filesystems that
  85     can be created through mkfs._filesystem_.
  86
  87 *--force*::
  88
  89     Skip user acknowledgement and do not prompt for user input.
  90
  91 *--grmlrepos*::
  92
  93     Enable Grml.org's Debian repository (http://deb.grml.org/) via the
  94     /etc/apt/sources.list.d/grml.list configuration file. This provides the
  95     option to install Debian packages from Grml's repository.
  96
  97 *--grub* _device_::
  98
  99     Device where grub should be installed to. Note that only the MBR (master
 100     boot record) can be used (/dev/sda, /dev/sdb,...). Partitions (like
 101     /dev/sda1, /dev/sdb2,...) are NOT supported because grub2 doesn't support
 102     installation into the PBR (partition boot record) anymore.  Usage example:
 103     '--grub /dev/sda'.  Note: just do not set this option to avoid installation
 104     of grub.
 105
 106 *--help*, *-h*::
 107
 108     Show summary of options and exit.
 109
 110 *--hostname* _hostname_::
 111
 112     Use specified hostname instead of the default (being $HOSTNAME or if unset 'grml').
 113
 114 *-i*, *--iso* _/mntpoint_::
 115
 116     Specify mount point where you have a Debian ISO mounted loopback.
 117     Using this option instead of the mirror option gives you the possibility
 118     to install the base-system without network access. Make sure you
 119     mounted the according Debian-ISO to the given _/mntpoint_. See section
 120     'Usage examples' for a demonstration.
 121
 122 *--keep_src_list*::
 123
 124      Do not overwrite user provided /etc/apt/sources.list.
 125
 126 *-m*, *--mirror* _URL_::
 127
 128     Specify mirror which should be used for apt-get/aptitude.
 129     Corresponding with configuration variable MIRROR.
 130
 131 *--nodebootstrap*::
 132
 133     Skip debootstrap, only do configuration to the target.
 134
 135 *--nointerfaces*::
 136
 137     Do not copy /etc/network/interfaces from host system to the target.
 138     This option is automatically enabled when using --vmfile.
 139
 140 *--nokernel*::
 141
 142     Skip installation of default kernel images. This option might be
 143     interesting for you if you want a Debian system which doesn't
 144     need to provide regular boot, e.g. a system which provides
 145     ISOs for booting via GRUB using grml-rescueboot.
 146
 147 *--nopackages*::
 148
 149     Skip installation of packages defined in /etc/debootstrap/packages.
 150
 151 *--nopassword*::
 152
 153     Do not prompt for the root password. Note: Use the '--password' option if
 154     you want to set the root password during an automatic installation but don't
 155     want to use the interactive dialog.
 156
 157 *-p*, *--mntpoint* _/mntpoint_::
 158
 159     Specify mount point that should be used for mounting the target system.
 160     Corresponding with configuration variable MNTPOINT.
 161     Note: this option has no effect if option -t is given and represents a
 162     directory.
 163
 164 *--packages* _file_::
 165
 166     Use specified file as list for packages that should be installed instead of
 167     the default package list file <confdir>/packages.
 168
 169 *--password* _password_::
 170
 171     Use specified password as password for user root. Use with caution, as your
 172     command line might be visible in the process list and the shell history.
 173     It's meant for automatic installation only.
 174
 175 *-r*, *--release* _releasename_::
 176
 177     Specify release of new Debian system. Supported releases names: lenny,
 178     squeeze, wheezy (note: requires current version of debootstrap) and sid.
 179     Corresponding with configuration variable RELEASE.
 180
 181 *--pre-scripts* _directory_::
 182
 183     Execute scripts from specified directory before executing the chroot
 184     script. This allows customisation of the system before the chroot has
 185     been set up.  The environment variable $MNTPOINT is available inside the
 186     scripts for direct access of the chroot.
 187     Default directory: /etc/debootstrap/pre-scripts/
 188
 189 *--scripts* _directory_::
 190
 191     Execute scripts from specified directory. This allows customisation of
 192     the system after the chroot has been set up. The environment variable
 193     $MNTPOINT is available inside the scripts for direct access of the chroot.
 194     Default directory: /etc/debootstrap/scripts/
 195
 196 *-t*, *--target* _target_::
 197
 198     Target partition (/dev/...) or directory (anything else without /dev at the
 199     beginning).
 200
 201 *-v*, *--verbose*::
 202
 203     Increase verbosity.
 204
 205 *--vmfile*::
 206
 207     Set up a Virtual Machine instead of installing to a partition or directory.
 208     This allows deployment of a Virtual Machine. The options needs to be
 209     combined with the --target option.
 210     Usage example: --vmfile --target /mnt/sda1/qemu.img
 211
 212 *--vmsize* _size_::
 213
 214    Use specified size for size of Virtual Machine disk file. If not specified it
 215    defaults to 2G (being 2GB). Syntax as supported by qemu-img (see manpage
 216    qemu-img(1) for details.
 217    Usage example: --vmsize 3G
 218
 219 *-V*, *--version*::
 220
 221     Show version of program and exit.
 222
 223 WARNING: the command line parsing of grml-debootstrap usually does not validate
 224 the provided arguments for the command line options. Please be careful and check
 225 docs and /etc/debootstrap/config for further information.
 226
 227 Usage examples
 228 ---------------
 229
 230   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 231
 232 Install default Debian release (wheezy) on /dev/sda1 and install bootmanager
 233 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 234
 235   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
 236
 237 Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
 238 (master boot record) of /dev/sda and use /dev/sda6 as system partition.
 239
 240   mount /dev/sda1 /data/chroot
 241   grml-debootstrap --target /data/chroot
 242
 243 Install default Debian release (wheezy) in directory /data/chroot (without
 244 any bootloader).
 245
 246   grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
 247
 248 Install default debian release (wheezy) in a Virtual Machine file with
 249 3GB disk size (including Grub as bootmanager in MBR of the virtual disk file):
 250
 251   mount /dev/sda1 /mnt/sda1
 252   grml-debootstrap --vmfile --vmsize 3G --target /mnt/sda1/qemu.img
 253
 254 Install default Debian release (wheezy) on /dev/sda3 and install bootmanager
 255 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 256 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 257
 258   mount -o loop /mnt/sda6/debian-CD-1.iso /mnt/iso
 259   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
 260
 261 Install Debian on /dev/sda1 using the loopback mounted Debian-ISO
 262 for the base-system and install bootmanager Grub in MBR (master boot record) of
 263 /dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
 264 system requires network access for all packages which are not part of the
 265 ISO.
 266
 267 Files
 268 -----
 269
 270   /etc/debootstrap/config
 271
 272 Main configuration file. Adjust it according to your needs if you want to
 273 execute grml-debootstrap in the non-interactive mode without any special command
 274 line arguments.
 275
 276   /etc/debootstrap/chroot-script
 277
 278 The script executed within the new Debian system as soon as the main system
 279 has been installed via [c]debootstrap.
 280
 281   /etc/debootstrap/locale.gen
 282
 283 Defines the default locales used for generating locales via locale-gen.
 284
 285   /etc/debootstrap/packages
 286
 287 Defines the software packages which should be installed in the new
 288 Debian system by default.
 289
 290   /etc/debootstrap/extrapackages/
 291
 292 Debian Packages dropped in this directory will be installed into the new Debian
 293 system by default (Control variable: EXTRAPACKAGES)
 294
 295 Customization
 296 -------------
 297
 298 You can control execution of grml-debootstrap via adjusting
 299 /etc/debootstrap/config for some main stuff or via setting some selected
 300 variables via command line.  The packages which should be installed in the new
 301 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 302 want to put existing files to the new Debian system you can place them into the
 303 (by default non-existing) directories boot, etc, share, usr and var in
 304 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 305 system then. If you want to install additional packages that are not available
 306 via the Grml or Debian mirror drop them into /etc/debootstrap/extrapackages and
 307 make sure that EXTRAPACKAGES is set to "yes".
 308
 309 Automatic installation
 310 ----------------------
 311
 312 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
 313 full automatic mode. While this mode isn't really useful for interactive
 314 execution (just configure /etc/debootstrap/configure or specify the relevant
 315 variables on the command line instead) it is meant for use via boot option
 316 debian2hd on the Grml live system. The boot option debian2hd (more precise: the
 317 kernelname at the bootprompt) supports the following boot options (they
 318 correspond with the command line options mentioned above):
 319
 320   target=...
 321
 322 The target partition/directory of the new Debian system. Usage example:
 323 target=/dev/sda1
 324
 325   grub=...
 326
 327 Where do you want to install grub to? Usage example: grub=/dev/sda
 328
 329   release=...
 330
 331 Specify release of new Debian system. Defaults to Debian wheezy. Supported
 332 relases: lenny, squeeze, wheezy and sid. Usage example: release=sid
 333
 334   mirror=...
 335
 336 Specify mirror which should be used for apt-get/aptitude instead
 337 of the default one (http://http.debian.net/debian).
 338 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 339
 340   password=...
 341
 342 Set password of user root without prompting for it but set it to the given
 343 argument. Usage example: password=AiTh5ahn
 344
 345 Usage example for automatic installation
 346 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 347
 348   debian2hd target=/dev/sda1 grub=/dev/sda mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
 349
 350 You have to enter this command line at the bootprompt of the Grml live system.
 351 Please make sure that /dev/sda1 is the partition where you really want to
 352 install your new Debian system.
 353
 354 [NOTE]
 355 Automatic installation within booting process is done in grml-autoconfig via
 356 setting environment variable AUTOINSTALL and creation of
 357 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
 358 boot options for grml-debootstrap.
 359
 360 Supported Releases
 361 ------------------
 362
 363 include::releasetable.txt[]
 364
 365 [NOTE]
 366 .lenny release
 367 ================================================================================
 368 [1] Please notice that lenny is an unsupported release within Debian nowadays.
 369 grml-debootstrap can handle the release but you really should not use lenny
 370 anymore unless you really know what you are doing. Choose Debian 6.0 (squeeze)
 371 or Debian 7.0 (wheezy) instead.
 372
 373 Notice that you need to specify a mirror providing the lenny release, the
 374 default (http://http.debian.net/debian) doesn't provide it any longer nowadays.
 375 Set the mirror to e.g. http://archive.debian.org/debian/ if you don't have
 376 your own lenny mirror.
 377
 378 When installing lenny to a new mdraid, grml-debootstrap will use md metadata
 379 format version 0.90. This limits the device to a maximum size of 2TB, but has
 380 the advantage of grub-legacy actually being able to boot from it.
 381 ================================================================================
 382
 383 [NOTE]
 384 .unstable and testing releases
 385 ================================================================================
 386 [2] Please notice that jessie (Debian/testing) and sid (Debian/unstable) might
 387 not be always installable due to their nature. What _might_ work instead is
 388 deploying a stable release and upgrade it after installation finished.
 389 ================================================================================
 390
 391 Bugs
 392 ----
 393
 394 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 395
 396 See also
 397 --------
 398
 399 debootstrap (8), cdebootstrap (1).
 400
 401 Author
 402 ------
 403 Michael Prokop <mika@grml.org>