grml-debootstrap.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
  18 (and cdebootstrap if you want) for installing a plain Debian
  19 system via grml very fast and easy.
  20
  21 All you have to do is adjust a few variables in configuration file
  22 /etc/debootstrap/config (or specify some variables via commandline) and invoke
  23 grml-debootstrap without any further options then.
  24
  25 A plain and base Debian system will be installed on the given
  26 device (or directory) then. Customization of this process is
  27 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   -h, --help
  35
  36 Show summary of options and exit.
  37
  38   -v, --version
  39
  40 Show version of program and exit.
  41
  42   --grub <device>
  43
  44 Where do you want to install grub to? Use grub syntax for specifying.
  45 Do not forget to set groot as well. Leave empty to avoid installation of grub.
  46
  47   --groot <device>
  48
  49 Specify root device for usage in grub (corresponds with $TARGET).
  50 Again, use grub syntax for specifying.
  51 Corresponding with configuration variable GROOT.
  52
  53   -m, --mirror <URL>
  54
  55 Specify mirror which should be used for apt-get/aptitude. Notice that
  56 specifying the mirror also sets the chrootmirror to the given value.
  57 Corresponding with configuration variables MIRROR and CHROOTMIRROR.
  58
  59   -p, --mntpoint </mntpoint>
  60
  61 Specify mountpoint that should be used for mounting the target system.
  62 Corresponding with configuration variable MNTPOINT.
  63
  64   --password <password>
  65
  66 Use specified password as password for user root. Use with caution, as your
  67 commandline might be visible in the process list and the shell history.
  68 It's meant for automatic installation only.
  69
  70   -r, --release <releasename>
  71
  72 Specify release of new Debian system. Supported relases: sarge, etch, lenny and sid.
  73 Corresponding with configuration variable RELEASE.
  74
  75   -t, --target <target>
  76
  77 Target partition (/dev/...) or directory (anything else without /dev at the
  78 beginning).
  79
  80 WARNING: the commandline parsing of grml-debootstrap does not validate the provided
  81 arguments for the commandline options. Please be careful and check docs and
  82 /etc/debootstrap/config for further information.
  83
  84 Usage examples
  85 ---------------
  86
  87   grml-debootstrap --target /dev/hda1 --grub hd0 --groot hd0,0
  88
  89 Install default Debian release (stable/etch) on /dev/hda1 and install bootmanager
  90 Grub in MBR (master boot record) of /dev/hda and use /dev/hda1 as system partition.
  91
  92   grml-debootstrap --target /dev/hda6 --grub hd0 --groot hd0,5 --release sid
  93
  94 Install Debian unstable/sid on /dev/hda6, install bootmanager
  95 Grub in MBR (master boot record) of /dev/hda and use /dev/hda6 as system partition.
  96
  97   grml-debootstrap --target /data/chroot
  98
  99 Install default Debian release (stable/etch) in directory /data/chroot (without
 100 any bootloader).
 101
 102   grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
 103
 104 Install default Debian release (stable/etch) on /dev/sda3 and install bootmanager
 105 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 106 Use specifed mirror instead of the default (ftp://ftp.debian.de/debian) one.
 107
 108 Files
 109 -----
 110
 111   /etc/debootstrap/config
 112
 113 Main configuration file. You have to adjust it according to your needs
 114 before you are able to run grml-debootstrap.
 115
 116   /etc/debootstrap/chroot-script
 117
 118 The script executed within the new Debian system as soon as the main system
 119 has been installed via [c]debootstrap.
 120
 121   /etc/debootstrap/locale.gen
 122
 123 Defines the default locales used for generating locales via locale-gen.
 124
 125   /etc/debootstrap/packages
 126
 127 Defines the software packages which should be installed in the new
 128 Debian system by default.
 129
 130   /etc/debootstrap/stages/
 131
 132 The default directory for storing information about executed stages. Every
 133 single function of grml-debootstrap will write 'done' to the stages directory
 134 into a file named as the function itself if it has been executed successfully.
 135 You can adjust the location of the directory via configuration variable STAGES
 136 via /etc/debootstrap/config.  Please notice that you have to remove the stages
 137 directory on your own if you want to re-execute grml-deboostrap after running it
 138 successfully once. This should avoid recurrent execution by error of
 139 grml-debootstrap (which might delete present data).
 140
 141 Customization
 142 -------------
 143
 144 You can control execution of grml-debootstrap via adjusting
 145 /etc/debootstrap/config for some main stuff or via setting some selected
 146 variables via commandline.  The packages which should be installed in the new
 147 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 148 want to put existing files to the new Debian system you can place them into the
 149 (by default non-existing) directories boot, etc, share, usr and var in
 150 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 151 system then.
 152
 153 Automatic installation
 154 ----------------------
 155
 156 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
 157 full automatic mode. While this mode isn't really useful for interactive
 158 execution (just configure /etc/debootstrap/configure or specify the relevant
 159 variables on the commandline instead) it is meant for use via bootoption
 160 debian2hd. The bootoption debian2hd (more precise: the kernelname on bootprompt)
 161 supports the following bootoptions (they correspond with the commandline options
 162 mentioned above):
 163
 164   target=...
 165
 166 The target partition/directory of the new Debian system. Usage example:
 167 target=/dev/hda1
 168
 169   grub=...
 170
 171 Where do you want to install grub to? Use grub syntax for specifying.
 172 Usage example: grub=hd0
 173
 174   groot=...
 175
 176 Specify root device for usage in grub (corresponds with $TARGET).
 177 Again, use grub syntax for specifying. Usage example: groot=hd0,0
 178
 179   release=...
 180
 181 Specify release of new Debian system. Defaults to Debian stable.
 182 Supported relases: sarge, etch, lenny and sid. Usage example: release=sid
 183
 184   mirror=...
 185
 186 Specify mirror which should be used for apt-get/aptitude instead
 187 of the default one (ftp://ftp.debian.de/debian).
 188 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
 189
 190   password=...
 191
 192 Set passwort of user root without prompting for it but set it to the given
 193 argument. Usage example: password=AiTh5ahn
 194
 195 [NOTE]
 196 Automatic installation within booting process is done in grml-autoconfig via
 197 setting environment variable AUTOINSTALL and creation of
 198 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
 199 bootoptions for grml-debootstrap.
 200
 201 Supported Releases
 202 ------------------
 203
 204 include::releasetable.txt[]
 205
 206 [NOTE]
 207 .Sarge-Release
 208 =====================================================================
 209 [1] Please notice that Sarge is the current old-stable within Debian.
 210 grml-debootstrap can handle the release but you really should not
 211 use Sarge anymore unless you really know what you are doing. Choose
 212 Etch instead.
 213 =====================================================================
 214
 215 Bugs
 216 ----
 217
 218 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 219
 220 See also
 221 --------
 222
 223 debootstrap (8), cdebootstrap (1).
 224
 225 Author
 226 ------
 227 Michael Prokop <mika@grml.org>