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