mdraids for lenny need to use metadata format 0.90
[grml-debootstrap.git] / 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 *--filesystem* <_filesystem_>::
69
70     Filesystem that should be created when installing to a partition.
71     If unset defaults to ext3. Valid values are all filesystems that
72     can be created through mkfs.<filesystem>.
73
74 *--grub* <_device_>::
75
76     Device where grub should be installed to. Note that only the MBR (master
77     boot record) can be used (/dev/sda, /dev/sdb,...). Partitions (like
78     /dev/sda1, /dev/sdb2,...) are NOT supported because grub2 doesn't support
79     installation into the PBR (partition boot record) anymore.  Usage example:
80     '--grub /dev/sda'.  Note: just do not set this option to avoid installation
81     of grub.
82
83 *--help*, *-h*::
84
85     Show summary of options and exit.
86
87 *--hostname* <_hostname_>::
88
89     Use specified hostname instead of the default (being 'grml').
90
91 *-i*, *--iso* <_/mntpoint_>::
92
93     Specify mountpoint where you have a Debian ISO mounted loopback.
94     Using this option instead of the mirror option gives you the possibility
95     to install the base-system without network access. Make sure you
96     mounted the according Debian-ISO to the given <_/mntpoint_>. See section
97     'Usage examples' for a demonstration.
98
99 *--keep_src_list*::
100
101      Do not overwrite user provided /etc/apt/sources.list.
102
103 *-m*, *--mirror* <_URL_>::
104
105     Specify mirror which should be used for apt-get/aptitude.
106     Corresponding with configuration variable MIRROR.
107
108 *--nodebootstrap*::
109
110     Skip debootstrap, only do configuration to the target.
111
112 *--nopackages*::
113
114     Skip installation of packages defined in /etc/debootstrap/packages.
115
116 *--insecure*::
117
118     Do not download and check signatures for retrieved Release files.
119
120 *-p*, *--mntpoint* <_/mntpoint_>::
121
122     Specify mountpoint that should be used for mounting the target system.
123     Corresponding with configuration variable MNTPOINT.
124     Note: this option has no effect if option -t is given and represents a
125     directory.
126
127 *--packages* <_file_>::
128
129     Use specified file as list for packages that should be installed instead of
130     the default package list file <confdir>/packages.
131
132 *--password* <_password_>::
133
134     Use specified password as password for user root. Use with caution, as your
135     commandline might be visible in the process list and the shell history.
136     It's meant for automatic installation only.
137
138 *-r*, *--release* <_releasename_>::
139
140     Specify release of new Debian system. Supported releases names: lenny,
141     squeeze (note: requires current version of debootstrap) and sid.
142     Corresponding with configuration variable RELEASE.
143
144 *--pre-scripts* <_directory_>::
145
146     Execute scripts from specified directory before executing the chroot
147     script. This allows customisation of the system before the chroot has
148     been set up.  The environment variable $MNTPOINT is available inside the
149     scripts for direct access of the chroot.
150     Default directory: /etc/debootstrap/pre-scripts/
151
152 *--scripts* <_directory_>::
153
154     Execute scripts from specified directory. This allows customisation of
155     the system after the chroot has been set up. The environment variable
156     $MNTPOINT is available inside the scripts for direct access of the chroot.
157     Default directory: /etc/debootstrap/scripts/
158
159 *-t*, *--target* <_target_>::
160     Target partition (/dev/...) or directory (anything else without /dev at the
161     beginning). To install grub using *--grub* make sure to use a _device_
162     instead of a directory as _target_ (installation of grub as bootloader when
163     using directories is NOT supported).
164
165 *-v*, *--verbose*::
166     Increase verbosity.
167
168 *-V*, *--version*::
169     Show version of program and exit.
170
171 WARNING: the commandline parsing of grml-debootstrap does not validate the provided
172 arguments for the commandline options. Please be careful and check docs and
173 /etc/debootstrap/config for further information.
174
175 Usage examples
176 ---------------
177
178   grml-debootstrap --target /dev/sda1 --grub /dev/sda
179
180 Install default Debian release (stable/lenny) on /dev/sda1 and install bootmanager
181 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
182
183   grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid
184
185 Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
186 (master boot record) of /dev/sda and use /dev/sda6 as system partition.
187
188   mount /dev/sda1 /data/chroot
189   grml-debootstrap --target /data/chroot
190
191 Install default Debian release (stable/lenny) in directory /data/chroot (without
192 any bootloader).
193
194   grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian
195
196 Install default Debian release (stable/lenny) on /dev/sda3 and install bootmanager
197 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
198 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
199
200   mount -o loop /mnt/sda6/debian-40r0-i386-CD-1.iso /mnt/iso
201   grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/
202
203 Install Debian stable/lenny on /dev/sda1 using the loopback mounted Debian-ISO
204 for the base-system and install bootmanager Grub in MBR (master boot record) of
205 /dev/sda and use /dev/sda1 as system partition. Please notice, that the chroot
206 system requires network access for all packages which are not part of the
207 ISO.
208
209 Files
210 -----
211
212   /etc/debootstrap/config
213
214 Main configuration file. You have to adjust it according to your needs
215 if you want to execute grml-debootstrap in the non-interactive mode without
216 any special command line arguments.
217
218   /etc/debootstrap/chroot-script
219
220 The script executed within the new Debian system as soon as the main system
221 has been installed via [c]debootstrap.
222
223   /etc/debootstrap/locale.gen
224
225 Defines the default locales used for generating locales via locale-gen.
226
227   /etc/debootstrap/packages
228
229 Defines the software packages which should be installed in the new
230 Debian system by default.
231
232   /etc/debootstrap/extrapackages
233
234 Debian Packages dropped here will be installed into the new Debian system by
235 default (Controlvariable: EXTRAPACKAGES)
236
237   /etc/debootstrap/stages/
238
239 The default directory for storing information about executed stages. Every
240 single function of grml-debootstrap will write 'done' to the stages directory
241 into a file named as the function itself if it has been executed successfully.
242 You can adjust the location of the directory via configuration variable STAGES
243 via /etc/debootstrap/config.  Please notice that you have to remove the stages
244 directory on your own if you want to re-execute grml-debootstrap after running it
245 successfully once. This should avoid recurrent execution by error of
246 grml-debootstrap (which might delete present data).
247
248 Customization
249 -------------
250
251 You can control execution of grml-debootstrap via adjusting
252 /etc/debootstrap/config for some main stuff or via setting some selected
253 variables via commandline.  The packages which should be installed in the new
254 Debian system can be defined via the file /etc/debootstrap/packages.  If you
255 want to put existing files to the new Debian system you can place them into the
256 (by default non-existing) directories boot, etc, share, usr and var in
257 /etc/debootstrap/. Every existing directory will be copied to the new Debian
258 system then. If you want to install additional packages that are not available
259 via the grml or debian mirror drop them into /etc/debootstrap/extrapackages and
260 make sure that EXTRAPACKAGES is set to "yes".
261
262 Automatic installation
263 ----------------------
264
265 If environment variable AUTOINSTALL is set grml-debootstrap can be executed in a
266 full automatic mode. While this mode isn't really useful for interactive
267 execution (just configure /etc/debootstrap/configure or specify the relevant
268 variables on the commandline instead) it is meant for use via bootoption
269 debian2hd. The bootoption debian2hd (more precise: the kernelname on bootprompt)
270 supports the following bootoptions (they correspond with the commandline options
271 mentioned above):
272
273   target=...
274
275 The target partition/directory of the new Debian system. Usage example:
276 target=/dev/sda1
277
278   grub=...
279
280 Where do you want to install grub to? Usage example: grub=/dev/sda
281
282   release=...
283
284 Specify release of new Debian system. Defaults to Debian stable.  Supported
285 relases: lenny, squeeze and sid. Usage example: release=sid
286
287   mirror=...
288
289 Specify mirror which should be used for apt-get/aptitude instead
290 of the default one (ftp://ftp.debian.de/debian).
291 Usage example: mirror=ftp://ftp.tugraz.at/mirror/debian
292
293   password=...
294
295 Set password of user root without prompting for it but set it to the given
296 argument. Usage example: password=AiTh5ahn
297
298 Usage example for automatic installation:
299 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
300
301   debian2hd target=/dev/sda1 grub=/dev/sda mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
302
303 You have to enter this commandline at the bootprompt of grml. Please make sure
304 that /dev/sda1 is the partition where you really want to install your new Debian
305 system.
306
307 [NOTE]
308 Automatic installation within booting process is done in grml-autoconfig via
309 setting environment variable AUTOINSTALL and creation of
310 /usr/bin/grml-debootstrap_noninteractive with the available and relevant
311 bootoptions for grml-debootstrap.
312
313 Supported Releases
314 ------------------
315
316 include::releasetable.txt[]
317
318 [NOTE]
319 .Etch-Release
320 ================================================================================
321 [1] Please notice that Etch is the current old-stable within Debian.
322 grml-debootstrap can handle the release but you really should not use Etch
323 anymore unless you really know what you are doing. Choose Lenny instead.
324 ================================================================================
325
326 [NOTE]
327 .Lenny-Release
328 ================================================================================
329 When installing lenny to a new mdraid, grml-debootstrap will use md metadata
330 format version 0.90. This limits the device to a maximum size of 2TB, but has
331 the advantage of grub-legacy actually being able to boot from it.
332 ================================================================================
333
334 Bugs
335 ----
336
337 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
338
339 See also
340 --------
341
342 debootstrap (8), cdebootstrap (1).
343
344 Author
345 ------
346 Michael Prokop <mika@grml.org>