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