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