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