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 (e.g. via Grml) 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 (squeeze: http://backports.debian.org/
  44     and others: http://http.debian.net/) via the
  45     /etc/apt/sources.list.d/backports.list configuration file. This provides the
  46     option to install Debian packages from Debian's backports repository.
  47
  48 *--bootappend* _appendline-for-the-kernel_::
  49
  50     Specify appendline for the kernel.
  51     E.g. "_pci=nomsi_"
  52
  53 *-c*, *--config* _file_::
  54
  55     Use specified configuration file, defaults to /etc/debootstrap/config.
  56
  57 *--chroot-scripts* _directory_::
  58
  59     Execute chroot scripts from specified directory. This allows customisation
  60     of the chroot setup, the executable script(s) present in the given directory
  61     are executed at the end of the chroot procedure.
  62     Default directory: /etc/debootstrap/chroot-scripts/
  63
  64 *-d*, *--confdir* _path_::
  65
  66     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
  67
  68 *--debconf* _file_::
  69
  70     Use specified file for preseeding Debian packages instead of using
  71     the default <confdir>/debconf-selections.
  72
  73 *--debopt* _params_::
  74
  75     Extra parameters passed to the debootstrap command.
  76
  77 *--filesystem* _filesystem_::
  78
  79     Filesystem that should be created when installing to a partition.
  80     If unset defaults to ext3. Valid values are all filesystems that
  81     can be created through mkfs._filesystem_.
  82
  83 *--force*::
  84
  85     Skip user acknowledgement and do not prompt for user input.
  86
  87 *--grmlrepos*::
  88
  89     Enable Grml.org's Debian repository (http://deb.grml.org/) via the
  90     /etc/apt/sources.list.d/grml.list configuration file. This provides the
  91     option to install Debian packages from Grml's repository.
  92
  93 *--grub* _device_::
  94
  95     Device where grub should be installed to. Note that only the MBR (master
  96     boot record) can be used (/dev/sda, /dev/sdb,...). Partitions (like
  97     /dev/sda1, /dev/sdb2,...) are NOT supported because grub2 doesn't support
  98     installation into the PBR (partition boot record) anymore.  Usage example:
  99     '--grub /dev/sda'.  Note: just do not set this option to avoid installation
 100     of grub.
 101
 102 *--help*, *-h*::
 103
 104     Show summary of options and exit.
 105
 106 *--hostname* _hostname_::
 107
 108     Use specified hostname instead of the default (being 'grml').
 109
 110 *-i*, *--iso* _/mntpoint_::
 111
 112     Specify mount point where you have a Debian ISO mounted loopback.
 113     Using this option instead of the mirror option gives you the possibility
 114     to install the base-system without network access. Make sure you
 115     mounted the according Debian-ISO to the given _/mntpoint_. See section
 116     'Usage examples' for a demonstration.
 117
 118 *--keep_src_list*::
 119
 120      Do not overwrite user provided /etc/apt/sources.list.
 121
 122 *-m*, *--mirror* _URL_::
 123
 124     Specify mirror which should be used for apt-get/aptitude.
 125     Corresponding with configuration variable MIRROR.
 126
 127 *--nodebootstrap*::
 128
 129     Skip debootstrap, only do configuration to the target.
 130
 131 *--nopackages*::
 132
 133     Skip installation of packages defined in /etc/debootstrap/packages.
 134
 135 *--nopassword*::
 136
 137     Do not prompt for the root password. Note: Use the '--password' option if
 138     you want to set the root password during an automatic installation but don't
 139     want to use the interactive dialog.
 140
 141 *-p*, *--mntpoint* _/mntpoint_::
 142
 143     Specify mount point that should be used for mounting the target system.
 144     Corresponding with configuration variable MNTPOINT.
 145     Note: this option has no effect if option -t is given and represents a
 146     directory.
 147
 148 *--packages* _file_::
 149
 150     Use specified file as list for packages that should be installed instead of
 151     the default package list file <confdir>/packages.
 152
 153 *--password* _password_::
 154
 155     Use specified password as password for user root. Use with caution, as your
 156     command line might be visible in the process list and the shell history.
 157     It's meant for automatic installation only.
 158
 159 *-r*, *--release* _releasename_::
 160
 161     Specify release of new Debian system. Supported releases names: lenny,
 162     squeeze, wheezy (note: requires current version of debootstrap) and sid.
 163     Corresponding with configuration variable RELEASE.
 164
 165 *--pre-scripts* _directory_::
 166
 167     Execute scripts from specified directory before executing the chroot
 168     script. This allows customisation of the system before the chroot has
 169     been set up.  The environment variable $MNTPOINT is available inside the
 170     scripts for direct access of the chroot.
 171     Default directory: /etc/debootstrap/pre-scripts/
 172
 173 *--scripts* _directory_::
 174
 175     Execute scripts from specified directory. This allows customisation of
 176     the system after the chroot has been set up. The environment variable
 177     $MNTPOINT is available inside the scripts for direct access of the chroot.
 178     Default directory: /etc/debootstrap/scripts/
 179
 180 *-t*, *--target* _target_::
 181     Target partition (/dev/...) or directory (anything else without /dev at the
 182     beginning). To install grub using *--grub* make sure to use a _device_
 183     instead of a directory as _target_ (installation of grub as bootloader when
 184     using directories is NOT supported).
 185
 186 *-v*, *--verbose*::
 187     Increase verbosity.
 188
 189 *--vmfile*::
 190     Set up a Virtual Machine instead of installing to a partition or directory.
 191     This allows deployment of a Virtual Machine. The options needs to be
 192     combined with the --target option.
 193     Usage example: --vmfile --target /mnt/sda1/qemu.img
 194
 195 *--vmsize* _size_::
 196    Use specified size for size of Virtual Machine disk file. If not specified it
 197    defaults to 2G (being 2GB). Syntax as supported by qemu-img (see manpage
 198    qemu-img(1) for details.
 199    Usage example: --vmsize 3G
 200
 201 *-V*, *--version*::
 202     Show version of program and exit.
 203
 204 WARNING: the command line parsing of grml-debootstrap does not validate the provided
 205 arguments for the command line options. Please be careful and check docs and
 206 /etc/debootstrap/config for further information.
 207
 208 Usage examples
 209 ---------------
 210
 211   grml-debootstrap --target /dev/sda1 --grub /dev/sda
 212
 213 Install default Debian release (wheezy) on /dev/sda1 and install bootmanager
 214 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 215
 216   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
 217
 218 Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
 219 (master boot record) of /dev/sda and use /dev/sda6 as system partition.
 220
 221   mount /dev/sda1 /data/chroot
 222   grml-debootstrap --target /data/chroot
 223
 224 Install default Debian release (wheezy) in directory /data/chroot (without
 225 any bootloader).
 226
 227   grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
 228
 229 Install default debian release (wheezy) in a Virtual Machine file with
 230 3GB disk size (including Grub as bootmanager in MBR of the virtual disk file):
 231
 232   mount /dev/sda1 /mnt/sda1
 233   grml-debootstrap --vmfile --vmsize 3G --target /mnt/sda1/qemu.img
 234
 235 Install default Debian release (wheezy) on /dev/sda3 and install bootmanager
 236 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 237 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 238
 239   mount -o loop /mnt/sda6/debian-CD-1.iso /mnt/iso
 240   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
 241
 242 Install Debian on /dev/sda1 using the loopback mounted Debian-ISO
 243 for the base-system and install bootmanager Grub in MBR (master boot record) of
 244 /dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
 245 system requires network access for all packages which are not part of the
 246 ISO.
 247
 248 Files
 249 -----
 250
 251   /etc/debootstrap/config
 252
 253 Main configuration file. You have to adjust it according to your needs
 254 if you want to execute grml-debootstrap in the non-interactive mode without
 255 any special command line arguments.
 256
 257   /etc/debootstrap/chroot-script
 258
 259 The script executed within the new Debian system as soon as the main system
 260 has been installed via [c]debootstrap.
 261
 262   /etc/debootstrap/locale.gen
 263
 264 Defines the default locales used for generating locales via locale-gen.
 265
 266   /etc/debootstrap/packages
 267
 268 Defines the software packages which should be installed in the new
 269 Debian system by default.
 270
 271   /etc/debootstrap/extrapackages/
 272
 273 Debian Packages dropped in this directory will be installed into the new Debian
 274 system by default (Control variable: EXTRAPACKAGES)
 275
 276   /etc/debootstrap/stages/
 277
 278 The default directory for storing information about executed stages. Every
 279 single function of grml-debootstrap will write 'done' to the stages directory
 280 into a file named as the function itself if it has been executed successfully.
 281 You can adjust the location of the directory via configuration variable STAGES
 282 via /etc/debootstrap/config.  Please notice that you have to remove the stages
 283 directory on your own if you want to re-execute grml-debootstrap after running it
 284 successfully once. This should avoid recurrent execution by error of
 285 grml-debootstrap (which might delete present data).
 286
 287 Customization
 288 -------------
 289
 290 You can control execution of grml-debootstrap via adjusting
 291 /etc/debootstrap/config for some main stuff or via setting some selected
 292 variables via command line.  The packages which should be installed in the new
 293 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 294 want to put existing files to the new Debian system you can place them into the
 295 (by default non-existing) directories boot, etc, share, usr and var in
 296 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 297 system then. If you want to install additional packages that are not available
 298 via the Grml or Debian mirror drop them into /etc/debootstrap/extrapackages and
 299 make sure that EXTRAPACKAGES is set to "yes".
 300
 301 Automatic installation
 302 ----------------------
 303
 304 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
 305 full automatic mode. While this mode isn't really useful for interactive
 306 execution (just configure /etc/debootstrap/configure or specify the relevant
 307 variables on the command line instead) it is meant for use via boot option
 308 debian2hd on the Grml live system. The boot option debian2hd (more precise: the
 309 kernelname at the bootprompt) supports the following boot options (they
 310 correspond with the command line options mentioned above):
 311
 312   target=...
 313
 314 The target partition/directory of the new Debian system. Usage example:
 315 target=/dev/sda1
 316
 317   grub=...
 318
 319 Where do you want to install grub to? Usage example: grub=/dev/sda
 320
 321   release=...
 322
 323 Specify release of new Debian system. Defaults to Debian wheezy. Supported
 324 relases: lenny, squeeze, wheezy and sid. Usage example: release=sid
 325
 326   mirror=...
 327
 328 Specify mirror which should be used for apt-get/aptitude instead
 329 of the default one (http://http.debian.net/debian).
 330 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 331
 332   password=...
 333
 334 Set password of user root without prompting for it but set it to the given
 335 argument. Usage example: password=AiTh5ahn
 336
 337 Usage example for automatic installation:
 338 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 339
 340   debian2hd target=/dev/sda1 grub=/dev/sda mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
 341
 342 You have to enter this command line at the bootprompt of the Grml live system.
 343 Please make sure that /dev/sda1 is the partition where you really want to
 344 install your new Debian system.
 345
 346 [NOTE]
 347 Automatic installation within booting process is done in grml-autoconfig via
 348 setting environment variable AUTOINSTALL and creation of
 349 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
 350 boot options for grml-debootstrap.
 351
 352 Supported Releases
 353 ------------------
 354
 355 include::releasetable.txt[]
 356
 357 [NOTE]
 358 .lenny release
 359 ================================================================================
 360 [1] Please notice that lenny is the current old-stable release within Debian.
 361 grml-debootstrap can handle the release but you really should not use lenny
 362 anymore unless you really know what you are doing. Choose Debian 6.0 (squeeze)
 363 or Debian 7.0 (wheezy) instead.
 364
 365 Notice that you need to specify a mirror providing the lenny release, the
 366 default (http://http.debian.net/debian) doesn't provide it any longer nowadays.
 367 Set the mirror to e.g. http://archive.debian.org/debian/ if you don't have
 368 your own lenny mirror.
 369
 370 When installing lenny to a new mdraid, grml-debootstrap will use md metadata
 371 format version 0.90. This limits the device to a maximum size of 2TB, but has
 372 the advantage of grub-legacy actually being able to boot from it.
 373 ================================================================================
 374
 375 [NOTE]
 376 .sid release
 377 ================================================================================
 378 [2] Please notice that sid is Debian/unstable and due to its nature might not be
 379 always installable. What _might_ work instead is deploying a stable or testing
 380 release and upgrade it after installation finished.
 381 ================================================================================
 382
 383 Bugs
 384 ----
 385
 386 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 387
 388 See also
 389 --------
 390
 391 debootstrap (8), cdebootstrap (1).
 392
 393 Author
 394 ------
 395 Michael Prokop <mika@grml.org>