grml-debootstrap.8.txt

   1 grml-debootstrap(8)
   2 ===================
   3
   4 Name
   5 ----
   6 grml-debootstrap - wrapper around debootstrap for installing plain Debian via grml
   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 via grml very fast and easy.
  19
  20 All you have to do is adjust a few variables in configuration file
  21 /etc/debootstrap/config (or specify some variables via commandline) and invoke
  22 grml-debootstrap without any further options then.
  23
  24 A plain and base Debian system will be installed on the given device (or
  25 directory) then. Customization of this process is possible as well.
  26
  27 CAUTION: The grml team does not take responsibility for loss of any data!
  28
  29 Options and environment variables
  30 ---------------------------------
  31
  32 *--arch* <_architecture_>::
  33
  34     Architecture you want to bootstrap. Currently only i386 is supported.
  35     Defaults to the architecture that is currently running on your system. If
  36     you're running an amd64 system and want to deploy a i386 system use this option.
  37     Note: deploying amd64 from a i386 system won't work.
  38
  39 *--bootappend* <_appendline for the kernel_>::
  40
  41     Specify appendline for the kernel.
  42     E.g. "_pci=nomsi_"
  43
  44 *-c*, *--config* <_file_>::
  45
  46     Use specified configuration file, defaults to /etc/debootstrap/config.
  47
  48 *--chroot-scripts* <_directory_>::
  49
  50     Execute chroot scripts from specified directory. This allows customisation
  51     of the chroot setup, the executable script(s) present in the given directory
  52     are executed at the end of the chroot procedure.
  53     Default directory: /etc/debootstrap/chroot-scripts/
  54
  55 *-d*, *--confdir* <_path_>::
  56
  57     Place of configuration files for debootstrap, defaults to /etc/debootstrap.
  58
  59 *--debconf* <_file_>::
  60
  61     Use specified file for preseeding Debian packages instead of using
  62     the default <confdir>/debconf-selections.
  63
  64 *--debopt* <_params_>::
  65
  66     Extra parameters passed to the debootstrap command.
  67
  68 *--groot* <_device_>::
  69
  70     Specify root device for usage in grub (corresponds with $TARGET).
  71     Again, use grub syntax for specifying.
  72     Corresponding with configuration variable GROOT.
  73
  74 *--grub* <_device_>::
  75
  76     Where do you want to install grub to? Use grub syntax for specifying.
  77     Do not forget to set groot as well. Leave empty to avoid installation of grub.
  78
  79 *--help*, *-h*::
  80
  81     Show summary of options and exit.
  82
  83 *--hostname* <_hostname_>::
  84
  85     Use specified hostname instead of the default (being 'grml').
  86
  87 *-i*, *--iso* <_/mntpoint_>::
  88
  89     Specify mountpoint where you have a Debian ISO mounted loopback.
  90     Using this option instead of the mirror option gives you the possibility
  91     to install the base-system without network access. Make sure you
  92     mounted the according Debian-ISO to the given <_/mntpoint_>. See section
  93     'Usage examples' for a demonstration.
  94
  95 *--keep_src_list*::
  96
  97      Do not overwrite user provided /etc/apt/sources.list.
  98
  99 *-m*, *--mirror* <_URL_>::
 100
 101     Specify mirror which should be used for apt-get/aptitude.
 102     Corresponding with configuration variable MIRROR.
 103
 104 *--nodebootstrap*::
 105
 106     Skip debootstrap, only do configuration to the target.
 107
 108 *-p*, *--mntpoint* <_/mntpoint_>::
 109
 110     Specify mountpoint that should be used for mounting the target system.
 111     Corresponding with configuration variable MNTPOINT.
 112     Note: this option has no effect if option -t is given and represents a
 113     directory.
 114
 115 *--packages* <_file_>::
 116
 117     Use specified file as list for packages that should be installed instead of
 118     the default package list file <confdir>/packages.
 119
 120 *--password* <_password_>::
 121
 122     Use specified password as password for user root. Use with caution, as your
 123     commandline might be visible in the process list and the shell history.
 124     It's meant for automatic installation only.
 125
 126 *-r*, *--release* <_releasename_>::
 127
 128     Specify release of new Debian system. Supported releases names: etch, lenny,
 129     squeeze (note: requires current version of debootstrap) and sid.
 130     Corresponding with configuration variable RELEASE.
 131
 132 *--scripts* <_directory_>::
 133
 134     Execute scripts from specified directory. This allows customisation of
 135     the system after the chroot has been set up. The environment variable
 136     $MNTPOINT is available inside the scripts for direct access of the chroot.
 137     Default directory: /etc/debootstrap/scripts/
 138
 139 *-t*, *--target* <_target_>::
 140     Target partition (/dev/...) or directory (anything else without /dev at the
 141     beginning). To install grub using *--grub* and *--groot*, make sure to
 142     use a _device_ instead of a directory as _target_ (installation of
 143     grub as bootloader when using directories is NOT supported).
 144
 145 *-v*, *--verbose*::
 146     Increase verbosity.
 147
 148 *-V*, *--version*::
 149     Show version of program and exit.
 150
 151 WARNING: the commandline parsing of grml-debootstrap does not validate the provided
 152 arguments for the commandline options. Please be careful and check docs and
 153 /etc/debootstrap/config for further information.
 154
 155 Usage examples
 156 ---------------
 157
 158   grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0
 159
 160 Install default Debian release (stable/lenny) on /dev/sda1 and install bootmanager
 161 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 162
 163   grml-debootstrap --target /dev/sda6 --grub hd0 --groot hd0,5 --release sid
 164
 165 Install Debian unstable/sid on /dev/sda6, install bootmanager
 166 Grub in MBR (master boot record) of /dev/sda and use /dev/sda6 as system partition.
 167
 168   mount /dev/sda1 /data/chroot
 169   grml-debootstrap --target /data/chroot
 170
 171 Install default Debian release (stable/lenny) in directory /data/chroot (without
 172 any bootloader).
 173
 174   grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
 175
 176 Install default Debian release (stable/lenny) on /dev/sda3 and install bootmanager
 177 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 178 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 179
 180   mount -o loop /mnt/sda6/debian-40r0-i386-CD-1.iso /mnt/iso
 181   grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0 --iso file:/mnt/iso/debian/
 182
 183 Install Debian stable/lenny on /dev/sda1 using the loopback mounted Debian-ISO
 184 for the base-system and install bootmanager Grub in MBR (master boot record) of
 185 /dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
 186 system requires network access for all packages which are not part of the
 187 ISO.
 188
 189 Files
 190 -----
 191
 192   /etc/debootstrap/config
 193
 194 Main configuration file. You have to adjust it according to your needs
 195 before you are able to run grml-debootstrap.
 196
 197   /etc/debootstrap/chroot-script
 198
 199 The script executed within the new Debian system as soon as the main system
 200 has been installed via [c]debootstrap.
 201
 202   /etc/debootstrap/locale.gen
 203
 204 Defines the default locales used for generating locales via locale-gen.
 205
 206   /etc/debootstrap/packages
 207
 208 Defines the software packages which should be installed in the new
 209 Debian system by default.
 210
 211   /etc/debootstrap/extrapackages
 212
 213 Debian Packages dropped here will be installed into the new Debian system by
 214 default (Controlvariable: EXTRAPACKAGES)
 215
 216   /etc/debootstrap/stages/
 217
 218 The default directory for storing information about executed stages. Every
 219 single function of grml-debootstrap will write 'done' to the stages directory
 220 into a file named as the function itself if it has been executed successfully.
 221 You can adjust the location of the directory via configuration variable STAGES
 222 via /etc/debootstrap/config.  Please notice that you have to remove the stages
 223 directory on your own if you want to re-execute grml-debootstrap after running it
 224 successfully once. This should avoid recurrent execution by error of
 225 grml-debootstrap (which might delete present data).
 226
 227 Customization
 228 -------------
 229
 230 You can control execution of grml-debootstrap via adjusting
 231 /etc/debootstrap/config for some main stuff or via setting some selected
 232 variables via commandline.  The packages which should be installed in the new
 233 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 234 want to put existing files to the new Debian system you can place them into the
 235 (by default non-existing) directories boot, etc, share, usr and var in
 236 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 237 system then. If you want to install additional packages that are not available
 238 via the grml or debian mirror drop them into /etc/debootstrap/extrapackages and
 239 make sure that EXTRAPACKAGES is set to "yes".
 240
 241 Automatic installation
 242 ----------------------
 243
 244 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
 245 full automatic mode. While this mode isn't really useful for interactive
 246 execution (just configure /etc/debootstrap/configure or specify the relevant
 247 variables on the commandline instead) it is meant for use via bootoption
 248 debian2hd. The bootoption debian2hd (more precise: the kernelname on bootprompt)
 249 supports the following bootoptions (they correspond with the commandline options
 250 mentioned above):
 251
 252   target=...
 253
 254 The target partition/directory of the new Debian system. Usage example:
 255 target=/dev/sda1
 256
 257   grub=...
 258
 259 Where do you want to install grub to? Use grub syntax for specifying.
 260 Usage example: grub=hd0
 261
 262   groot=...
 263
 264 Specify root device for usage in grub (corresponds with $TARGET).
 265 Again, use grub syntax for specifying. Usage example: groot=hd0,0
 266
 267   release=...
 268
 269 Specify release of new Debian system. Defaults to Debian stable.  Supported
 270 relases: etch, lenny, squeeze and sid. Usage example: release=sid
 271
 272   mirror=...
 273
 274 Specify mirror which should be used for apt-get/aptitude instead
 275 of the default one (ftp://ftp.debian.de/debian).
 276 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 277
 278   password=...
 279
 280 Set password of user root without prompting for it but set it to the given
 281 argument. Usage example: password=AiTh5ahn
 282
 283 Usage example for automatic installation:
 284 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 285
 286   debian2hd target=/dev/sda1 grub=hd0 groot=hd0,0 mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
 287
 288 You have to enter this commandline at the bootprompt of grml. Please make sure
 289 that /dev/sda1 is the partition where you really want to install your new Debian
 290 system.
 291
 292 [NOTE]
 293 Automatic installation within booting process is done in grml-autoconfig via
 294 setting environment variable AUTOINSTALL and creation of
 295 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
 296 bootoptions for grml-debootstrap.
 297
 298 Supported Releases
 299 ------------------
 300
 301 include::releasetable.txt[]
 302
 303 [NOTE]
 304 .Etch-Release
 305 ================================================================================
 306 [1] Please notice that Etch is the current old-stable within Debian.
 307 grml-debootstrap can handle the release but you really should not use Etch
 308 anymore unless you really know what you are doing. Choose Lenny instead.
 309 ================================================================================
 310
 311 Bugs
 312 ----
 313
 314 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 315
 316 See also
 317 --------
 318
 319 debootstrap (8), cdebootstrap (1).
 320
 321 Author
 322 ------
 323 Michael Prokop <mika@grml.org>