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 --vm or --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, jessie (note: requires a recent version of debootstrap)
 179     and sid. 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 *--vm*::
 206
 207     Set up a Virtual Machine on an existing block device, which will be
 208     partitioned.
 209     This allows deployment of a Virtual Machine. The options needs to be
 210     combined with the --target option.
 211     Usage example: --vm --target /dev/mapper/your-vm-disk
 212
 213 *--vmfile*::
 214
 215     Set up a Virtual Machine instead of installing to a partition or directory.
 216     This allows deployment of a Virtual Machine. The options needs to be
 217     combined with the --target option.
 218     Usage example: --vmfile --target /mnt/sda1/qemu.img
 219
 220 *--vmsize* _size_::
 221
 222    Use specified size for size of Virtual Machine disk file. If not specified it
 223    defaults to 2G (being 2GB). Syntax as supported by qemu-img (see manpage
 224    qemu-img(1) for details.
 225    Usage example: --vmsize 3G
 226
 227 *-V*, *--version*::
 228
 229     Show version of program and exit.
 230
 231 WARNING: the command line parsing of grml-debootstrap usually does not validate
 232 the provided arguments for the command line options. Please be careful and check
 233 docs and /etc/debootstrap/config for further information.
 234
 235 Usage examples
 236 ---------------
 237
 238   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 239
 240 Install default Debian release (jessie) on /dev/sda1 and install bootmanager
 241 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 242
 243   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
 244
 245 Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
 246 (master boot record) of /dev/sda and use /dev/sda6 as system partition.
 247
 248   mount /dev/sda1 /data/chroot
 249   grml-debootstrap --target /data/chroot
 250
 251 Install default Debian release (jessie) in directory /data/chroot (without
 252 any bootloader).
 253
 254   grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
 255
 256 Install default debian release (jessie) in a Virtual Machine file with
 257 3GB disk size (including Grub as bootmanager in MBR of the virtual disk file):
 258
 259   mount /dev/sda1 /mnt/sda1
 260   grml-debootstrap --vmfile --vmsize 3G --target /mnt/sda1/qemu.img
 261
 262 Install default Debian release (jessie) on /dev/sda3 and install bootmanager
 263 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 264 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 265
 266   mount -o loop /mnt/sda6/debian-CD-1.iso /mnt/iso
 267   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
 268
 269 Install Debian on /dev/sda1 using the loopback mounted Debian-ISO
 270 for the base-system and install bootmanager Grub in MBR (master boot record) of
 271 /dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
 272 system requires network access for all packages which are not part of the
 273 ISO.
 274
 275 Files
 276 -----
 277
 278   /etc/debootstrap/config
 279
 280 Main configuration file. Adjust it according to your needs if you want to
 281 execute grml-debootstrap in the non-interactive mode without any special command
 282 line arguments.
 283
 284   /etc/debootstrap/chroot-script
 285
 286 The script executed within the new Debian system as soon as the main system
 287 has been installed via [c]debootstrap.
 288
 289   /etc/debootstrap/locale.gen
 290
 291 Defines the default locales used for generating locales via locale-gen.
 292
 293   /etc/debootstrap/packages
 294
 295 Defines the software packages which should be installed in the new
 296 Debian system by default.
 297
 298   /etc/debootstrap/extrapackages/
 299
 300 Debian Packages dropped in this directory will be installed into the new Debian
 301 system by default (Control variable: EXTRAPACKAGES)
 302
 303 Customization
 304 -------------
 305
 306 You can control execution of grml-debootstrap via adjusting
 307 /etc/debootstrap/config for some main stuff or via setting some selected
 308 variables via command line.  The packages which should be installed in the new
 309 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 310 want to put existing files to the new Debian system you can place them into the
 311 (by default non-existing) directories boot, etc, share, usr and var in
 312 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 313 system then. If you want to install additional packages that are not available
 314 via the Grml or Debian mirror drop them into /etc/debootstrap/extrapackages and
 315 make sure that EXTRAPACKAGES is set to "yes".
 316
 317 Automatic installation
 318 ----------------------
 319
 320 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
 321 full automatic mode. While this mode isn't really useful for interactive
 322 execution (just configure /etc/debootstrap/configure or specify the relevant
 323 variables on the command line instead) it is meant for use via boot option
 324 debian2hd on the Grml live system. The boot option debian2hd (more precise: the
 325 kernelname at the bootprompt) supports the following boot options (they
 326 correspond with the command line options mentioned above):
 327
 328   target=...
 329
 330 The target partition/directory of the new Debian system. Usage example:
 331 target=/dev/sda1
 332
 333   grub=...
 334
 335 Where do you want to install grub to? Usage example: grub=/dev/sda
 336
 337   release=...
 338
 339 Specify release of new Debian system. Defaults to Debian jessie. Supported
 340 relases: lenny, squeeze, wheezy, jessie and sid. Usage example: release=sid
 341
 342   mirror=...
 343
 344 Specify mirror which should be used for apt-get/aptitude instead
 345 of the default one (http://http.debian.net/debian).
 346 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 347
 348   password=...
 349
 350 Set password of user root without prompting for it but set it to the given
 351 argument. Usage example: password=AiTh5ahn
 352
 353 Usage example for automatic installation
 354 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 355
 356   debian2hd target=/dev/sda1 grub=/dev/sda mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
 357
 358 You have to enter this command line at the bootprompt of the Grml live system.
 359 Please make sure that /dev/sda1 is the partition where you really want to
 360 install your new Debian system.
 361
 362 [NOTE]
 363 Automatic installation within booting process is done in grml-autoconfig via
 364 setting environment variable AUTOINSTALL and creation of
 365 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
 366 boot options for grml-debootstrap.
 367
 368 Supported Releases
 369 ------------------
 370
 371 include::releasetable.txt[]
 372
 373 [NOTE]
 374 .lenny release
 375 ================================================================================
 376 [1] Please notice that lenny is an unsupported release within Debian nowadays.
 377 grml-debootstrap can handle the release but you really should not use lenny
 378 anymore unless you really know what you are doing. Choose Debian 7.0 (wheezy) or
 379 something newer instead.
 380
 381 Notice that you need to specify a mirror providing the lenny release, the
 382 default (http://http.debian.net/debian) doesn't provide it any longer nowadays.
 383 Set the mirror to e.g. http://archive.debian.org/debian/ if you don't have
 384 your own lenny mirror.
 385
 386 Also when debootstrapping lenny on a live system with a kernel version
 387 like "3.16-1-grml-amd64" lenny's libc will fail to install with:
 388
 389    [...]
 390    /var/lib/dpkg/tmp.ci/preinst: line 265: [: 3.16-1-grml-amd64: integery expression expected
 391    /var/lib/dpkg/tmp.ci/preinst: line 231: 3.16-1-grml-amd64: syntax error: invalid arithemtic operator (error token is ".16-1-grml-amd64")
 392    dpkg: error processing /var/cache/apt/archives/libc6_2.7-18lenny7_amd64.deb (--install):
 393    [....]
 394
 395 To workaround this either debootstrap from a system with an according
 396 kernel version or use the "fake uname" workaround (just google for it).
 397
 398 When installing lenny to a new mdraid, grml-debootstrap will use md metadata
 399 format version 0.90. This limits the device to a maximum size of 2TB, but has
 400 the advantage of grub-legacy actually being able to boot from it.
 401 ================================================================================
 402
 403 [NOTE]
 404 .unstable and testing releases
 405 ================================================================================
 406 [2] Please notice that Debian/testing and Debian/unstable (sid) might
 407 not be always installable due to their nature. What _might_ work instead is
 408 deploying a stable release and upgrade it after installation finished.
 409 ================================================================================
 410
 411 Bugs
 412 ----
 413
 414 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 415
 416 See also
 417 --------
 418
 419 debootstrap (8), cdebootstrap (1).
 420
 421 Author
 422 ------
 423 Michael Prokop <mika@grml.org>