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