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