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 and mmdebstrap 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 front end 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 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 *--contrib*::
  64
  65     Enable the 'contrib' repository in COMPONENTS. By default only
  66     the 'main' repository is enabled.
  67
  68 *-d*, *--confdir* _path_::
  69
  70     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
  71
  72 *--debconf* _file_::
  73
  74     Use specified file for preseeding Debian packages instead of using
  75     the default <confdir>/debconf-selections.
  76
  77 *--debopt* _params_::
  78
  79     Extra parameters passed to the debootstrap command.
  80
  81 *--debug*::
  82
  83    Execute in very verbose way. Useful for debugging possible problems
  84    with grml-debootstrap or identify what's actually executed.
  85
  86 *--defaultinterfaces*::
  87
  88    Install a default /etc/network/interfaces file (enabling DHCP for all local
  89    Ethernet, WLAN and WWAN interfaces using predictable network interface names
  90    and using eth0 as traditional interface name for backward compatibility)
  91    instead of taking over config from host system.
  92    This option is automatically enabled when using --vm or --vmfile.
  93
  94 *--efi* _device_::
  95
  96     Partition where EFI boot manager should be installed to. If the
  97     specified device doesn't use a FAT filesystem yet grml-debootstrap
  98     automatically creates the filesystem. If a FAT filesystem is already
  99     present the filesystem creation is skipped. Please ensure that it's
 100     a valid FAT32 filesystem and the partition has the 'boot' and 'esp'
 101     flags enabled. This option requires EFI support on the running system
 102     and the option is NOT supported for Virtual Machine deployments.
 103
 104 *--filesystem* _filesystem_::
 105
 106     Filesystem that should be created when installing to a partition.
 107     If unset defaults to ext4. Valid values are all filesystems that
 108     can be created through mkfs._filesystem_.
 109
 110 *--force*::
 111
 112     Skip user acknowledgement and do not prompt for user input.
 113
 114 *--grmlrepos*::
 115
 116     Enable Grml.org's Debian repository (http://deb.grml.org/) via the
 117     /etc/apt/sources.list.d/grml.list configuration file. This provides the
 118     option to install Debian packages from Grml's repository.
 119
 120 *--grub* _device_::
 121
 122     Device where grub should be installed to. Note that only the MBR (master
 123     boot record) can be used (/dev/sda, /dev/sdb,...). Partitions (like
 124     /dev/sda1, /dev/sdb2,...) are NOT supported because grub2 doesn't support
 125     installation into the PBR (partition boot record) anymore.  Usage example:
 126     '--grub /dev/sda'.  Note: just do not set this option to avoid installation
 127     of grub.
 128
 129 *--help*, *-h*::
 130
 131     Show summary of options and exit.
 132
 133 *--hostname* _hostname_::
 134
 135     Use specified hostname instead of the default (being $HOSTNAME or if unset 'grml').
 136
 137 *-i*, *--iso* _/mntpoint_::
 138
 139     Specify mount point where you have a Debian ISO mounted loopback.
 140     Using this option instead of the mirror option gives you the possibility
 141     to install the base-system without network access. Make sure you
 142     mounted the according Debian-ISO to the given _/mntpoint_. See section
 143     'Usage examples' for a demonstration.
 144
 145 *--keep_src_list*::
 146
 147      Do not overwrite user provided /etc/apt/sources.list.
 148
 149 *-m*, *--mirror* _URL_::
 150
 151     Specify mirror which should be used for apt-get/aptitude.
 152     Corresponding with configuration variable MIRROR.
 153
 154 *--nodebootstrap*::
 155
 156     Skip debootstrap, only do configuration to the target.
 157
 158 *--nointerfaces*::
 159
 160     Do not copy /etc/network/interfaces from host system to the target.
 161
 162 *--nokernel*::
 163
 164     Skip installation of default kernel images. This option might be
 165     interesting for you if you want a Debian system which doesn't
 166     need to provide regular boot, e.g. a system which provides
 167     ISOs for booting via GRUB using grml-rescueboot.
 168
 169 *--non-free*::
 170
 171     Enable the 'non-free' repository in COMPONENTS. By default only
 172     the 'main' repository is enabled.
 173
 174 *--nopackages*::
 175
 176     Skip installation of packages defined in /etc/debootstrap/packages.
 177
 178 *--nopassword*::
 179
 180     Do not prompt for the root password. Note: Use the '--password' option if
 181     you want to set the root password during an automatic installation but don't
 182     want to use the interactive dialog.
 183
 184 *-p*, *--mntpoint* _/mntpoint_::
 185
 186     Specify mount point that should be used for mounting the target system.
 187     Corresponding with configuration variable MNTPOINT.
 188     Note: this option has no effect if option -t is given and represents a
 189     directory.
 190
 191 *--packages* _file_::
 192
 193     Use specified file as list for packages that should be installed instead of
 194     the default package list file <confdir>/packages.
 195
 196 *--password* _password_::
 197
 198     Use specified password as password for user root. Use with caution, as your
 199     command line might be visible in the process list and the shell history.
 200     It's meant for automatic installation only.
 201
 202 *--post-scripts* _directory_::
 203
 204     Execute scripts from specified directory after executing the chroot script.
 205     This allows customisation of the system after the chroot has been set up.
 206     The environment variable $MNTPOINT is available inside the scripts for
 207     direct access of the chroot.
 208     Default directory: /etc/debootstrap/post-scripts/
 209
 210 *--pre-scripts* _directory_::
 211
 212     Execute scripts from specified directory before executing the chroot
 213     script. This allows customisation of the system before the chroot has
 214     been set up.  The environment variable $MNTPOINT is available inside the
 215     scripts for direct access of the chroot.
 216     Default directory: /etc/debootstrap/pre-scripts/
 217
 218 *-r*, *--release* _releasename_::
 219
 220     Specify release of new Debian system. Supported releases names: lenny,
 221     squeeze, wheezy, jessie, stretch, buster, bullseye and sid. Corresponding with configuration
 222     variable RELEASE. Default release: bullseye
 223
 224 *--remove-configs*::
 225
 226     Delete grml-debootstrap configuration files (/etc/debootstrap/*) from installed
 227     system. Useful for reproducible builds or if you don't want to leak information.
 228
 229 *--sshcopyauth*::
 230
 231     Use locally available _$HOME/.ssh/authorized_keys_ to authorise root login on the target system.
 232     This installs _$HOME/.ssh/authorized_keys_ as _/root/.ssh/authorized_keys_ on
 233     the target system. If a different file than _$HOME/.ssh/authorized_keys_ should
 234     be used, the environment variable _AUTHORIZED_KEYS_SOURCE_ can be used.
 235
 236 *--sshcopyid*::
 237
 238     Use locally available public keys to authorise root login on the target system.
 239     Similar to ssh-copy-id(1) (without the -i option) it checks if `ssh-add -L`
 240     provides any output, and if so those keys are appended to
 241     _/root/.ssh/authorized_keys_ (creating the file and directory (with mode 0700)).
 242
 243 *-t*, *--target* _target_::
 244
 245     Target partition (/dev/...) or directory (anything else without /dev at the
 246     beginning).
 247
 248 *-v*, *--verbose*::
 249
 250     Increase verbosity.
 251
 252 *--vm*::
 253
 254     Set up a Virtual Machine on an existing block device, which will be
 255     partitioned.
 256     This allows deployment of a Virtual Machine. The options needs to be
 257     combined with the --target option.
 258     This option automatically enables the --defaultinterfaces option.
 259     Usage example: --vm --target /dev/mapper/your-vm-disk
 260
 261 *--vmfile*::
 262
 263     Set up a Virtual Machine using a regular file instead of installing to a
 264     partition/block device or directory. This allows deployment of a Virtual
 265     Machine. The options needs to be combined with the --target option
 266     ('qemu-img create -f raw ...' is executed on the specified target).
 267     This option automatically enables the --defaultinterfaces option.
 268     Usage example: --vmfile --target /mnt/sda1/qemu.img
 269
 270 *--vmsize* _size_::
 271
 272    Use specified size for size of Virtual Machine disk file. If not specified it
 273    defaults to 2G (being 2GB). Syntax as supported by qemu-img (see manpage
 274    qemu-img(1) for details.
 275    Usage example: --vmsize 3G
 276
 277 *-V*, *--version*::
 278
 279     Show version of program and exit.
 280
 281 WARNING: the command line parsing of grml-debootstrap usually does not validate
 282 the provided arguments for the command line options. Please be careful and check
 283 docs and /etc/debootstrap/config for further information.
 284
 285 Networking
 286 ----------
 287
 288 By default (that is, if none of the options *--nointerfaces*,
 289 *--defaultinterfaces*, *--vmfile* or *--vm* are given) /etc/network/interfaces
 290 will be copied from the host to the target system.
 291
 292 Usage examples
 293 ---------------
 294
 295   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 296
 297 Install default Debian release (bullseye) on /dev/sda1 and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 298
 299   grml-debootstrap --release stretch --target /dev/sda1 --grub /dev/sda --hostname debian01 --password changeme
 300
 301 Install Debian release stretch on /dev/sda1 and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 302 Set hostname to 'debian01' and password for user root to 'changeme'.
 303
 304   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
 305
 306 Install Debian unstable/sid on /dev/sda6 and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 307
 308   DEBOOTSTRAP=mmdebstrap grml-debootstrap --target /dev/sda1 --grub /dev/sda
 309
 310 Install default Debian release (bullseye) on /dev/sda1 and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 311 Use mmdebstrap instead of default debootstrap tool for bootstrapping.
 312
 313   grml-debootstrap --target /dev/mapper/vg0-rootfs --grub /dev/sda
 314
 315 Install default Debian release (bullseye) on LVM device /dev/mapper/vg0-rootfs and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 316
 317   grml-debootstrap --efi /dev/sda1 --target /dev/sda2 --grub /dev/sda
 318
 319 Install default Debian release (bullseye) on /dev/sda2 and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 320 Use /dev/sda1 as EFI partition (requires EFI support in booted system).
 321
 322   mount /dev/sda1 /data/chroot
 323   grml-debootstrap --target /data/chroot
 324
 325 Install default Debian release (bullseye) in directory /data/chroot (without any bootloader).
 326
 327   grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
 328
 329 Install default Debian release (bullseye) on /dev/sda3 and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 330 Use specified mirror instead of the default (http://deb.debian.org/debian) one.
 331
 332   mount /dev/sda1 /mnt/sda1
 333   grml-debootstrap --vmfile --vmsize 3G --target /mnt/sda1/qemu.img
 334
 335 Install default debian release (bullseye) in a Virtual Machine file with 3GB disk size (including GRUB as bootmanager in MBR of the virtual disk file):
 336
 337   mount -o loop ./debian-CD-1.iso /media/cdrom
 338   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso /media/cdrom
 339
 340 Install Debian on /dev/sda1 using the loopback mounted Debian-ISO for the base-system and install bootmanager GRUB in MBR (master boot record) of /dev/sda.
 341 Please notice, that the chroot system requires network access for all packages which are not part of the ISO.
 342
 343 Files
 344 -----
 345
 346   /etc/debootstrap/config
 347
 348 Main configuration file. Adjust it according to your needs if you want to
 349 execute grml-debootstrap in the non-interactive mode without any special command
 350 line arguments.
 351
 352   /etc/debootstrap/chroot-script
 353
 354 The script executed within the new Debian system as soon as the main system
 355 has been installed via [c]debootstrap.
 356
 357   /etc/debootstrap/locale.gen
 358
 359 Defines the default locales used for generating locales via locale-gen.
 360
 361   /etc/debootstrap/packages
 362
 363 Defines the software packages which should be installed in the new
 364 Debian system by default.
 365
 366   /etc/debootstrap/extrapackages/
 367
 368 Debian Packages dropped in this directory will be installed into the new Debian
 369 system by default (Control variable: EXTRAPACKAGES)
 370
 371 Customization
 372 -------------
 373
 374 You can control execution of grml-debootstrap via adjusting
 375 /etc/debootstrap/config for some main stuff or via setting some selected
 376 variables via command line.  The packages which should be installed in the new
 377 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 378 want to put existing files to the new Debian system you can place them into the
 379 (by default non-existing) directories boot, etc, share, usr and var in
 380 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 381 system then. If you want to install additional packages that are not available
 382 via the Grml or Debian mirror drop them into /etc/debootstrap/extrapackages and
 383 make sure that EXTRAPACKAGES is set to "yes".
 384
 385 Automatic installation
 386 ----------------------
 387
 388 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
 389 full automatic mode. While this mode isn't really useful for interactive
 390 execution (just configure /etc/debootstrap/configure or specify the relevant
 391 variables on the command line instead) it is meant for use via boot option
 392 debian2hd on the Grml live system. The boot option debian2hd (more precise: the
 393 kernelname at the bootprompt) supports the following boot options (they
 394 correspond with the command line options mentioned above):
 395
 396   target=...
 397
 398 The target partition/directory of the new Debian system. Usage example:
 399 target=/dev/sda1
 400
 401   grub=...
 402
 403 Where do you want to install grub to? Usage example: grub=/dev/sda
 404
 405   release=...
 406
 407 Specify release of new Debian system. Defaults to Debian bullseye. Supported
 408 releases: lenny, squeeze, wheezy, jessie, stretch, buster, bullseye and sid. Usage example: release=stretch
 409
 410   mirror=...
 411
 412 Specify mirror which should be used for apt-get/aptitude instead
 413 of the default one (http://deb.debian.org/debian).
 414 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 415
 416   password=...
 417
 418 Set password of user root without prompting for it but set it to the given
 419 argument. Usage example: password=AiTh5ahn
 420
 421 Usage example for automatic installation
 422 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 423
 424   debian2hd target=/dev/sda1 grub=/dev/sda mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
 425
 426 You have to enter this command line at the bootprompt of the Grml live system.
 427 Please make sure that /dev/sda1 is the partition where you really want to
 428 install your new Debian system.
 429
 430 [NOTE]
 431 Automatic installation within booting process is done in grml-autoconfig via
 432 setting environment variable AUTOINSTALL and creation of
 433 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
 434 boot options for grml-debootstrap.
 435
 436 Supported Releases
 437 ------------------
 438
 439 include::releasetable.txt[]
 440
 441 [NOTE]
 442 .lenny/squeeze/wheezy release
 443 ================================================================================
 444 [1] Please notice that releases like lenny, squeeze and wheezy are unsupported releases within Debian nowadays.
 445 grml-debootstrap can handle the releases but you really should not use them
 446 anymore unless you really know what you are doing.
 447 Choose the current Debian stable version instead.
 448 See https://wiki.debian.org/DebianReleases for the list of supported releases.
 449
 450 Notice that you need to specify a mirror providing the lenny and squeeze releases, the
 451 default (http://deb.debian.org/debian) doesn't provide it any longer nowadays.
 452 Set the mirror to e.g. http://archive.debian.org/debian/ if you don't have
 453 your own lenny/squeeze mirror.
 454
 455 Older releases might also fail to install when running on top of recent kernel versions,
 456 throwing segfaults during debootstrap. This can be identified by the following messages inside kernel log (check with 'dmesg'):
 457
 458    dpkg[...] vsyscall attempted with vsyscall=none ip:[...]
 459    dpkg[...]: segfault at [...]
 460
 461 To work around this issue boot your system with the kernel boot option 'vsyscall=emulate'.
 462
 463 You also need to specify a filesystem that's supported by lenny, e.g.
 464 '--filesystem ext3' since grml-debootstrap's current default (ext4) isn't
 465 supported by lenny.
 466
 467 Also when debootstrapping lenny on a live system with a kernel version
 468 like "3.16-1-grml-amd64" lenny's libc will fail to install with:
 469
 470    [...]
 471    /var/lib/dpkg/tmp.ci/preinst: line 265: [: 3.16-1-grml-amd64: integery expression expected
 472    /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")
 473    dpkg: error processing /var/cache/apt/archives/libc6_2.7-18lenny7_amd64.deb (--install):
 474    [....]
 475
 476 To workaround this either debootstrap from a system with an according
 477 kernel version or use the "fake uname" workaround (just google for it).
 478
 479 When installing lenny to a new mdraid, grml-debootstrap will use md metadata
 480 format version 0.90. This limits the device to a maximum size of 2TB, but has
 481 the advantage of grub-legacy actually being able to boot from it.
 482 ================================================================================
 483
 484 [NOTE]
 485 .unstable and testing releases
 486 ================================================================================
 487 [2] Please notice that Debian/testing and Debian/unstable (sid) might
 488 not be always installable due to their nature. What _might_ work instead is
 489 deploying a stable release and upgrade it after installation finished.
 490 ================================================================================
 491
 492 Bugs
 493 ----
 494
 495 Please report bugs towards https://github.com/grml/grml-debootstrap/issues
 496
 497 See also
 498 --------
 499
 500 debootstrap (8), cdebootstrap (1), mmdebstrap(1).
 501
 502 Author
 503 ------
 504 Michael Prokop <mika@grml.org>